更新时间:2024-03-15 GMT+08:00

创建短信应用

功能介绍

该接口用于用户创建应用信息。

URI

POST /v2/{project_id}/msgsms/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,参考“获取账号、用户、项目的名称和ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

Content-Type

String

请求体参数类型,该字段必须设置为:application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

app_name

String

应用名称

create_sign_and_template

Boolean

是否创建测试签名和模板。只有地域为中国大陆时,该字段有效

  • true:是
  • false:否

region

String

地域

  • cn:中国大陆
  • intl:全球

up_link_addr

String

上行回调地址。只有地域为中国大陆时,该字段有效

show_secret

Boolean

是否在返回消息里面显示密钥app_secret字段。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

app_key

String

应用KEY

app_name

String

应用名称

id

String

应用主键ID

app_secret

String

应用密钥,用于发送短信时携带

请求示例

POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******
Content-Length: 144
 
{
"app_name":"auto_test789",
"create_sign_and_template": 0,
"enterprise_project_id":"0",
"enterprise_project_name":"default",
"region":"cn",
 "show_secret": true
}

响应示例

{
    "id": "9e61f59c-1a6b-4ee5-9651-5bca450694b3",
    "app_key": "******3baZf4c856O4Qrbqvui3K2",
    "app_name": "auto_test789",
    "app_secret": "********3baZf4c85Qrbqvui3K2iu"
}

返回值

返回值

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

System error