SendSms - 发送短信

调用SendSms接口发送短信,发送前请申请短信签名和短信模板,并确保签名和模板已审核通过。

接口说明

  • 本接口主要适用于短信单发场景,特殊场景下可支持群发(最多可向1000个手机号码发送同样内容的短信),但群发会有一定延迟。
  • 如果您需要在一次请求中分别向多个不同的手机号码发送不同签名和模板内容的短信,请使用SendBatchSms接口。
  • 发送短信会根据发送量计费,价格请参见计费说明
  • 当您的验证码签名和通用签名名称相同时,系统默认使用通用签名发送短信。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

接收短信的手机号码。

手机号码格式:

  • 国内短信:+/+86/0086/86或无任何前缀的11位手机号码,例如1590000****。
  • 国际/港澳台消息:国际区号+号码,例如852000012****。

支持对多个手机号码发送短信,手机号码之间以半角逗号(,)分隔。上限为1000个手机号码。批量调用相对于单条调用及时性稍有延迟。

说明验证码类型短信,建议使用单独发送的方式。
13811111****
SignNamestring

短信签名名称。

您可以登录短信服务控制台,选择国内消息国际/港澳台消息,在签名管理页面获取。

说明必须是已添加、并通过审核的短信签名。更多短信签名规范,请参见短信签名规范
阿里云
TemplateCodestring

短信模板CODE。

您可以登录短信服务控制台,选择国内消息国际/港澳台消息,在模板管理页面查看模板CODE

说明必须是已添加、并通过审核的短信模板;且发送国际/港澳台消息时,请使用国际/港澳台短信模板。
SMS_15305****
TemplateParamstring

短信模板变量对应的实际值。支持传入多个参数,示例:{"name":"张三","number":"1390000****"}。

说明
  • 如果JSON中需要带换行符,请参照标准的JSON协议处理。
  • {"code":"1111"}
    SmsUpExtendCodestring

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

    说明无特殊需要此字段的用户请忽略此字段。如需使用,请联系您的商务经理。
    90999
    OutIdstring

    外部流水扩展字段。

    abcdefgh

    返回参数

    名称类型描述示例值
    object
    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    BizIdstring

    发送回执ID。

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

    9006197469364984****
    RequestIdstring

    请求ID。

    F655A8D5-B967-440B-8683-DAD6FF8DE990

    示例

    请求示例

    http(s)://dysmsapi.aliyuncs.com/?Action=SendSms
    &PhoneNumbers=13811111****
    &SignName=阿里云
    &TemplateCode=SMS_15305****
    &<公共请求参数>
    

    正常返回示例

    JSON格式

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

    错误码

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

    说明当前页面为新版API接口,我们强烈推荐您使用新版API接口和SDK。旧版SDK和API已不再维护。如您仍需访问和使用旧版SDK和API,可参见短信发送API(SendSms)---Java
    阿里云首页 短信服务 相关技术圈