调用SendBatchSms接口批量发送短信。

使用说明

  • SendBatchSms接口是短信批量发送接口,支持在一次请求中分别向多个不同的手机号码发送不同签名的短信。手机号码等参数均为JSON格式,字段个数相同,一一对应,短信服务根据字段在JSON中的顺序判断发往指定手机号码的签名。如果您需要往多个手机号码中发送同样签名的短信,请使用SendSms接口实现。
  • 发送短信会根据发送量计费,价格请参见计费说明
  • 在一次请求中,最多可以向100个手机号码分别发送短信。
  • SendBatchSms接口群发整体请求量限定在128k以内。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SendBatchSms

系统规定参数。取值:SendBatchSms

PhoneNumberJson String ["1590000****","1350000****"]

接收短信的手机号码,JSON数组格式。

手机号码格式:

  • 国内短信:+/+86/0086/86或无任何前缀的11位手机号码,例如1590000****。
  • 国际/港澳台消息:国际区号+号码,例如852000012****。
说明 验证码类型短信,建议使用接口SendSms单独发送。
SignNameJson String ["阿里云","阿里巴巴"]

短信签名名称,JSON数组格式。

请在控制台国内消息国际/港澳台消息页面中的签名管理页签下签名名称一列查看。

说明 必须是已添加、并通过审核的短信签名;且短信签名的个数必须与手机号码的个数相同、内容一一对应。
TemplateCode String SMS_15255****

短信模板CODE。

请在控制台国内消息国际/港澳台消息页面中的模板管理页签下模板CODE一列查看。

说明 必须是已添加、并通过审核的模板CODE;且发送国际/港澳台消息时,请使用国际/港澳台短信模版。
TemplateParamJson String [{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]

短信模板变量对应的实际值,JSON格式。

说明 如果JSON中需要带换行符,请参照标准的JSON协议处理;且模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应,表示向指定手机号码中发对应签名的短信,且短信模板中的变量参数替换为对应的值。
SmsUpExtendCodeJson String ["90999","90998"]

上行短信扩展码,JSON数组格式。无特殊需要此字段的用户请忽略此字段。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码,请参见错误码列表
Message String OK

是否调用接口成功的描述。

BizId String 900619746936498440^0

发送回执ID。

RequestId String F655A8D5-B967-440B-8683-DAD6FF8D****

请求ID。

示例

请求示例

http(s)://dysmsapi.aliyuncs.com/?Action=SendBatchSms
&PhoneNumberJson=["1590000****","1350000****"]
&SignNameJson=["阿里云","阿里巴巴"]
&TemplateCode=SMS_152550005
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SendBatchSmsResponse>
<Message>OK</Message>
<RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>
<Code>OK</Code>
<BizId>900619746936498440^0</BizId>
</SendBatchSmsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "OK",
  "RequestId" : "F655A8D5-B967-440B-8683-DAD6FF8D****",
  "Code" : "OK",
  "BizId" : "900619746936498440^0"
}

错误码

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

说明 旧版API已不做更新,API文档请参考本文,如需参考旧版,请参见API参考