文档

ChatAppStatus

更新时间:

您可以通过指定HTTP URL来接收ChatApp的消息回执状态报告。

协议说明

参数

说明

协议

HTTP + JSON

编码

UTF-8

请求说明

单次推送可能会包含多条消息状态报告结果。

MsgFrameTypetemplate的请求样例

[
    {    
    "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"
    }
]

MsgFrameTypemessage的请求样例

[
    {    
    "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

消息发送状态。取值:

  • Sent:消息已发送。

  • Delivered:消息已投递到用户设备。

  • Read:消息已被用户阅读。

  • Failed:消息发送失败。

  • Deleted:消息已被用户删除。

    说明

    Deleted状态暂不可用,WhatsApp不会推送给ChatApp消息服务。

StatusDescription

String

状态码的描述。

ErrorCode

String

错误码。

ErrorDescription

String

错误码描述。详情请参见API错误码

ConversationType

String

会话类型。取值:

  • service:用户发起会话

  • utility交易相关消息

  • marketing营销类消息

  • authentication身份验证消息

ConversationId

String

会话ID。

MsgFrameType

String

消息类型。取值:

  • message:任意格式的消息,时间限制为在收到用户最后一条消息后的24小时内可发送此类消息。

  • template:在控制台已被审核通过的消息模板,可以在任意时间发送。

Type

String

消息内容中多媒体资源类型。取值:

  • image:图片

  • video:视频

  • document:文档

  • audio:音频

  • none:纯文本

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次后仍失败,不再重试。