接口描述
本接口(BatchSendMessage)用于发送批量(目前最多16条)消息到指定的队列。
公网/内网接口请求域名,在 TDMQ CMQ 版控制台 的队列服务 > API 请求地址处复制。CMQ 的 API 调用地址示例如下:
- 公网地址:
https://cmq-gz.publicXXX.tencenttdmq.com
- 内网地址:
http://gz.mqadapter.cmq.tencentyun.com
注意:
- 不同地域的 API 调用地址 URL 会有所变化。
- 任何时候(包括内测期间),如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。
输入参数
以下请求参数列表仅列出了接口请求参数,其它参数请参见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
queueName | 是 | String | 队列名字,在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 |
msgBody.n | 是 | String | 消息正文。表示这一批量中的一条消息。目前批量消息数量不能超过16条。 为方便用户使用,n从0开始或者从1开始都可以,但必须连续,例如发送两条消息,可以是(msgBody.0, msgBody.1),或者(msgBody.1, msgBody.2)。 注意:由于目前限制所有消息大小总和(不包含消息头和其他参数,仅 msgBody)不超过64k,所以建议提前规划好批量发送的数量。 |
delaySeconds | 否 | Int | 单位为秒,表示该消息发送到队列后,需要延时多久用户才可见。(该延时对一批消息有效,不支持多对多映射) |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 0:表示成功,others:错误,详情请参见 公共错误码。 |
message | String | 错误提示信息。 |
requestId | String | 服务器生成的请求 ID,出现服务器内部错误时,用户可提交此 ID 给后台定位问题。 |
msgList | Array | 服务器生成消息的唯一标识 ID 列表,每个元素是一条消息的信息。 |
msgList 定义如下:
参数名称 | 类型 | 描述 |
---|---|---|
msgId | String | 服务器生成消息的唯一标识 ID。 |
错误码
详情请参见 公共错误码。
示例
输入:
https://domain/v2/index.php?Action=BatchSendMessage &queueName=test-queue-123 &msgBody.1=helloworld1 &msgBody.2=helloworld2 &<公共请求参数>
输出:
{
"code" : 0,
"message" : "",
"requestId":"14534664555",
"msgList":
[
{
"msgId":"123345346"
},
{
"msgId":"456436346"
}
]
}