Webhook參數 - - 阿里雲

Webhook用來向客戶回調接收到的訊息及發送訊息的狀態資訊，提供HTTP POST方式。

Message Status

發送訊息通知。用於接收WhatsApp發送的訊息狀態的反饋。狀態包括（WhatsApp提供的）：deleted, failed, sent, delivered, read。

使用限制：

每個訊息狀態變化時向設定的回調地址發送。
客戶返回“200 OK”視為正常接收，其他情況進行重試。

入參

名稱	類型	是否必填	樣本值	描述
MessageId	String	是	123456789	阿里雲ChatAPP平台產生的訊息ID，唯一標識一條訊息。
To	String	是	123456789	Recipient ID。
From	String	是	123456789	Sender的ID。
Status	String	是	sent	狀態代碼。
StatusDescription	String	是	訊息已成功發送到channel provider	狀態代碼的描述，參見狀態代碼表。
Timestamp	String	是	1591861777000	狀態產生的時間，GMT時間。
Error	String	否	OUT_OF_SERVICE	出現錯誤時返回，參見錯誤碼定義。
ErrorDescription	String	否	系統停止服務	參見錯誤碼定義。
MsgFrameType	String	否	message	message：自由格式訊息。 template：模板訊息。
Type	String	否	image	訊息中的多媒體資源類型： image：圖片。 video：視頻。 doc：文檔。 audio：音頻。 none：純文字訊息。

樣本

[{
  "MessageId": "123456789", // 訊息的Id，標識訊息
  "To": "123456789", // 訊息接收者的ID
  "From": "123456789", // 訊息寄件者的ID
  "Status": "sent", // 狀態代碼 sent delivered read failed deleted
  "StatusDescription": "訊息已成功發送到channel provider", // 狀態代碼描述
  "Timestamp": "1591861777000", // 發送的時間，GMT時間
  "Error": "OUT_OF_SERVICE", // 錯誤資訊
  "ErrorDescription": "系統停止服務", // 錯誤詳細描述
  "MsgFrameType": "template",
  "Type": "none"
}]

狀態代碼

名稱	描述
sent	訊息已成功發送到channel provider。
delivered	訊息已投遞到使用者裝置，如WhatsApp使用者已接收該條訊息，WhatsApp會最佳化訊息投遞，有時直接發送read而不發送delivered，因為若訊息狀態是 read，則該訊息定已被 delivered。
read	訊息已被使用者閱讀。
failed	訊息發送失敗。
deleted	訊息已被使用者刪除。

介面出參

名稱	類型	是否必選	描述
code	Number	是	應答編碼，必須為0。
msg	String	否	描述資訊。

樣本：

{
  "code" : 0,
  "msg" : "接收成功"
}

Inbound Message

接收訊息。用於接收使用者通過WhatsApp平台發送的訊息。

使用限制：

支援的訊息包括：text、location、image、audio、video，其他類型訊息暫不支援，如system、document、contacts。
不支援群組訊息類型。
客戶返回“200 OK”視為正常接收，其他情況進行重試。

入參

名稱	類型	是否必選	樣本值	描述
MessageId	String	是	123456789	阿里雲ChatAPP平台產生的訊息ID，唯一標識一條訊息。
ChannelType	String	是	whatsapp	通道類型：whatsapp。
From	String	是	86152345434311	Sender的ID。
To	String	是	123456789	Recipient ID。
Timestamp	String	是	1591861777000	時間戳記，GMT時間。
Type	String	是	text	訊息類型：text、location、image、audio、video。
Message	String	否	我收到一條訊息	text類型的訊息內容。

樣本

[{
    "MessageId": "123456789",// 訊息的Id，標識上行的訊息
    "ChannelType": "whatsapp",// 通道類型，whatsapp/messager/viber/line
    "To": "123456789", // 訊息接收者的ID
    "From": "86152345434311",// 訊息寄件者的ID
    "Timestamp": "1591861777000",// 發送的時間，GMT時間
    "Type": "text", // 訊息類型：text/location/image/audio/video
    "Message": "我收到一條訊息",
}]