文档

SendSms - 发送短信

更新时间:

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

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

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

短信签名名称。

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

阿里云
TemplateCodestring

短信模板Code。

您可以通过AddSmsTemplate接口添加模板或在短信服务控制台添加模板,模板通过审核后,才可使用模板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"
    }

    错误码

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

    变更历史

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