AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 Chat App 消息服务 开发参考 API参考 API目录 消息发送 SendChatappMessage - 发送ChatApp消息

SendChatappMessage - 发送ChatApp消息

更新时间：
产品详情
我的收藏

发送ChatApp消息。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 250 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

状态变更

消息发送状态可以通过 MNS/HTTP 方式监听，具体请参考回执消息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:SendChatappMessage

create

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
ChannelType

string

是

通道类型。取值：

  • whatsapp。

  • messenger。

  • instagram。

whatsapp
Type

string

是

消息类型。取值：

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

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

重要 当 Type 为 template 时，必须设置 TemplateCode；当 Type 为 message 时，必须设置 MessageType。

message
MessageType

string

否

当 Type 为 message 时，指定消息的详细类型。取值：

  • text：纯文本消息，设置此类型时 Content 字段中的 Text 参数为必填。

  • image：图片消息，设置此类型时 Content 字段中的 Link 参数为必填，Caption 参数为选填。

  • video：视频消息，设置此类型时 Content 字段中的 Link 参数为必填，Caption 参数为选填。

  • audio：音频消息，设置此类型时 Content 字段中的 Link 参数为必填，Caption 参数则无效。

  • document：文档消息，设置此类型时 Content 字段中的 Link 参数及 FileName 参数为必填，Caption 参数则无效。

text
TemplateCode

string

否

模板编码。通道管理>管理>模板设计界面查看模板编码。

1119***************

Language

string

否

语言。详细语言代码列表，请参见语言代码。

en
From

string

是

发送方号码。

  • 当 ChannelType 为 whatsapp 时为注册并绑定 WhatsApp 的电话号码。在通道管理>管理>WABA 管理>号码管理界面查看。

  • 当 ChannelType 为 messenger 时为公共主页 ID（Page ID）。在通道管理>管理>公共主页界面查看。

  • 当 ChannelType 为 instagram 时为 instagram 专业账户 ID（Account ID）。在通道管理>管理>专业账户界面查看。

861387777****
To

string

是

接收方号码。

  • 当 ChannelType 为 whatapp 时为消息接收方的电话号码。

  • 当 ChannelType 为 messenger 为与 Facebook 页面消息互动时生成的一个 Page-Scoped User ID。

  • 当 ChannelType 为 instagram 时为用户与 Instagram 商业账号或创作者账号消息互动时生成的 Instagram User ID。

861388988****
TemplateParams

object

否

模板参数集合。

string

否

模板参数。Key-Value 格式，Key 为参数名称，Value 为参数取值。

{ "param1": "value1", "param2": "value2" }
Content

string

否

消息内容。

WhatsApp 消息备注：

  • 当 messageType 为 text 时，text 字段为必填，Caption 禁止填写。

  • 当 messageType 为 image 时，Link 必填。

  • 当 messageType 为 video 时，Link 必填。

  • 当 messageType 为 audio 时，Link 必填，Caption 字段无效。

  • 当 messageType 为 document 时，Link 和 FileName 字段必填，Caption 字段无效。

  • 当 messageType 为 interactive 时，type 和 action 字段必填。

  • 当 messageType 为 contacts 时，name 字段必填。

  • 当 messageType 为 location 时，longitude 和 latitude 字段必填。

  • 当 messageType 为 sticker 时，Link 字段必填，Caption 和 FileName 字段无效。

  • 当 messageType 为 reaction 时，messageId 和 emoji 字段必填。

Messenger 消息备注：

  • 当 messageType 为 text 时，text 字段必填。

  • 当 messageType 为 image、video、audio、document 时，link 字段必填。

Instagram 消息备注：

  • 当 messageType 为 text 时，text 字段必填。

  • 当 messageType 为 image、video、audio 时，link 字段必填。

{ "text": "hello,whatsapp", "link": "https://*******", "caption": "****", "fileName": "****" }
Payload

array

否

按钮的触发消息集合。

payloadtext1,payloadtext2,payloadtext3

string

否

模板中按钮的触发消息。

payloadtext

CustWabaId deprecated

string

否

ISV 客户 wabaId。 过时的参数，请使用 CustSpaceId，直客客户实例 ID。在通道管理>界面查看。

cams-8c8*********

FallBackId

string

否

回落策略 ID。该参数为国际站配置参数，中国站可忽略此参数。

S0****
FallBackContent

string

否

自定义回落内容。该参数为国际站配置参数，中国站可忽略此参数。

Fallback SMS
IsvCode deprecated

string

否

ISV 校验码，用于校验子账号是否由 ISV 授权，已弃用，可忽略此参数。

123123******
CustSpaceId

string

否

ISV 子客户的 SpaceId ，直客客户实例 ID。在通道管理界面查看。

cams-8c8*********

ContextMessageId

string

否

回复的消息 ID。指原来已发送过或者收到的消息 ID。

61851ccb2f1365b16aee****

TrackingData

string

否

Viber 消息类型传入的自定义追踪数据，此参数为国际站参数，中国站可忽略此参数

Tracking Data
Label

string

否

Viber 消息类型，此参数为国际站参数，中国站可忽略此参数。

promotion
Ttl

integer

否

Viber 消息发送超时时间。此参数为国际站参数，中国站可忽略此参数。

50
Tag

string

否

标签信息，Viber 消息发送时自定义标签信息。

tag
TaskId

string

否

自定义任务 ID。

10000****
FallBackDuration

integer

否

回落触发时间。此参数为国际站参数，中国站可忽略此参数。

120
ProductAction

object

否

商品信息，此参数只针对于 whatsapp 类型通道。即为您在 Meta 上上传的商品信息。

ThumbnailProductRetailerId

string

否

商品目录 ID。可通过 ListProductCatalog 接口获取。

skkks99****
Sections

array

否

商品分类列表（最多可以有 10 个分类，30 个商品）。

array<object>

否

商品分类。

Title

string

否

分类名称。在通道管理>管理>目录管理>商品管理界面查看或通过 ListProduct 接口获取。

abcd
ProductItems

array

否

商品信息列表。

object

否

商品信息。

ProductRetailerId

string

否

商品 ID。在通道管理>管理>目录管理>商品管理界面查看或通过 ListProduct 接口获取。

ksi3****
FallBackRule

string

否

回落规则。此参数为国际站参数，中国站可忽略此参数。

undelivered
FlowAction

object

否

Flow 消息对象。

FlowActionData

object

否

flow 默认参数集合。

any

否

flow 默认参数。Key-Value 格式，Key 为参数名称，Value 为参数取值。

{ "name": "name" }
FlowToken

string

否

自定义 flow token 信息。

kde****
TemplateName

string

否

模板名称。在通道管理>管理>模板设计界面查看模板名称。

test_name
RecipientType

string

否

收件人类型。取值：

  • individual：个体。

  • group：群组。

individual

返回参数

名称

类型

描述

示例值

object

返回数据。

AccessDeniedDetail

string

访问被拒绝详细信息。

无
RequestId

string

请求 ID。

90E63D28-E31D-1EB2-8939-A94866******
Message

string

错误提示信息。

User not authorized to operate on the specified resource.
Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码，请参见错误码列表。

OK
MessageId

string

消息 ID。

61851ccb2f1365b16aee****

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Message": "User not authorized to operate on the specified resource.",
  "Code": "OK",
  "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. 资源不属于当前用户。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：SendChatappMassMessage - 批量发送ChatApp消息下一篇：模板管理