消息推送 - Jodoo - 開放平臺

功能簡介

訊息推播可以將 Jodoo 中的待辦通知、訊息通知、抄送通知等訊息同步到自己的伺服器，便於企業的業務整合。

推播伺服器配置方法

配置入口

點擊右上角頭像，進入「企業管理 > 訊息推播」，開啟訊息推播的開關：

伺服器配置

點擊「配置」，進入訊息推播的配置頁面，填寫伺服器地址後，可透過「伺服器連接測試」測試連接是否成功，點擊「生成 Secret」，即可自動生成訊息推播的 Secret，設定好後點擊「儲存」：

推播資料結構說明

欄位	類型	說明
op	string	推播事件
data	json	推播內容
send_time	string	推播時間

資料樣例如下：

{
    op: "flow_message", //推播事件
    data: {
        to: [{
            username: "jodoo",
            name: "小云"    
        }],
        entry_name: "請假簽核",
        notify_text: "小云本週五請假一天",
        url: "https://abc.com/xyz"
    }, //推播內容
    send_time: "2017-10-20T22:41:51.430Z" //推播時間
}

推播事件

表單客製化時間通知

1. 配置方式

進入表單「擴展功能 > 推播通知」，點擊「新建推播通知」，填寫好「客製化時間通知」的通知內容，在通知方式處勾選「推播至我的伺服器」：

2. 推播內容

欄位	類型	說明
op	string	“form_schedule_message”，固定值
data	json	推播內容
data.to	json[]	被通知人列表
data.entry_name	string	推播來源表單名稱
data.notify_text	string	通知文字，預設為“已到通知時間，請及時處理”，可在通知設定中客製化
data.url	string	表單內鏈，需表單授權纔可造訪
send_time	string	推播時間

3. 推播資料樣例

{
	op: "form_schedule_message",
	data: {
		to: [
			{
				username: "Jodoo 1",
				name: "Jodoo 1"
			}, {
				username: "Jodoo 2",
				name: "Jodoo 2"
			}
		],
		entry_name: "請假簽核",
		notify_text: "Jodoo 提出請假申請，請簽核",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

表單新資料送出通知

1. 配置方式

進入表單「擴展功能 > 推播通知」，點擊「新建推播通知」，填寫好「新資料送出時通知」的通知內容，在通知方式處勾選「推播至我的伺服器」。

2. 推播內容

欄位	類型	說明
op	string	“data_create_message”，固定值
data	json	推播內容
data.to	json[]	被通知人列表
data.entry_name	string	推播來源表單名稱
data.notify_text	string	通知文字，預設為“有新資料送出，請及時處理”，可在通知設定中客製化
data.content	string	詳細內容，有值的表單欄位標題和欄位值。例如：“單行文字: 123\n多行文字: 1233\n數字: 123\n成員單選: codingmagic1\n部門單選: 研發\n日期時間: 2019-06-13”
data.url	string	靜態訊息連結，屬於被通知人的個人訊息，登入後可造訪
send_time	string	推播時間

3. 推播資料樣例

{
	op: "form_schedule_message",
	data: {
		to: [
			{
				username: "Jodoo 1",
				name: "Jodoo 1"
			}, {
				username: "Jodoo 2",
				name: "Jodoo 2"
			}
		],
		entry_name: "請假簽核",
		notify_text: "Jodoo 提出請假申請，請簽核",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

表單資料修改後通知

1. 配置方式

進入表單「擴展功能 > 推播通知」，點擊「新建推播通知」，填寫好「資料修改後通知」的通知內容，在通知方式處勾選「推播至我的伺服器」。

2. 推播內容

欄位	類型	說明
op	string	“data_update_message”，固定值
data	json	推播內容
data.to	json[]	被通知人列表
data.entry_name	string	推播來源表單名稱
data.notify_text	string	通知文字，預設為“有資料被修改，請及時處理”，可在通知設定中客製化
data.content	string	詳細內容，修改人、資料標題、被修改的欄位。例如：“修改人: test_li\n資料標題: 1231\n單行文字: 123→1231\n成員單選: codingmagic1→codingjun”
data.url	string	資料內鏈，需表單授權纔可造訪
send_time	string	推播時間

3. 推播資料樣例

{
	op: "form_schedule_message",
	data: {
		to: [
			{
				username: "Jodoo 1",
				name: "Jodoo 1"
			}, {
				username: "Jodoo 2",
				name: "Jodoo 2"
			}
		],
		entry_name: "請假簽核",
		notify_text: "Jodoo 提出請假申請，請簽核",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

根據表單內日期時間欄位通知

1. 配置方式

進入表單「擴展功能 > 推播通知」，點擊「新建推播通知」，填寫好「根據表單內日期時間欄位通知」的通知內容，在通知方式處勾選「推播至我的伺服器」：

2. 推播內容

欄位	類型	說明
op	string	“form_widget_message”，固定值
data	json	推播內容
data.to	json[]	被通知人列表
data.entry_name	string	推播來源表單名稱
data.notify_text	string	通知文字，預設為“有資料到期，請及時處理”，可在通知設定中客製化
data.content	string	詳細內容，資料標題
data.url	string	資料內鏈，單表單超出十條後發送表單內鏈，需表單授權纔可造訪
send_time	string	推播時間

3. 推播資料樣例

{
	op: "form_widget_message",
	data: {
		to: [
			{
				username: "Jodoo",
				name: "Jodoo"
			}
		],
		entry_name: "生日通知",
		notify_text: "Jodoo 的生日到了",
		content: "Jodoo 的生日到了",
		url: "https://jodoo.com/dashboard/app/1/form/2/data/3/qr_link"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

表單流程訊息通知

當流程發起、抄送、轉交、退回、超時、激活、調整負責人時，都會給當前流程負責人推播流程通知資訊。

1. 配置方式

進入流程表單的「流程設定」，在「流程屬性 > 流程通知」處勾選「推播至我的伺服器」：

2. 推播內容

欄位	類型	說明
op	string	“flow_message”，固定值
data	json	推播內容
data.flow_action	string	流程操作
data.to	json[]	被通知人列表
data.entry_name	string	推播來源表單名稱
data.notify_text	string	通知文字，預設為“有資料被修改，請及時處理”，可在通知設定中自訂
data.content	string	詳細內容，流程簡報
data.url	string	資料內鏈，需表單授權纔可造訪
send_time	string	推播時間

不同的流程操作（flow_action）對應不同的推播內容，具體如下表所示：

流程操作	含義	通知文字	詳細內容
flow_forward	送出	有新的流程待辦事項	流程簡報，例如：“單行文字: 123\n多行文字: 123\n數字: 123”
flow_auto_forward	系統自動送出	有新的流程待辦事項
flow_back	退回	送出的流程事項被退回
flow_auto_back	系統自動退回	送出的流程事項被退回
flow_cc	抄送	有新的流程處理結果抄送給您
flow_timeout	流程超時	預設為“有待辦未完成，請及時處理”，可在超時通知設定中自訂
flow_member_transfer	成員轉交	由「~$轉交人」轉交給您1條待辦事項
flow_admin_transfer	一條流程資料被管理員調整負責人	由系統管理員轉交給您1條待辦事項
flow_activate	流程被激活	由系統管理員轉交給您1條待辦事項
flow_sign_before	前加簽	由「~$加簽人」加簽給您1條待辦事項
flow_sign_after	後加籤	由「~$加簽人」加簽給您1條待辦事項
flow_sign_parallel	新增簽核人	由「~$加簽人」加簽給您1條待辦事項
flow_sign_before_complete	前加簽處理完成	前加簽處理已完成，您有新的流程待辦事項
flow_batch_transfer	多條流程資料被管理員調整負責人	由系統管理員轉交給您新的待辦事項	/
flow_batch_forward	多條流程送出	有[~$count]條新的流程待辦事項	/
flow_batch_cc	多條流程抄送	有[~$count]條新的流程處理結果抄送給您	/
flow_urge	流程催辦	有一條流程急需處理	/

4.5.3 新舊流程訊息推播時變化

1. 新舊流程訊息推播時to的變化

舊版 to：會集合在同一條推播裏，見下方程式碼中的 to 部分，無論節點多少人，就只推播一次。

{
"data": {
"content": "",
"entry_name": "舊版流程推播測試",
"flow_action": "flow_forward",
"notify_text": "有新的流程待辦事項",
"to": [{
"name": "Jodoo 1",
"username": "Jodoo 1"
}, {
"name": "Jodoo 2",
"username": "Jodoo 2"
}, {
"name": "Jodoo 3",
"username": "Jodoo 3"
}],
"url": "https://www.jodoo.com/dashboard/app/642e37f2374e1b0007f537b2/form/642e37f5fe736900073a99e5/data/642e3855dd27960007cf9514?actionType=flow_forward&flowId=1&memberType=0&guestCorpId="
},
"op": "flow_message",
"send_time": "2023-04-06T03:11:18.102Z"
}

新版 to：會拆分為多條推播，有幾個負責人就推播幾條，如下該節點有三個負責人，則推播三次，to 裏面始終只有一個人。

{
"data": {
"content": "",
"entry_name": "新版流程推播測試",
"flow_action": "flow_forward",
"notify_text": "有新的流程待辦事項",
"to": [{
"name": "Jodoo 1",
"username": "Jodoo 1"
}],
"url": "https://www.jodoo.com/message/redirect?msg=task_inst%3A%3A%3A%3A%3A&instanceId=642e38acd039d000080c637b&taskId=642e38acd039d000080c63a3&actionType=flow_forward&appId=63b62c3d0c76a3000a0bf8a6&dataId=642e38acd039d000080c637b&flowId=3&formId=63b62c3fa76046000a36d412&memberType=0&guestCorpId="
},
"op": "flow_message",
"send_time": "2023-04-06T03:12:44.991Z"
}
{
"data": {
"content": "",
"entry_name": "新版流程推播測試",
"flow_action": "flow_forward",
"notify_text": "有新的流程待辦事項",
"to": [{
"name": "Jodoo 2",
"username": "Jodoo 2"
}],
"url": "https://www.jodoo.com/message/redirect?msg=task_inst%3A%3A%3A%3A%3A&instanceId=642e38acd039d000080c637b&taskId=642e38acd039d000080c63a3&actionType=flow_forward&appId=63b62c3d0c76a3000a0bf8a6&dataId=642e38acd039d000080c637b&flowId=3&formId=63b62c3fa76046000a36d412&memberType=0&guestCorpId="
},
"op": "flow_message",
"send_time": "2023-04-06T03:12:44.991Z"
}
{
"data": {
"content": "",
"entry_name": "新版流程推播測試",
"flow_action": "flow_forward",
"notify_text": "有新的流程待辦事項",
"to": [{
"name": "Jodoo 3",
"username": "Jodoo 3"
}],
"url": "https://www.jodoo.com/message/redirect?msg=task_inst%3A%3A%3A%3A%3A&instanceId=642e38acd039d000080c637b&taskId=642e38acd039d000080c63a3&actionType=flow_forward&appId=63b62c3d0c76a3000a0bf8a6&dataId=642e38acd039d000080c637b&flowId=3&formId=63b62c3fa76046000a36d412&memberType=0&guestCorpId="
},
"op": "flow_message",
"send_time": "2023-04-06T03:12:44.991Z"
}

新舊流程訊息推播時url的變化

舊版地址：https://www.jodoo.com/dashboard/app/6331609e3c17350008d45fdb/form/633160a368ae71000a94676a/data/64054250c68b1e0008b822a7?actionType=flow_forward&flowId=1&memberType=0&guestCorpId=
新版地址：https://www.jodoo.com/message/redirect?msg=task_inst%3A%3A%3A%3A%3A&instanceId=64100d6e2ac023000782ec79&taskId=641b2fdec3ddb00007aa36a8&actionType=flow_forward&flowId=1&memberType=0&guestCorpId=&appId=6331609e3c17350008d45fdb&formId=633160a368ae71000a94676a&dataId=64054250c68b1e0008b822a7

新版地址相較舊版地址差別如下所示：

資料 ID 以 url 參數形式放在 url 中，參數名 instanceId 和 dataId 均等於資料 ID；
應用 ID 和表單 ID 以 url 參數形式放在 url 中，參數名為 appId 和 formId；
新增了 taskId（任務 ID，同一個節點多個負責人每個人的 taskId 不同）。

儀表板定時通知

1. 配置方式

進入儀表板的「儀表板設計 > 擴充功能」，點擊設定「定時通知」，設定好通知內容後，在通知方式處勾選「推播至我的伺服器」。

2. 推播內容

欄位	類型	說明
op	string	“dash_schedule_message”，固定值
data	json	推播內容
data.to	json[]	被通知人列表
data.entry_name	string	推播來源儀表板名稱
data.notify_text	string	通知文字，預設為“已到通知時間，請及時處理”，可在通知設定中客製化
data.url	string	儀表板造訪內鏈，需授權纔可造訪
send_time	string	推播時間

3. 推播資料樣例

{
	op: "dash_schedule_message",
	data: {
		to: [
			{
				username: "Jodoo",
				name: "Jodoo"
			}
		],
		entry_name: "物料盤點",
		notify_text: "2019 年度物料盤點的時間到了",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

儀表板預警通知

1. 配置方式

進入統計表的編輯頁面，在「功能配置 > 資料預警」處新增預警，設定好預警內容後，在通知方式處勾選「推播至我的伺服器」。

2. 推播內容

欄位	類型	說明
op	string	“dash_alert_message”，固定值
data	json	推播內容
data.to	json[]	被通知人列表
data.entry_name	string	推播來源儀表板名稱
data.notify_text	string	使用預警名稱作為通知文字
data.content	string	詳細內容，預警來源：{應用名稱}>{儀表板名稱}>{元件名稱}
data.url	string	儀表板內鏈，需儀表板授權纔可造訪
send_time	string	推播時間

3. 推播資料樣例

{
	op: "dash_alert_message",
	data: {
		to: [
			{
				username: "Jodoo",
				name: "Jodoo"
			}
		],
		entry_name: "庫存統計",
		notify_text: "庫存警告",
		content: "預警來源：庫存應用>華南區盤點>庫存剩餘量",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}