文档首页/ 云消息服务 KooMessage/ API参考/ API/ 短信签名/ 创建短信签名
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

创建短信签名

功能介绍

该接口用于用户创建短信签名。

URI

POST /v1/sms/signatures

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表2 请求Body参数

参数

是否必选

参数类型

描述

signature_name

是

String

签名名称。

最小长度：2

最大长度：16

signature_type

是

String

签名类型。

最小长度：1

最大长度：20

枚举值：

  • PROMOTION_TYPE：营销类

  • NOTIFY_TYPE：通知类

app_id

是

String

短信应用ID。

最小长度：1

最大长度：50

apply_desc

否

String

申请说明。

最小长度：0

最大长度：80

file_id

是

String

营业执照文件ID。调用上传申请文件接口获取。

最小长度：1

最大长度：50

signature_source

是

Integer

签名来源。

枚举值：

  • 0：企事业单位的全称或简称

  • 1：工信部备案网站的全称或简称

  • 2：APP应用的全称或简称

  • 3：公众号或小程序的全称或简称

  • 4：电商平台店铺名的全称或简称

  • 5：商标名的全称或简称

is_involved_third

是

String

是否涉及第三方权益。若为yes，则还需要传入授权委托书。

最小长度：1

最大长度：10

枚举值：

  • yes：涉及

  • no：不涉及

power_attorney_file_id

否

String

授权委托书文件ID。调用上传申请文件接口获取。

最小长度：1

最大长度：50

source_title_content

否

String

签名来源标题内容，填写内容需和签名来源对应，具体如下。

  • 网站域名：仅当“签名来源”为“工信部备案网站的全称或简称”时，需要输入工信部备案网站域名，如huawei.com。

  • APP应用下载地址：仅当“签名来源”为“APP应用的全称或简称”时，需要填写。

  • 公众号或者小程序的全称：仅当“签名来源”为“公众号或小程序的全称或简称”时，需要填写。

  • 电商平台店铺地址：仅当“签名来源”为“电商平台店铺名的全称或简称”时，需要填写。

最小长度：1

最大长度：180

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

signature_id

String

签名ID。

signature_name

String

签名名称。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

最小长度：0

最大长度：32

error_msg

String

结果详情。

最小长度：0

最大长度：32

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

最小长度：0

最大长度：32

error_msg

String

结果详情。

最小长度：0

最大长度：32

请求示例

创建一个名称为"API创建测试签名"，类型为通知类的短信签名。

https://koomessage.myhuaweicloud.cn/v1/sms/signatures

{
  "signature_name" : "API创建测试签名",
  "signature_type" : "NOTIFY_TYPE",
  "app_id" : "36d93093-8941-4969-82e8-*****9b276",
  "apply_desc" : "签名申请说明",
  "file_id" : "cec80a6b-95b6-405b-bbab-*****2a022",
  "signature_source" : 0,
  "is_involved_third" : "no"
}

响应示例

状态码： 200

创建短信签名响应体。

{
  "signature_id" : "fc0c9b20-cbe0-4e95-a166-2897****bd34",
  "signature_name" : "API创建测试签名"
}

状态码

状态码

描述

200

创建短信签名响应体。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 短信签名

相关文档