短信签名作为短信发送方的一种标识,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,并与短信内容一起发送给接收方。
接口说明
-
新接口和原接口变更的公告详情请参见关于短信服务更新签名&模板接口的公告。
-
个人认证用户,同一个阿里云账号一个自然日支持申请一个正式签名,企业认证用户,目前无限制。个人用户与企业用户权益区别详情请参见使用须知。
-
通过接口申请的签名信息会同步在短信服务控制台,在控制台对签名的相关操作,请参见短信签名。
-
提交签名申请后,您可以通过 GetSmsSign 接口查询签名审核状态和详情。也可以配置回执消息,通过 SignSmsReport 获取签名的审核状态消息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dysms:CreateSmsSign | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SignName | string | 是 | 签名名称,签名名称请遵守签名规范。 说明
| 阿里云验证码 |
Remark | string | 否 | 短信签名场景说明,长度不超过 200 个字符。 说明
场景说明是签名审核的参考信息之一。请详细描述已上线业务的使用场景,并提供可以验证这些业务的网站链接、已备案域名地址、应用市场下载链接、公众号或小程序全称等信息。对于登录场景,还需提供测试账号密码。信息完善的申请说明会提高签名、模板的审核效率。短信场景填写可参考签名来源表格中应用场景的填写。如未按规范进行填写或不填写,可能会影响您签名审核的通过。
| 登录场景使用验证码 |
SignType | integer | 否 | 签名类型。取值:
说明
建议使用默认值:通用。
| 1 |
MoreData | array | 否 | 更多资料,补充上传业务证明文件或业务截图,有助于审核人员了解您的业务详情。 此参数非必填,请您根据实际需要填写。 | |
string | 否 | 上传到 OSS 的文件信息。 文件上传操作,请参见 OSS 上传文件。 | 10098689758*****/1234qwe.png | |
QualificationId | long | 是 | 8563** | |
ApplySceneContent | string | 否 | 请根据关联的签名来源填写不同的应用场景链接,填写说明如下:
| http://www.aliyun.com/ |
SignSource | integer | 是 | 1 | |
ThirdParty | boolean | 否 | 选择申请的签名为自用或他用。
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CCA2BCFF-2BA7-427C-90EE-AC6994748607",
"Code": "OK",
"Message": "successful",
"SignName": "阿里云验证码",
"OrderId": "2004415****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 没有访问权限,请联系管理员 |
400 | ParameterMismatch.ThirdParty | The type of signature, whether for personal use or for a third party, should be consistent with the qualifications. | 签名是否第三方使用应和资质保持一致。 |
400 | SignName.Exists | Sorry, this signature already exists and cannot be applied for again. | 抱歉,此签名已经存在,不可重复申请。 |
400 | InvalidQualification | The qualification should be approved. | 无效的资质,资质应审核通过。 |
400 | InvalidSignName | The signature cannot contain spaces, special symbols, or all numbers. | 签名不能包含简体中文、英文、数字之外的空格等特殊字符,且不能为全数字。 |
400 | InvalidApplySceneContent | For certain signature sources, the applySceneContent should be an HTTP or HTTPS link. | 无效的应用场景,在某些签名来源下, 应用场景应是http或者https的链接。 |
400 | MissApplySceneContent | In some signature sources, the applySceneContent is required. | 在某些签名来源下,应用场景必填 |
400 | MissingSignName | The signature name cannot be empty. | 签名名称不能为空 |
404 | QualificationNotFound | Qualification does not exist. | 资质不存在。 |
访问错误中心查看更多错误码。