文档

GetSmsSign - 查询签名详情(新接口)

更新时间:

申请签名后,通过此接口查询签名审核详情。

接口说明

调试

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

授权信息

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

请求参数

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

签名名称。必须是本账号已申请的短信签名。

登录验证

返回参数

名称类型描述示例值
object
RequestIdstring

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

F655A8D5-B967-440B-8683-DAD6FF8DE990
Codestring

请求状态码。

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

状态码的描述。

OK
SignNamestring

短信签名名称。

登录验证
SignStatuslong

签名审核状态。取值:

  • 0:审核中。
  • 1:审核通过。
  • 2:审核失败,请在返回参数 Reason 中查看审核失败原因。
  • 10:取消审核。
2
CreateDatestring

短信签名的创建日期和时间。

2024-06-03 10:02:34
OrderIdstring

工单号。

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

20044156924
QualificationIdlong

资质 ID,申请签名时关联的资质 ID。

2004393****
Remarkstring

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

登录场景验证码
AuditInfoobject

审核信息。

RejectInfostring

审批未通过的原因。

通过资质信息,不能判断是否可以申请此签名。
AuditDatestring

审核时间。

2024-06-03 12:02:34
FileUrlListarray

更多资料信息,补充上传业务证明文件或业务截图文件列表。

string

上传到 OSS 上的文件信息。

10098689758*****/1234qwe.png
SignCodestring

短信签名 Code。

SIGN_100000077042023_17174665*****_ZM2kG
SignTagstring

签名标识,标识签名是用户自定义创建、系统赠送或测试签名等。取值:

  • 2:用户自定义创建签名
  • 3:系统赠送签名
  • 4:测试签名
  • 5:试用签名
2
ApplyScenestring

应用场景内容。

http://www.aliyun.com/
ThirdPartyboolean

签名为自用或他用。

  • false:自用(默认值)

  • true:他用

false
SignUsagestring

签名使用场景。

电商平台店铺名。

示例

正常返回示例

JSON格式

{
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
  "Code": "OK",
  "Message": "OK",
  "SignName": "登录验证",
  "SignStatus": 2,
  "CreateDate": "2024-06-03 10:02:34",
  "OrderId": "20044156924",
  "QualificationId": 0,
  "Remark": "登录场景验证码",
  "AuditInfo": {
    "RejectInfo": "通过资质信息,不能判断是否可以申请此签名。",
    "AuditDate": "2024-06-03 12:02:34\n"
  },
  "FileUrlList": [
    "10098689758*****/1234qwe.png\n"
  ],
  "SignCode": "SIGN_100000077042023_17174665*****_ZM2kG",
  "SignTag": "2",
  "ApplyScene": "http://www.aliyun.com/\n",
  "ThirdParty": false,
  "SignUsage": "电商平台店铺名。"
}

错误码

HTTP status code错误码错误信息描述
400ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限,请联系管理员
404SignatureNotFoundThe signature does not exist.该账号下找不到对应签名。

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