# 查询短信应用
#### 功能介绍
该接口用于用户查询已创建的短信应用。
#### URI
GET /v1/sms/apps
表1Query参数 
| 参数         | 是否必选 | 参数类型    | 描述                                     |
|:---|:---|:---|:---|
| offset     | 否    | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 缺省值：**0** |
| limit      | 否    | Integer | 每页显示的条目数量。 缺省值：**10**                  |
| app_name   | 否    | String  | 应用名称。 最小长度：**1** 最大长度：**30**           |
| status     | 否    | String  | 应用状态。                                  |
| begin_time | 否    | String  | 创建时间筛选-开始时间。格式为：2019-10-12T07:20:50Z。  |
| end_time   | 否    | String  | 创建时间筛选-结束时间。格式为：2019-10-12T07:20:50Z。  |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码： 200**
表3响应Body参数 
| 参数        | 参数类型                                                       | 描述    |
|:---|:---|:---|
| result    | Array of [SmsApp] objects | 查询结果。 |
| page_info | [Page] object               | 分页信息。 |
   
 表4SmsApp 
| 参数           | 参数类型   | 描述                                                                                                                                                                     |
|:---|:---|:---|
| 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**                                                                                                                                        |
   
 表5Page 
| 参数     | 参数类型    | 描述                           |
|:---|:---|:---|
| offset | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 |
| limit  | Integer | 每页显示的条目数量。                   |
| total  | Integer | 总条数。                         |
   
**状态码： 400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                            |
|:---|:---|:---|
| error_code | String | 结果状态码。 最小长度：**0** 最大长度：**32** |
| error_msg  | String | 结果详情。 最小长度：**0** 最大长度：**32**  |
   
**状态码： 500**
表7响应Body参数 
| 参数         | 参数类型   | 描述                            |
|:---|:---|:---|
| error_code | String | 结果状态码。 最小长度：**0** 最大长度：**32** |
| error_msg  | String | 结果详情。 最小长度：**0** 最大长度：**32**  |
   
#### 请求示例
根据名称查询短信应用列表。
```
https://koomessage.myhuaweicloud.cn/v1/sms/apps?offset=0&limit=2&app_name=AAAAA
```
#### 响应示例
**状态码： 200**
查询短信应用响应体。
```
{
  "result" : [ {
    "status" : "LAUNCHED",
    "region" : "cn",
    "app_id" : "2353cb25-c169-4e20-adcf-****7b4e0f9e",
    "app_name" : "AAAAA",
    "up_link_addr" : "https://www.huaweicloud.com/sms/receive",
    "create_time" : "2023-08-07T02:21:26"
  } ],
  "page_info" : {
    "offset" : 0,
    "limit" : 2,
    "total" : 1
  }
}
```
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 查询短信应用响应体。 |
| 400 | 非法参数。      |
| 500 | 内部错误。      |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koomessage/ErrorCode.html)。