文档

SendSms - 发送短信

更新时间:

申请的签名和模板通过审核后,即可发送验证码、通知短信和推广短信。

接口说明

  • 本接口主要用于向单个手机号发送短信,也支持向不同的手机号(最多支持 1000 个手机号码)发送相同签名、相同模板的短信,群发会有一定延迟。如果您需要向多个不同的手机号码发送不同签名和模板内容的短信,请使用 SendBatchSms 接口。
  • 发送短信会根据发送量计费,计费详情请参见计费概述
  • SDK 重试功能默认是开启的,建议关闭重试功能;发生超时失败的情况时,建议查看回执状态后再判断是否重试。国内短信服务超时时间建议设置为≥1S。重试和超时的相关文档请参见重试机制超时机制
  • 国内短信、国际短信和多媒体短信,均不支持幂等的能力,请您自行做好幂等控制。
  • 如果您需要查看接口地址、接口格式、调用身份等详情,请参见集成概览;相关 SDK 下载和示例请参见 SDK 参考Java SDK 调用示例

调试

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

授权信息

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

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

请求参数

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

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

  • 国内短信:+/+86/0086/86 或无任何前缀的手机号码,例如 1390000****。
  • 国际/港澳台消息:国际区号+号码,例如 852000012****。
  • 接收测试短信的手机号:必须先在控制台绑定测试手机号后才可以发送。
说明 支持向不同的手机号码发送短信,手机号码之间以半角逗号(,)分隔。上限为 1000 个手机号码。批量发送相对于单条发送,及时性稍有延迟。验证码类型的短信,建议单条发送。
1390000****
SignNamestring

短信签名名称。

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

说明 如果验证码签名和通用签名相同时,默认使用通用签名发送短信。
阿里云
TemplateCodestring

短信模板 Code。

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

SMS_15305****
TemplateParamstring

短信模板变量对应的实际值。支持传入多个参数。

说明
  • 如果 JSON 中需要带换行符,请参照标准的 JSON 协议处理。
  • 模板变量规范,请参见短信模板规范
  • {"name":"张三","number":"1390000****"}
    SmsUpExtendCodestring

    上行短信扩展码。上行短信指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费,按运营商普通短信资费进行扣费。

    说明 扩展码是生成签名时系统自动默认生成的,不支持自行传入。无特殊需要可忽略此字段。
    90999
    OutIdstring

    外部流水扩展字段。

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

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    BizIdstring

    发送回执 ID。

    可根据发送回执 ID 在接口 QuerySendDetails 中查询具体的发送状态。

    9006197469364984****
    RequestIdstring

    请求 ID。

    F655A8D5-B967-440B-8683-DAD6FF8DE990

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "BizId": "9006197469364984****",
      "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-09-03OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记查看变更详情
    说明 当前页面为新版 API 接口,我们强烈推荐您使用新版 API 接口和 SDK 。旧版 SDK 和 API 已不再维护。如您仍需访问和使用旧版 SDK 和 API,可参见短信发送 API(SendSms)---Java