文档首页/ 消息&短信 MSGSMS/ API参考/ API/ 应用、签名、模板/ 短信签名/ 创建短信签名
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

创建短信签名

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/msgsms/signatures

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，参考“获取帐号、用户、项目的名称和ID”

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json;charset=utf8

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

app_id

是

String

应用主键ID，参考表5 响应SmsAppQueryResp参数中的ID

apply_desc

否

String

申请说明

file_id

否

String

营业执照文件ID，表5的file_id

is_involved_third

是

String

是否涉及第三方权益

  • yes：是
  • no：否

power_attorney_fileid

否

String

授权委托书文件ID，表5的file_id

signature_name

是

String

签名名称

signature_source

是

Integer

签名来源。支持枚举值：

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

signature_type

是

String

签名类型。支持枚举值：

  • VERIFY_CODE_TYPE：验证码类
  • PROMOTION_TYPE：推广类
  • NOTIFY_TYPE：通知类

source_title_content

否

String

签名来源标题内容

qualification_id

是

String

资质ID，当前考虑存量应用的接口兼容性，代码未做强制校验，但创建签名时请务必携带资质ID，否则会导致资质审核失败

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

签名主键ID

signature_id

String

签名ID

signature_name

String

签名名称

请求示例

创建短信签名，请求方式POST，请求URI：/v2/{project_id}/msgsms/signatures，路径参数：project_id，请求头参数：X-Auth-Token，Content-Type；请求体参数：app_id，is_involved_third，signature_name，signature_source，signature_type、qualification_id。

POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******
Content-Length: 245
 
{
"app_id":"******9c-1a6b-4ee5-9651-5bca450694b3",
"apply_desc":"test",
"qualification_id":"******ab-1390-4268-9463-73db98cdc2e1",
"is_involved_third":"No",
"signature_name":"auto_test789",
"signature_source":"0",
"signature_type":"NOTIFY_TYPE"
}

响应示例

{
    "id": "******bb-d48c-4c4d-b3da-baa8e4664852",
    "signature_id": "******d1-196f-495f-abbe-42240469b8fc",
    "signature_name": "auto_test789"
}

返回值

返回值

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

System error
父主题： 短信签名

相关文档