使用Chat App批量发送WhatsApp消息

更新时间: 2024-11-07 15:36:27

接口说明

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。单次请求支持最多 1,000 个号码。

调试

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

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

  • 对于必选的资源类型,用背景高亮的方式表示。

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cams:SendChatappMassMessage

Write

  • acs:cams::{#accountId}:*

请求参数

名称

类型

必填

描述

示例值

ChannelType

string

通道类型

whatsapp

whatsapp

TemplateCode

string

模板编码

744c4b5c79c9432497a075bdfca36bf5

Language

string

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

en

From

string

发送方

861387777****

FallBackId

string

回落策略 ID

S00001

FallBackContent

string

回落内容

回落短信

TaskId

string

任务 ID

100000001

SenderList

object []

发送号码列表

To

string

发送号码

861388988****

TemplateParams

object

模板参数

string

模板参数

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

Payload

array

按钮的触发消息。

string

模板中按钮的触发消息。

["payloadtext1","payloadtext2","payloadtext3"]

ProductAction

object

商品信息

ThumbnailProductRetailerId

string

商品 RetailerId

skkks999393

Sections

object []

商品列表(最多10个分类,30个商品)

Title

string

分类名称

abcd

ProductItems

object []

商品列表

ProductRetailerId

string

商品 RetailerId

ksi399d8

FlowAction

object

WhatsAppFlow 消息对象

FlowToken

string

WhatsAppFlow token 信息

kde99d8

FlowActionData

object

WhatsAppFlow 默认参数

string

WhatsAppFlow 默认参数

{"name":"name"}

CustSpaceId

string

子账户空间 ID。

28251486512358****

FallBackDuration

integer

消息在指定时间内没有返回已到达回执时回落, 不填代表不根据此时间判断回落,只有发送失败和有失败的状态报告时才会回落。时间单位为秒 最小值为 60,最大值 43200

120

FallBackRule

string

回落规则。

说明

取值范围

  • undelivered 消息不能发送到端时回落(在发送状态时模板、参数需要校验通过,模板被封、号码被封等不做校验)。参数值为空时默认使用此规则

  • sentFailed 消息在校验模板、模板变量等参数时,校验不通过也会回落。只会强校验 channelType, type, messageType, to, from(是否存在)几个参数。

undelivered

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

90E63D28-E31D-1EB2-8939-A9486641****

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见API错误码

OK

Message

string

错误提示信息。

User not authorized to operate on the specified resource.

GroupMessageId

string

批量消息 ID

890000010002****

AccessDeniedDetail

string

访问被拒绝详细信息

示例

正常返回示例

JSON格式

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "GroupMessageId": "890000010002****",
  "AccessDeniedDetail": "无"
}

错误码

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.

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

上一篇: 使用Chat App发送WhatsApp消息 下一篇: WhatsApp实践教程