获取短信应用详情

功能介绍

该接口用于用户获取已创建的短信应用详情。

URI

GET /v1/sms/apps/{app_id}

表1 路径参数
参数	是否必选	参数类型	描述
app_id	是	String	应用ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
Content-Type	是	String	请求体参数类型，该字段必须设置为：application/json。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
app_id	String	应用ID，用于获取、修改应用的唯一标识。最小长度：1 最大长度：50
app_name	String	应用名称。最小长度：1 最大长度：30
status	String	状态。最小长度：1 最大长度：20 枚举值： CREATED：待上线。应用暂未创建成功，请稍候 SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停 LAUNCHED：正常。应用添加成功，可以正常使用
region	String	地域。最小长度：1 最大长度：20
create_time	String	创建时间，格式：yyyy-MM-dd'T'HH:mm:ss。最小长度：1 最大长度：20
up_link_addr	String	上行短信地址。最小长度：1 最大长度：255

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

请求示例

获取ID为2353cb25-c169-4e20-adcf-3517****0f9e的短信应用详情。

https://koomessage.myhuaweicloud.cn/v1/sms/apps/2353cb25-c169-4e20-adcf-3517****0f9e

响应示例

状态码： 200

获取短信应用详情返回体。

{
  "status" : "LAUNCHED",
  "region" : "cn",
  "app_id" : "2353cb25-c169-4e20-adcf-3517****0f9e",
  "app_name" : "应用1",
  "up_link_addr" : "https://www.huaweicloud.com/sms/receive",
  "create_time" : "2023-08-07T02:21:26"
}