文档

CreateSmsSign - 申请短信签名(新接口)

更新时间:

短信签名作为短信发送方的一种标识,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,并与短信内容一起发送给接收方。

接口说明

  • 新接口和原接口变更的公告详情请参见关于短信服务更新签名&模板接口的公告

  • 个人认证用户,同一个阿里云账号一个自然日支持申请一个正式签名,企业认证用户,目前无限制。个人用户与企业用户权益区别详情请参见使用须知

  • 通过接口申请的签名信息会同步在短信服务控制台,在控制台对签名的相关操作,请参见短信签名

  • 提交签名申请后,您可以通过 GetSmsSign 接口查询签名审核状态和详情。也可以配置回执消息,通过 SignSmsReport 获取签名的审核状态消息。

调试

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

授权信息

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

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

请求参数

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

签名名称,签名名称请遵守签名规范

说明
  • 签名名称不区分大小写字母,如【Aliyun 通信】和【aliyun 通信】视为名称相同。
  • 当您的验证码签名和通用签名名称相同时,系统默认使用通用签名发送短信。
  • 阿里云验证码
    Remarkstring

    短信签名场景说明,长度不超过 200 个字符。

    说明 场景说明是签名审核的参考信息之一。请详细描述已上线业务的使用场景,并提供可以验证这些业务的网站链接、已备案域名地址、应用市场下载链接、公众号或小程序全称等信息。对于登录场景,还需提供测试账号密码。信息完善的申请说明会提高签名、模板的审核效率。短信场景填写可参考签名来源表格中应用场景的填写。如未按规范进行填写或不填写,可能会影响您签名审核的通过。
    登录场景使用验证码
    SignTypeinteger

    签名类型。取值:

    • 0:验证码

    • 1:通用(默认值)

    说明 建议使用默认值:通用
    1
    MoreDataarray

    更多资料,补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。

    此参数非必填,请您根据实际需要填写。

    string

    上传到 OSS 的文件信息。 文件上传操作,请参见 OSS 上传文件

    10098689758*****/1234qwe.png
    QualificationIdlong

    已审核通过或审核中的资质 ID。

    说明
  • 在申请短信签名前,请先申请资质
  • 您可在资质管理页面查看资质 ID。
  • 8563**
    ApplySceneContentstring

    请根据关联的签名来源填写不同的应用场景链接,填写说明如下:

    • 已备案网站,请填写 http://或 https://开头的工信部备案的网站域名。
    • 已上线 APP,请填写 http://或 https://开头的应用商店链接,并确保 App 已经上线。
    • 公众号或小程序,请填写公众号或小程序全称,并确保公众号或小程序已上线。
    • 电商平台店铺名,仅适用于企业用户,请填写 http://或 https://开头的电商店铺链接。
    http://www.aliyun.com/
    SignSourceinteger

    签名来源。取值:

    • 0:企事业单位的全称或简称。
    • 1:工信部备案网站的全称或简称。
    • 2:App 应用的全称或简称。
    • 3:公众号或小程序的全称或简称。
    • 4:电商平台店铺名的全称或简称。
    • 5:商标名的全称或简称。

    签名来源的详细说明请参见签名来源

    说明 此接口不支持申请签名来源是测试或学习线上试用的签名,如果您需要申请这两种签名来源的签名,请前往短信服务控制台申请。
    1
    ThirdPartyboolean

    选择申请的签名为自用或他用。

    • false:自用(默认值)

    • true:他用

      注意 签名为自用时,请选择自用资质 ID;签名为他用时,请选择他用资质 ID。

    false

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

    CCA2BCFF-2BA7-427C-90EE-AC6994748607
    Codestring

    请求状态码。

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

    状态码的描述。

    successful
    SignNamestring

    签名名称。

    阿里云验证码
    OrderIdstring

    工单号。

    审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。

    2004415****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "CCA2BCFF-2BA7-427C-90EE-AC6994748607",
      "Code": "OK",
      "Message": "successful",
      "SignName": "阿里云验证码",
      "OrderId": "2004415****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限,请联系管理员
    400ParameterMismatch.ThirdPartyThe type of signature, whether for personal use or for a third party, should be consistent with the qualifications.签名是否第三方使用应和资质保持一致。
    400SignName.ExistsSorry, this signature already exists and cannot be applied for again.抱歉,此签名已经存在,不可重复申请。
    400InvalidQualificationThe qualification should be approved.无效的资质,资质应审核通过。
    400InvalidSignNameThe signature cannot contain spaces, special symbols, or all numbers.签名不能包含简体中文、英文、数字之外的空格等特殊字符,且不能为全数字。
    400InvalidApplySceneContentFor certain signature sources, the applySceneContent should be an HTTP or HTTPS link.无效的应用场景,在某些签名来源下, 应用场景应是http或者https的链接。
    400MissApplySceneContentIn some signature sources, the applySceneContent is required.在某些签名来源下,应用场景必填
    400MissingSignNameThe signature name cannot be empty.签名名称不能为空
    404QualificationNotFoundQualification does not exist.资质不存在。

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