文档

SendBatchSms - 批量发送短信

更新时间:

批量发送短信,支持多个号码,多个签名,模板只能用一个。

接口说明

  • 针对国内短信服务超时的时间建议设置≥1S。
  • SDK 重试默认是开启的,建议关闭不要打开重试;发生超时失败的情况,建议等待回执状态再决定是否重试;
  • 国内短信、国际短信和多媒体消息,均不支持幂等的能力,请您自行做好幂等控制。
  • 该接口单次最多支持 100 个号码。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dysms:SendBatchSmsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PhoneNumberJsonstring

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

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

短信签名名称。

添加签名并审核通过后,才可使用签名名称。 您可以通过 AddSmsSign 接口添加签名或在短信服务控制台添加签名。

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

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

添加模板并审核通过后,才可使用模板 Code。 您可以通过 AddSmsTemplate 接口添加签名或在短信服务控制台添加模板。

SMS_15255****
TemplateParamJsonstring

短信模板变量对应的实际值。

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

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

说明 无特殊需要可忽略此字段。
["90999","90998"]
OutIdstring

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

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

返回参数

名称类型描述示例值
object
Codestring

请求状态码。

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

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

OK
BizIdstring

发送回执 ID。

9006197469364984400
RequestIdstring

请求 ID。

F655A8D5-B967-440B-8683-DAD6FF8D230E

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
说明 当前页面为新版 API 接口,我们强烈推荐您使用新版 API 接口和 SDK 。旧版 SDK 和 API 已不再维护。如您仍需访问和使用旧版 SDK 和 API,可参见短信批量发送 API(SendBatchSms)---Java
  • 本页导读 (1)