SendBatchSms - 批量发送短信

更新时间:
复制为 MD 格式

调用此接口可以给不同的手机号码,发送不同签名、同一个模板(可以是不同模板变量)的短信。

接口说明

基本信息

  • 本接口主要用于向多个手机号发送短信,支持发送不同签名、同一模板、不同模板变量的短信,单次调用最多支持 100 个手机号。

  • 服务接入点 (Endpoint):全局接入点域名为dysmsapi.aliyuncs.com。请参见服务接入点 ,根据您的使用地域,选择对应的接入点地址。

快速调用

注意事项

  • 国内短信服务超时时间建议设置为≥1S;发生超时失败的情况时,建议查看回执状态后再判断是否重试。超时和重试的相关设置,请参见超时机制重试机制

  • 国内短信、国际短信及多媒体短信目前均不支持幂等的能力,请您做好幂等控制,防止因多次重试而导致的重复操作问题。

  • 发送短信为计费接口,国内短信按照运营商回执状态计费,调用 SendBatchSms 提交成功但运营商回执失败的短信不计费,计费详情请参见计费概述

QPS 限制

本接口的单用户 QPS 限制为 5000/秒。超过限制,API 调用将会被限流,请合理使用。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dysms:SendBatchSms

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

PhoneNumberJson

string

接收短信的手机号码。手机号码格式:

  • 国内短信:+/+86/0086/86 或无任何前缀的手机号码,例如 1590000****。

  • 国际/港澳台消息:国际区号+号码,例如 852000012****。

说明

验证码类型短信,建议使用 SendSms 接口单条发送。

["1590000****","1350000****"]

SignNameJson

string

短信签名名称,签名数量需与手机号码数量一致。

您可以通过 QuerySmsSignList 接口查询当前账号已申请的签名或在短信服务控制台查看已审核通过的签名,必须使用审核通过的签名发送短信。

说明
  • 系统会根据您选择的签名执行短信发送任务。

["阿里云","阿里巴巴"]

TemplateCode

string

短信模板 Code。国内短信模板和国际短信模板不可以混用。

您可以通过 QuerySmsTemplateList 接口查询当前账号已申请的模板或在短信服务控制台查看模板列表,必须使用已审核通过的模板 Code 发送短信。

SMS_15255****

TemplateParamJson

string

短信模板变量对应的实际值。当您选择的模板内含有变量时,此参数必填。

说明
  • 模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应,表示向指定手机号码中发对应签名的短信,且短信模板中的变量参数替换为对应的值。

  • 如果 JSON 中需要带换行符,请参照标准的 JSON 协议处理。

[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]

SmsUpExtendCodeJson

string

上行短信扩展码,JSON 数组格式。

说明

无特殊需要可忽略此字段。

["90999","90998"]

OutId

string

外部流水扩展字段,长度小于 256 的字符串。

说明

无特殊需要可忽略此字段。

abcdefg

返回参数

名称

类型

描述

示例值

object

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见错误码列表

OK

Message

string

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

OK

BizId

string

发送回执 ID。

9006197469364984400

RequestId

string

请求 ID。

F655A8D5-B967-440B-8683-DAD6FF8D230E

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "BizId": "9006197469364984400",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D230E"
}

错误码

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

变更历史

更多信息,参考变更详情