创建短信应用 - CreateApp
功能介绍
该接口用于用户创建应用信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/msgsms/apps
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,参考“获取帐号、用户、项目的名称和ID” |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
| Content-Type | 是 | String | 请求体参数类型,该字段必须设置为:application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_name | 是 | String | 应用名称 |
| enterprise_project_id | 否 | String | 企业项目ID 默认值:0 |
| enterprise_project_name | 否 | String | 企业项目名称 默认值:default |
| region | 是 | String | 地域
|
| up_link_addr | 否 | String | 上行回调地址。只有地域为国内时,该字段有效 |
| show_secret | 否 | Boolean | 是否在返回消息里面显示密钥app_secret字段 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| app_key | String | 应用key |
| app_name | String | 应用名称 |
| id | String | 应用主键ID |
| app_secret | String | 应用密钥,用于发送短信时携带 |
请求示例
创建短信应用,完成短信应用创建,请求方式:POST,请求URI:/v2/{project_id}/msgsms/apps,请求头入参:X-Auth-Token,Content-Type,路径参数:project_id;请求体必传参数:app_name,region。
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 |