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

创建短信应用

功能介绍

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

URI

POST /v1/sms/apps

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json。
表2 请求Body参数

参数

是否必选

参数类型

描述

app_name

是

String

应用名称。

最小长度：1

最大长度：30

up_link_addr

否

String

上行回调地址。支持通信协议HTTPS/HTTP。

最大长度：255

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

app_name

String

应用名称。

最小长度：1

最大长度：30

app_id

String

应用ID。

最小长度：1

最大长度：50

状态码： 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

请求示例

创建一个名称为Huawei_12688，上行回调地址为https://www.huaweicloud.com/的短信应用。

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

{
  "app_name" : "Huawei_12688",
  "up_link_addr" : "https://www.huaweicloud.com/"
}

响应示例

状态码： 200

创建短信应用响应体。

{
  "app_id" : "1f3*****-0873-4555-8778-24704ddf6c07",
  "app_name" : "Huawei_12888"
}

状态码

状态码

描述

200

创建短信应用响应体。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

父主题： 短信应用

相关文档