Webhook用来向客户回调接收到的消息及发送消息的状态信息，提供HTTP POST方式。

Message Status

发送消息通知。用于接收WhatsApp发送的消息状态的反馈。状态包括（WhatsApp提供的）：deleted, failed, sent, delivered, read。

使用限制：

  1. 每个消息状态变化时向设定的回调地址发送。

  2. 客户返回“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平台发送的消息。

使用限制：

  1. 支持的消息包括：text、location、image、audio、video，其他类型消息暂不支持，如system、document、contacts。

  2. 不支持群组消息类型。

  3. 客户返回“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": "我收到一条消息",
}]