发送ChatApp消息。
接口说明
QPS 限制
本接口的单用户 QPS 限制为 250 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
状态变更
消息发送状态可以通过 MNS/HTTP 方式监听,具体请参考回执消息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ChannelType | string | 是 | 类型。取值:
| |
Type | string | 是 | 消息类型。取值:
| template |
MessageType | string | 否 | 当 Type 为 message 时,指定消息的详细类型。 Whatsapp 消息类型:
Viber 消息类型:
说明
详细字段说明,请参见字段说明。
| text |
TemplateCode | string | 否 | 模板 Code。Type 为 template 时此字段必填。 | 744c4b5c79c9432497a075bdfca3**** |
Language | string | 否 | 模板语言。Type 为 template 时此字段必填,详细语言代码列表,请参见语言代码。 | en |
From | string | 是 | 消息发送方号码。 说明
当前支持 WhatsApp 账号且在控制台审核通过的号码。
| 861360000**** |
To | string | 是 | 消息接收方号码。 | 861390000**** |
TemplateParams | object | 否 | 消息模板变量。 | |
string | 否 | 消息模板变量对应的实际值,参数格式为 JSON 格式。如果模板中存在变量,该参数为必填项。 | {"param1":"value1","param2":"value2"} | |
Content | string | 否 | 消息内容。 Whatsapp 消息备注:
Viber 消息备注:
| {"text": "hello whatsapp", "link": "", "caption": "", "fileName": "" } |
Payload | array | 否 | 按钮的触发消息。 | |
string | 否 | 模板中按钮的触发消息。 | payloadtext1,payloadtext2,payloadtext3 | |
CustWabaIddeprecated | string | 否 | ISV 客户 wabaId。 说明
过时的参数,请使用 CustSpaceId。
| 65921621816**** |
FallBackId | string | 否 | 失败回落策略 ID。可以在控制台创建相关策略并查看。 说明
中国站此字段无效。
| S_00**** |
FallBackContent | string | 否 | 失败回落消息内容。 说明
中国站此字段无效。
| This is a fallback message. |
IsvCode | string | 否 | ISV 校验码,用于校验子账号是否由 ISV 授权。 | skdi3kksloslikd**** |
CustSpaceId | string | 否 | 子账户空间 ID。 | 28251486512358**** |
ContextMessageId | string | 否 | 回复的消息 ID。 | 61851ccb2f1365b16aee**** |
TrackingData | string | 否 | Viber 消息跟踪数据值。 | tracking_id:12**** |
Label | string | 否 | Viber 消息类型。当 ChannelType=viber 时为必填,取值:
| promotion |
Ttl | integer | 否 | Viber 消息发送超时时间,单位:秒,取值范围 30~1209600。 | 50 |
Tag | string | 否 | Viber 消息发送时 tag 信息。 | tag |
TaskId | string | 否 | 任务 ID。 | 10000**** |
FallBackDuration | integer | 否 | 消息在指定时间内没有返回已到达回执时回落, 不填代表不根据此时间判断回落,仅发送失败和有失败的状态报告时才会回落。时间单位为秒,最小值为 60,最大值 43200。 说明
中国站此字段无效。
| 120 |
ProductAction | object | 否 | Whatsapp CATALOG/MPM 消息发送是商品信息。 | |
ThumbnailProductRetailerId | string | 否 | 商品 RetailerId。 | S238SK**** |
Sections | array<object> | 否 | 商品列表(最多可以有 10 个分类,30 个商品)。 | |
object | 否 | 商品分类。 | ||
Title | string | 否 | 分类名称。 | 测试 |
ProductItems | array<object> | 否 | 商品列表。 | |
object | 否 | 商品信息。 | ||
ProductRetailerId | string | 否 | 商品 RetailerId。 | 9I39E**** |
FallBackRule | string | 否 | 回落规则。取值:
说明
中国站此字段无效。
| undelivered |
FlowAction | object | 否 | Flow 发送数据。 | |
FlowToken | string | 否 | flow token 信息。 | 1122*** |
FlowActionData | object | 否 | flow 默认参数。 | |
string | 否 | flow 默认参数。 | {"name":"test"} | |
TemplateName | string | 否 | 模板名称。 | test_name |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Code": "OK",
"Message": "User not authorized to operate on the specified resource.",
"MessageId": "61851ccb2f1365b16aee****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | Product.Unsubscript | You have not subscribed to the specified product. |
400 | Ram.PermissionDeny | You are not authorized to perform the operation. |
400 | System.LimitControl | The system is under flow control. |
400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-10 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-03-14 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-11-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-09-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-01 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-02 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-09-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-07-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |