您可以通過指定HTTP URL來接收Chat App 消息服務的消息回執狀態報告。
協議說明
參數 | 說明 |
協議 | HTTP + JSON |
編碼 | UTF-8 |
請求說明
單次推送可能會包含多條消息狀態報告結果。
MsgFrameType是template的請求樣例
[
{
"Status":"Failed",
"ErrorDescription":"131026:Receiver is incapable of receiving this message(Message Undeliverable.)",
"MsgFrameType":"template",
"TaskId":"202307030171*******9",
"From":"86131*******8",
"Timestamp":1691043638000,
"OriginPhoneNumber":"86130*******8",
"TemplateCode":"820561547132813184",
"Type":"TEMPLATE",
"Language":"id",
"TemplateName":"wa_otp_v_0_0_3",
"To":"86138*******8",
"ErrorCode":"131026",
"MessageId":"2023078469463703*******3"
},
{
"Status":"Failed",
"ErrorDescription":"131026:Receiver is incapable of receiving this message(Message Undeliverable.)",
"MsgFrameType":"template",
"TaskId":"202307030171*******9",
"From":"86131*******8",
"Timestamp":1691043638000,
"OriginPhoneNumber":"86130*******8",
"TemplateCode":"820561547132813184",
"Type":"TEMPLATE",
"Language":"id",
"TemplateName":"wa_otp_v_0_0_3",
"To":"86137*******8",
"ErrorCode":"131026",
"MessageId":"2023078469463703*******3"
}
]
MsgFrameType是message的請求樣例
[
{
"Status":"Read",
"MsgFrameType":"message",
"Type":"INTERACTIVE",
"TaskId":"2023068473353098*******8",
"From":"86131*******8",
"To":"86138*******8",
"Timestamp":1691132091000,
"OriginPhoneNumber":"86131*******8",
"MessageId":"2023038470553398*******8",
"ConversationId":"72222201111****",
"ConversationType": "service"
},
{
"Status":"Read",
"MsgFrameType":"message",
"Type":"INTERACTIVE",
"TaskId":"2023068473353098*******8",
"From":"86131*******8",
"To":"86138*******1",
"Timestamp":1691132091000,
"OriginPhoneNumber":"86131*******8",
"MessageId":"2023038470553398*******8",
"ConversationId":"72222201111****",
"ConversationType": "service"
}
]
字段說明
名稱 | 類型 | 是否必填 | 描述 |
MessageId | String | 是 | 消息的ID。 |
From | String | 是 | 消息發送方號碼。 |
To | String | 是 | 消息接收方號碼。 |
Timestamp | Long | 是 | 時間戳為Unix timestamp 毫秒。 |
Status | String | 是 | 消息發送狀態。取值:
|
StatusDescription | String | 是 | 狀態碼的描述。 |
ErrorCode | String | 否 | 錯誤碼。 |
ErrorDescription | String | 否 | 錯誤碼描述。詳情請參見API錯誤碼。 |
ConversationType | String | 否 | 會話類型。取值:
|
ConversationId | String | 否 | 會話ID。 |
MsgFrameType | String | 是 | 消息類型。取值:
|
Type | String | 否 | 消息內容中多媒體資源類型。取值:
|
TaskId | String | 否 | 客戶任務ID。默認取值MessageId。 說明 如果TaskId未傳值,則TaskId=MessageId。 |
OriginPhoneNumber | String | 否 | 消息發送方的真實號碼。 |
TemplateCode | String | 否 | 消息模板編碼。 說明 當MsgFrameType=template時有值。 |
響應說明
接收到回執后,響應的HTTP狀態碼必須為200,且響應體格式需如下所示,否則會推送失敗,觸發重新推送。
響應樣例
{
"code" : 0,
"msg" : "成功"
}
字段說明
名稱 | 類型 | 是否必選 | 描述 |
code | Number | 是 | 應答編碼。 |
msg | String | 否 | 描述信息。 |
重新推送
第一次推送失敗后,間隔1分鐘、5分鐘后會進行重推,直至推送成功為止。如果推送3次后仍失敗,不再重試。