一条完整的短信由短信签名和短信内容组成,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,与短信内容一起发送给接收方。
接口说明
-
个人用户同一个阿里云账号一个自然日支持申请一个签名;企业用户申请次数无限制。个人用户与企业用户权益区别详情请参见使用须知。
-
通过接口申请的签名信息会同步在短信服务控制台,在控制台对签名的相关操作,请参见短信签名。
-
提交签名申请后,您可以通过 QuerySmsSign 接口查询签名审核状态和详情。也可以配置回执消息,通过 SignSmsReport 获取签名的审核状态消息。
QPS 限制
本接口的单用户 QPS 限制为 1 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dysms:AddSmsSign | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SignName | string | 是 | 签名名称,签名名称请遵守签名规范。 说明
| 阿里云 |
SignSource | integer | 是 | 1 | |
Remark | string | 是 | 短信签名场景说明,长度不超过 200 个字符。 签名审核的参考信息,完善申请说明有助于审核人员理解您的业务场景,提高审核效率。填写指导:
| 当前的短信签名应用于双11大促推广营销 |
SignFileList | array<object> | 是 | 签名文件列表。 | |
object | 是 | 签名数据。 | ||
FileContents | string | 是 | 签名的资质证明文件经 base64 编码后的字符串。图片不超过 2 MB。个别场景下,申请签名需要上传证明文件。 详细规范,请参见上传文件规范。 | R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uL**** |
FileSuffix | string | 是 | jpg | |
SignType | integer | 否 | 签名类型。
| 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"SignName": "阿里云"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-11 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记 | 查看变更详情 |