配置禅道
手冊分類
- 1. 禅道介紹
- 1.1 关于禅道項目管理软件
- 1.2 如何獲得支持
- 1.3 各版本功能差異
- 1.4 關注我們
- 2. 安裝禅道
- 2.1. 環境搭建
- 2.1.1 搭建Ubuntu環境安裝禅道
- 2.1.2 搭建Centos環境安裝禅道
- 2.1.3 安裝PHP的ioncube擴展
- 2.2. 安裝禅道
- 2.2.1 選擇適合您的安裝方法
- 2.2.2 新版本禅道的安裝升級
- 2.2.3 Windows一鍵安裝包（新版）
- 2.2.4 Windows一鍵安裝包（舊版）
- 2.2.5 linux用一鍵安裝包(推薦)
- 2.2.6 使用源碼包安裝(各系統通用)
- 2.2.7 使用源碼包安裝(MAC系統)
- 2.2.8 基于禅道當前的一鍵安裝包（Windows和Linux）如何源碼安裝旗艦版禅道
- 2.2.9 渠成命令行安裝禅道
- 2.2.10 Docker和Kubernetes方式部署禅道
- 2.3 安裝PHP的LDAP擴展
- 2.4 在线安装雲禅道
- 2.5 安装 APCu扩展
- 2.6 安裝DuckDB引擎
- 2.7. 信創支持
- 2.7.1 OceanBase數據庫
- 2.8. 安装文檔协同服務
- 2.8.1 安装Windows协同服務
- 2.8.2 安装Linux协同服務
- 2.1. 環境搭建
- 3. 升級禅道
- 3.1. 升級禅道新版本
- 3.1.1 選擇和自己環境對應的升級方式
- 3.1.2 通過源代碼方式升級(通用)
- 3.1.3 windows一鍵安裝包的升級
- 3.1.4 linux一鍵安裝包升級
- 3.1.5 docker安裝禅道-升級禅道
- 3.1.6 舊版Docker鏡像升級說明
- 3.1.7 通過Roadrunner管理定時任務
- 3.2 如何安裝ioncube擴展
- 3.1. 升級禅道新版本
- 4. 維護配置
- 4.1. 維護禅道
- 4.1.1 初始化管理腳本
- 4.1.2 備份禅道
- 4.1.3 恢複刪除的資源
- 4.1.4 如何更新燃盡圖
- 4.1.5 一鍵安裝包如何實現mysql異機連接
- 4.1.6 linux一鍵安裝包配置https
- 4.1.7 禅道一鍵安裝包遷移/更新禅道一鍵安裝包
- 4.2. 配置禅道
- 4.2.1 設置是否允許匿名訪問
- 4.2.2 如何配置email發信
- 4.2.3 如何成爲超級管理員
- 4.2.4 配置禅道系統爲靜態訪問
- 4.2.5 去掉禅道訪問地址中的zentao
- 4.2.6 linux一键安装包去掉禅道訪問地址中的zentao
- 4.2.7 集成禅道和svn
- 4.2.8 集成禅道和git
- 4.2.9 在第三方應用中集成禅道
- 4.2.10 第三方應用配置免密登錄禅道
- 4.2.11 第三方應用集成禅道客戶端進行消息通知
- 4.2.12 集成webhook
- 4.2.13 集成ZDOO
- 4.2.14 客戶端集成
- 4.2.15 浏覽器通知的設置
- 4.2.16 集成釘釘工作消息通知
- 4.2.17 集成企業微信應用消息通知
- 4.2.18 集成企業微信群機器人
- 4.2.19 集成飛書群機器人
- 4.2.20 集成飛書消息通知
- 4.2.21 解決一鍵安裝包密碼口令弱的問題
- 4.3. 性能優化
- 4.3.1 nginx反向代理禅道502或504bad gateway错误
- 4.3.2 linux系統中配置session使用redis
- 4.3.3 緩存功能
- 4.1. 維護禅道
- 5. 快速入門
- 5.1. 新版本快速入門
- 5.1.1 20版本禅道的新增功能
- 5.1.2 新版本禅道的最簡使用
- 5.1.3 20版本禅道的界面變化
- 5.1. 新版本快速入門
- 6. 按照角色使用
- 6.1. 管理員
- 6.2. 項目集負責人
- 6.3. 産品经理
- 6.3.1 維護模塊
- 6.3.2 産品多分支/平台管理
- 6.3.3 維護計劃
- 6.3.4 維護需求
- 7.4.5 需求的狀態和研發階段
- 6.3.6 創建發布
- 6.3.7 跟蹤進度
- 6.3.8 反饋管理（企业版）
- 6.4. 項目經理
- 6.5. 研發人員
- 6.5.1 参加産品计划會議，分解任务
- 6.5.2 領取任務，並每天更新任務
- 6.5.3 創建構建，提交測試
- 6.5.4 確認Bug，解決Bug
- 6.5.5 執行的綜合、需求、Bug、任務看板
- 6.6. 測試人員
- 7. 功能介紹
- 7.1. 核心管理結構
- 7.1.1 項目集（Program）
- 7.1.2 項目（Project）
- 7.1.3 産品（Product）
- 7.1.4 執行（Execution）
- 7.1.5 管理模型
- 7.2. 地盤
- 7.3. 項目集
- 7.4. 産品
- 7.4.1 创建産品
- 7.4.2 維護模塊
- 7.4.3 産品多分支/平台管理
- 7.4.4 維護計劃
- 7.4.5 維護需求
- 7.4.6 需求的評審
- 7.4.7 需求的狀態和研發階段
- 7.4.8 創建發布
- 7.4.9 跟蹤進度
- 7.4.10 業務需求&需求多層級
- 7.5. 項目
- 7.6. 執行
- 7.6.1 参加産品计划會議，分解任务
- 7.6.2 領取任務，並每天更新任務
- 7.6.3 創建構建，提交測試
- 7.6.4 確認Bug，解決Bug
- 7.6.5 執行的綜合、需求、Bug、任務看板
- 7.7. 測試
- 7.8. 自動化測試
- 7.9 DevOps（解決方案）
- 7.10. 文檔
- 7.11. AI
- 7.11.1 AI小程序簡介
- 7.11.2 創建與設計AI小程序
- 7.11.3 發布與禁用小程序
- 7.11.4 調試AI小程序
- 7.11.5 前台小程序的應用
- 7.11.6 AI小程序的導入導出
- 7.11.7 管理AI小程序權限
- 7.12. BI
- 7.12.1 維度（企業版8.4+）
- 7.12.2 大屏（企業版8.4+）
- 7.12.3 透視表
- 7.12.4 透視表下钻
- 7.12.5. 大屏設計器
- 7.12.5.1 大屏設計器界面布局
- 7.12.5.2 大屏設計器引用圖表
- 7.12.5.3 大屏设计器引用透視表
- 7.12.6 圖表
- 7.12.7. 度量項
- 7.12.7.1 查看度量項
- 7.12.7.2 創建度量項
- 7.12.7.3 度量項編碼開發操作手冊
- 7.12.8 數據表（企業版8.4+）
- 7.13. 反饋
- 7.14. 看板
- 7.14.1 通用看板功能
- 7.15. 工作流
- 7.16. 學堂
- 7.17. 資産庫（旗艦版）
- 7.17.1 資産庫管理（旗舰版）
- 7.18. 組織
- 7.18.1 團隊成員和工作信息
- 7.18.2 人力資源日曆（需安裝插件）
- 7.18.3 组织動態
- 7.18.4 公司信息
- 7.19. 辦公
- 7.20. 後台設置
- 7.20.1 後台首頁
- 7.20.2. 系統設置
- 7.20.3 功能開關
- 7.20.4. 人員管理
- 7.20.5. 模型配置
- 7.20.6. 功能配置
- 7.20.7 文檔模板
- 7.20.8. 通知設置
- 7.20.9 插件管理
- 7.20.10 二次開發
- 7.20.11 Jira數據導入
- 7.20.12 Jira數據導入--数据迁移說明
- 7.20.13 Confluence數據導入
- 7.20.14. 權限維護和控制
- 7.20.14.1 項目集的權限維護和訪問控制
- 7.20.14.2 産品的权限维护和访问控制
- 7.20.14.3 項目的權限維護和訪問控制
- 7.20.14.4 執行的权限维护和访问控制
- 7.20.14.5 项目和執行的访问控制和数据关系
- 7.20.15. AI配置
- 7.20.16. DevOps設置
- 7.20.16.1. 資源
- 7.21. 客户端增强版會議SRS
- 7.21.1. 音視頻會議配置
- 7.21.1.1 安装音視頻服務端
- 7.21.1.2 安装SRS音視頻服務端
- 7.21.1.3 开启和配置音視頻功能
- 7.21.2. 发起會議
- 7.21.2.1 一对一会话中发起音視頻會議
- 7.21.2.2 群组会话中发起音視頻會議
- 7.21.2.3 独立发起音視頻會議入口
- 7.21.3. 加入會議
- 7.21.3.1 分享音視頻會議到会话
- 7.21.3.2 通过會議的ID加入會議
- 7.21.4. 预约會議
- 7.21.4.1 预约會議
- 7.21.5. 會議应用
- 7.21.5.1 音視頻會議应用
- 7.21.1. 音視頻會議配置
- 7.22. 客户端增强版會議Jitsi
- 7.1. 核心管理結構
- 8. AI插件
- 8.1 AI插件安裝
- 8.2 ZAI服務安装
- 8.3 AI插件功能使用
- 8.4 ZAI服務控制面板使用
- 9. 其他相關
- 9.1. 其他
- 9.1.1 禅道所使用到的第三方代碼
- 9.1.2 禅道FAQ
- 9.1.3 如何幫助禅道项目
- 9.1.4 禅道商业服務
- 9.1.5 禅道項目的貢獻者
- 9.1.6 曆史修改記錄
- 9.1.7 禅道對象名稱的重名規則
- 9.1. 其他
- 10. IPD版本功能介紹
- 10.1. 禅道IPD版介紹
- 10.1.1 關于禅道IPD版
- 10.1.2 禅道IPD版的核心流程
- 10.2. IPD版的安裝和升級
- 10.2.1 選擇適合您的安裝方法
- 10.2.2 選擇適合您的升級方法
- 10.3. 需求与市場管理界面
- 10.4. IPD研發管理界面
- 10.1. 禅道IPD版介紹
第三方應用集成禅道客戶端進行消息通知 分享鏈接 /book/zentaopms/301.html?releaseID=21
作者：先知
最后编辑：刘振华 于 2025-05-09 13:10:32
浏覽量：55414
本篇目錄
禅道開源版11.0版本集成了禅道客戶端功能。
禅道裏的消息通知可以發送到禅道客戶端，同時增加了消息通知接口。
與禅道集成的第三方應用，也可以通過該消息通知接口，將第三方應用的消息發送到禅道客戶端裏。
本文將詳細介紹第三方應用如何集成禅道客戶端進行消息通知。
一、設置應用集成
第三方應用要與禅道做集成，具體請參考：http://www.zentao.net/book/zentaopmshelp/integration-287.html
二、簽名機制
第三方应用在请求喧喧数据时所调用的 API 的请求地址格式为:
/api.php?m=$moduleName&f=$methodName$params&code=$code&token=$token
以上請求地址格式中的變量定義如下：
-
$moduleName ：要调用的 API 所属模块名称（通常为 “im”），必須提供；
-
$methodName ：要调用的 API 所属模块内的方法名称，如果缺省则为 index ；
-
$params ：要调用的 API 方法参数，如果没有参数可以留空，如果所调用的 API 方法有参数则将参数名和参数值通过通用网址查询字符串的形式插入到 $params 所在位置，例如 gid=XXX ；
-
$code ：應用代號，必須提供；
-
$token ：调用 API 时的数字签名。
例如获取讨论组 gid 为 64da14c3-c07a-45af-9c61-4e638de4af26 中的用戶数据请求地址为：
/api.php?m=im&f=getChatUsers&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8
簽名算法
API 请求地址中的数字签名 $token 应该在每次调用时根据应用集成密匙生成，具体算法为：
$token = md5(md5($query) + $key)
以上公式包含的變量定義如下：
-
$query ：請求地址中查詢字符串（? 之後的部分）不包含 &token=$token 的部分；
-
$key ：應用密匙（必須爲小寫形式）。
例如：
// 查询参数
var $query = 'm=chat&f=getChatUsers&code=myAppCode';
// 应用密匙
var $key = '3cd0914d656e90ab181f1d52ff352cfe';
// 计算签名字符串
var $token = md5(md5('m=im&f=getChatUsers&code=myAppCode') + '3cd0914d656e90ab181f1d52ff352cfe');
// 这样 $token 的计算值为 'f5633c34c0c551a16c1d63bceb38d6a8'
下面將詳細說明第三方應用在完成和禅道的集成後如何通過禅道客戶端進行消息通知。
三、通過禅道客戶端進行消息通知
下面列出目前第三方应用可以使用的 API。
1. im/getGroupChats
此接口用于獲取系統中的討論組會話列表。
- 請求方式：GET；
- 模塊名稱：im；
- 方法名稱：getGroupChats；
- 參數：無；
- 返回值：JSON 對象，该對象属性定义如下：
| 屬性名稱 | 類型 | 說明 |
|---|---|---|
| result | 字符串 | 如果爲'success'則操作成功，如果爲其他值則表示操作失敗 |
| message | 字符串 | 如果操作失敗，則使用此屬性返回失敗原因提示文本 |
| data | 對象 | 该對象定义了系统中的讨论组清单，對象属性名为讨论组的全局唯一 标识字符串（GID），属性对应的值为讨论组名称 |
下面爲一個示例請求地址：
https://myxxb.com/api.php?m=im&f=getGroupChats&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8
正常情況下返回值如下：
{
"result": "success",
"data": {
"30683aea-7a1f-4ec8-a6d6-834e0310fd7d": "第四期项目讨论",
"81c6ba89-00ab-4431-8e47-063556ae4886": "研发部",
"64da14c3-c07a-45af-9c61-4e638de4af26": "公司总群"
}
}
2. im/getChatUsers
此接口用于獲取指定討論組中的成員信息或者獲取系統中全部成員信息。
-
請求方式：GET；
-
模塊名稱：im；
-
方法名稱：getChatUsers；
-
參數：
- gid：設置为要获取用戶成员信息的讨论组的全局唯一 标识字符串（GID），如果留空，则请求会返回系统所有成员信息。
-
返回值：JSON 對象，该對象属性定义如下：
| 屬性名稱 | 類型 | 說明 |
|---|---|---|
| result | 字符串 | 如果爲'success'則操作成功，如果爲其他值則表示操作失敗 |
| message | 字符串 | 如果操作失敗，則使用此屬性返回失敗原因提示文本 |
| data | 對象 | 该對象定义了成员清单，對象属性名为成员 ID，属性对应的值为成员显示名称 |
下面为获取 GID 为'30683aea-7a1f-4ec8-a6d6-834e0310fd7d'的讨论组成员信息的示例请求地址：
https://myxxb.com/api.php?m=im&f=getChatUsers&gid=30683aea-7a1f-4ec8-a6d6-834e0310fd7d&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8
正常情況下返回值如下：
{
"result": "success",
"data": {
"1": "管理员",
"3": "张三",
"4": "李四"
}
}
3. im/sendNotification
此接口用于向通知中心（小喧喧）推送通知消息。
- 請求方式：POST；
- 模塊名稱：im；
- 方法名稱：sendNotification；
- 參數：無；
- 返回值：JSON 對象，该對象属性定义如下：
| 屬性名稱 | 類型 | 說明 |
|---|---|---|
| result | 字符串 | 如果爲'success'則操作成功，如果爲其他值則表示操作失敗 |
| message | 字符串 | 如果操作失敗，則使用此屬性返回失敗原因提示文本 |
将要推送的通知消息對象转换为 JSON 字符串形式，然后通过 POST 请求发送到服務器。
一个通知消息對象拥有如下属性：
| 屬性名稱 | 類型 | 可選性 | 說明 |
|---|---|---|---|
| users | 數組 | 特定條件必須 | 使用一个用戶 ID 數組指定通知发送给哪些用戶，例如[1, 4]，也可以指定一个用戶账号组成的數組，例如['admin', 'zhangsan', 'lisi'] |
| title | 字符串 | 必須 | 通知消息的標題 |
| subtitle | 字符串 | 可選 | 通知消息的副標題 |
| content | 字符串 | 可選 | 通知消息的內容文本 |
| contentType | 字符串 | 必須 | 可選值包括：'plain'表示纯文本，'text'表示 Markdown 格式的文本 |
| url | 字符串 | 可選 | 該通知消息所指向的網頁鏈接 |
| actions | 對象數組 | 可選 | 使用 操作對象數組表示该通知支持的操作 |
| sender | 對象 | 可選 | 通知的 发送方信息對象 |
通知的 操作對象包含如下屬性：
| 屬性名稱 | 類型 | 可選性 | 說明 |
|---|---|---|---|
| label | 字符串 | 必須 | 操作按鈕上顯示的文本 |
| icon | 字符串 | 可選 | 操作按鈕上顯示的圖標 |
| url | 字符串 | 必須 | 點擊此操作按鈕時要打開的頁面鏈接 |
| type | 字符串 | 可選 | 操作按钮類型，影响操作按钮外观，可選值包括'primary'、'success'、'danger'、'warning'、'info'、'important'、'special' |
发送方信息對象包容如下屬性：
| 屬性名稱 | 類型 | 可選性 | 說明 |
|---|---|---|---|
| id | 字符串或數字 | 必須 | 标识发送方唯一身份的字符串或數字 |
| name | 字符串 | 可選 | 發送方在界面上顯示的名稱 |
| avatar | 字符串 | 必須 | 發送方頭像圖片鏈接地址 |
下面为一个发送通知消息的示例 POST 请求地址：
https://myxxb.com/api.php?m=im&f=sendNotification&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8
下面为使用 JavaScript Fetch API 發起請求示例代碼：
const Data = {
users: [1, 3],
title: '測試通知消息',
subtitle: '測試通知消息副标题',
content: '**測試消息**内容',
contentType: 'text',
url: 'http://xuan.im',
actions: [
{
type: 'danger',
label: '更新日志',
url: 'https://xuan.im/page/changelogs.html'
}, {
type: 'normal',
label: '下載地址',
url: 'http://xuan.im/page/download.html'
}
],
sender: {
avatar: 'https://avatars2.githubusercontent.com/u/472425?s=460&v=4',
name: 'Catouse',
id: 'catouse'
}
};
const postUrl = 'https://myxxb.com/api.php?m=im&f=sendNotification&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8';
fetch(postUrl, {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify(data)
}).then(r => {
return r.json();
}).then(response => {
if (response && response.result === 'success') {
console.log('操作成功');
}
});
正常情況下返回值如下：
{ "result": "success" }
4. im/sendChatMessage
此接口用于向指定的討論組推送通知消息。
- 請求方式：POST；
- 模塊名稱：im；
- 方法名稱：sendChatMessage；
- 參數：無；
- 返回值：JSON 對象，该對象属性定义如下：
| 屬性名稱 | 類型 | 說明 |
|---|---|---|
| result | 字符串 | 如果爲'success'則操作成功，如果爲其他值則表示操作失敗 |
| message | 字符串 | 如果操作失敗，則使用此屬性返回失敗原因提示文本 |
将要推送的通知消息對象转换为 JSON 字符串形式，然后通过 POST 请求发送到服務器。
一个通知消息對象拥有如下属性：
| 屬性名稱 | 類型 | 可選性 | 說明 |
|---|---|---|---|
| gid | 字符串 | 特定條件必須 | 为讨论组的全局唯一字符串，指定通知发送到的讨论组，当向讨论组发送通知时必須（即receiver为'group'） |
| title | 字符串 | 必須 | 通知消息的標題 |
| subtitle | 字符串 | 可選 | 通知消息的副標題 |
| content | 字符串 | 可選 | 通知消息的內容文本 |
| contentType | 字符串 | 必須 | 可選值包括：'plain'表示纯文本，'text'表示 Markdown 格式的文本 |
| url | 字符串 | 可選 | 該通知消息所指向的網頁鏈接 |
| actions | 對象數組 | 可選 | 使用 操作對象數組表示该通知支持的操作 |
| sender | 對象 | 可選 | 通知的 发送方信息對象 |
通知的 操作對象包含如下屬性：
| 屬性名稱 | 類型 | 可選性 | 說明 |
|---|---|---|---|
| label | 字符串 | 必須 | 操作按鈕上顯示的文本 |
| icon | 字符串 | 可選 | 操作按鈕上顯示的圖標 |
| url | 字符串 | 必須 | 點擊此操作按鈕時要打開的頁面鏈接 |
| type | 字符串 | 可選 | 操作按钮類型，影响操作按钮外观，可選值包括'primary'、'success'、'danger'、'warning'、'info'、'important'、'special' |
发送方信息對象包容如下屬性：
| 屬性名稱 | 類型 | 可選性 | 說明 |
|---|---|---|---|
| id | 字符串或數字 | 必須 | 标识发送方唯一身份的字符串或數字 |
| name | 字符串 | 可選 | 發送方在界面上顯示的名稱 |
| avatar | 字符串 | 必須 | 發送方頭像圖片鏈接地址 |
下面为一个发送通知消息的示例 POST 请求地址：
https://myxxb.com/api.php?m=im&f=sendChatMessage&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8
下面为使用 JavaScript Fetch API 發起請求示例代碼：
const Data = {
gid: 'f3de9ff9-dcb4-49de-915b-377ee9143418',
title: '測試通知消息',
subtitle: '測試通知消息副标题',
content: '**測試消息**内容',
contentType: 'text',
url: 'http://xuan.im',
actions: [
{
type: 'danger',
label: '更新日志',
url: 'https://xuan.im/page/changelogs.html'
}, {
type: 'normal',
label: '下載地址',
url: 'http://xuan.im/page/download.html'
}
],
sender: {
avatar: 'https://avatars2.githubusercontent.com/u/472425?s=460&v=4',
name: 'Catouse',
id: 'catouse'
}
};
const postUrl = 'https://myxxb.com/api.php?m=im&f=sendChatMessage&code=myAppCode&token=f5633c34c0c551a16c1d63bceb38d6a8';
fetch(postUrl, {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify(data)
}).then(r => {
return r.json();
}).then(response => {
if (response && response.result === 'success') {
console.log('操作成功');
}
});
正常情況下返回值如下：
{ "result": "success" }
-
-
禅道産品
禅道開源版 禅道企業版 禅道旗艦版 禅道IPD版 -
核心功能
産品管理 項目管理 質量管理 效能管理 -
使用文檔
基本版手冊 企業版手冊 旗艦版手冊 IPD版手冊 開發中心手冊 -
幫助中心
积分問答 常見問題 論壇交流 使用視頻 Gitee GitHub -
關于我們
關于我們 禅道軟件 最新動態 禅道活動 -
禅道社區
禅道博客 積分排行 積分商城 禅道書院 -
聯系方式
聯系人：劉璐 電話：18562550650 微信：18562550650 Q Q：2845263372北京、上海、深圳分部
友情鏈接：
ZTF自动化測試框架
ZenData測試数据生成器
喧喧IM
敏捷開發
敏捷咨詢
測試窝
悅庫網盤
Ledge知識平台
渠成軟件
ZDOO全協同企業管理軟件
融管理社區
ZenDAS數據分析工具
ZenShot跨平台截圖工具
飛信釘即時通訊解決方案
項目管理
IPD學習網
PMP百科網
艾體驗
創無記2049
聯系我們
劉璐
高級客戶經理
電話(微信)
18562550650
QQ號碼
2845263372
聯系郵箱
liulu@chandao.com
名額有限
完善信息领取項目管理礼包
280+項目管理实践
100+項目管理視頻
50+項目管理知识模版
去完善
聯系我們
李木
高級客戶經理
電話(微信)
18562583552
QQ號碼
3985895121
聯系郵箱
limu@chandao.com
