消息回调 API
最新更新:2023-02-27
概述
將「訊息狀態」的數據回調給企業的業務係統,可根據該信息進行統計分析等動作。
回調地址
企業需要設定接收「訊息狀態變更」的回調地址,目前無 web 界面,請聯係 engagelab 技術人員設定。
應答機製
開發者服務接收到 Engagelab 的回調後,需要在 3 秒內按下述要求進行應答:
- 接收成功:HTTP 應答狀態碼需返回 200 或 204,無需返回應答報文。
- 接收失敗:HTTP 應答狀態碼需返回 5XX 或 4XX,同時需返回應答報文,格式如下:
{
"code": 2002,
"message": "失敗"
}
{
"code": 2002,
"message": "失敗"
}
此代碼塊在浮窗中顯示
字段 | 類型 | 必選/可選 | 描述 |
---|---|---|---|
code | int | 可選 | 錯誤碼 |
message | string | 可選 | 錯誤詳細信息 |
回調內容
回調方式:POST Content-Type:application/json Authorization:none 註:目前支援 Basic 鑒權(也可不鑒權,依賴配置),開發者也可以選擇不進行校驗,後續會豐富鑒權方式。
訊息狀態變更
回調示例
請求報頭
POST /developer_define_url HTTP/1.1
Content-Type: application/json
POST /developer_define_url HTTP/1.1
Content-Type: application/json
此代碼塊在浮窗中顯示
請求體
{
"total": 1,
"rows": [{
"message_id": "1666165485030094861", // Engagelab 側的訊息 id
"from":"", // 傳送方
"to":"", // 接收方,registrationID
"server": "AppPush",
"channel": "FCM",
"custom_args": {}, // 這條訊息創建時提交的參數,將於此回調時原樣返回
"itime":1640707579, // 訊息狀態變更時的時間戳,如訊息已送達的時間
"status": {
// 成功時回響這些字段
"message_status": "delivered", // 訊息狀態
"status_data": { // 自訂
"channel_message_id":"wamid.123321abcdefed==" // 可選,第三方通道的 msgid
},
// 失敗時回響這些字段
"error_code":0, //錯誤碼--對應生命周期錯誤碼
"error_detail":{
"message":""//錯誤原因
},
"loss":{"loss_source":"vivo", "loss_step":1} //摺損階段和摺損來源
}
}]
}
{
"total": 1,
"rows": [{
"message_id": "1666165485030094861", // Engagelab 側的訊息 id
"from":"", // 傳送方
"to":"", // 接收方,registrationID
"server": "AppPush",
"channel": "FCM",
"custom_args": {}, // 這條訊息創建時提交的參數,將於此回調時原樣返回
"itime":1640707579, // 訊息狀態變更時的時間戳,如訊息已送達的時間
"status": {
// 成功時回響這些字段
"message_status": "delivered", // 訊息狀態
"status_data": { // 自訂
"channel_message_id":"wamid.123321abcdefed==" // 可選,第三方通道的 msgid
},
// 失敗時回響這些字段
"error_code":0, //錯誤碼--對應生命周期錯誤碼
"error_detail":{
"message":""//錯誤原因
},
"loss":{"loss_source":"vivo", "loss_step":1} //摺損階段和摺損來源
}
}]
}
此代碼塊在浮窗中顯示
參數說明
訊息狀態取值:
取值 | 含義 |
---|---|
target_valid | 有效目標 |
sent | 傳送成功 |
delivered | 送達成功 |
click | 用戶點選 |
no_click | 未點選 |
target_invalid | 無效目標 |
sent_failed | 傳送失敗 |
delivered_failed | 送達失敗 |
註意:部分通道的點選和送達可能存在重複現象,開發者可自行進行去重處理。
摺損階段
1:計畫目標-》有效目標
2:有效目標-》傳送數量
3:傳送數量-》送達數量
4:送達數量-》點選數量