# 查询主叫白名单 - QueryVcWhitelist
#### 接口功能
用户通过该接口查询主叫白名单。
#### 使用说明
仅限授权用户调用此接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限管理](https://support.huaweicloud.com/productdesc-VoiceCall/rtc_03_0011.html)。
#### URI
GET /v1.0/voicecall/caller-number/whitelist
#### 请求参数
表1请求Headers参数说明 
| 参数名称         | 是否必选 | 参数类型   | 默认值 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|:---|
| Content-Type | 否    | String | 无   | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及。 **取值范围：** 固定填写为application/json;charset=UTF-8。 **默认取值：** 不涉及。 |
| X-Auth-Token | 是    | String | 无   | 用户Token。请参考[Token认证](https://support.huaweicloud.com/api-VoiceCall/VoiceCall_05_0004.html#ZH-CN_TOPIC_0000002542846485__title931mcpsimp)获取用户Token。 说明： Token的有效期为24小时，到期后请重新获取。                                                                                                             |
   
表2请求参数URL内容 
| 参数名称              | 是否必选 | 参数类型             | 默认值 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|:---|
| offset            | 否    | Integer          | 1   | 指定本次查询返回的分页编号，从1开始。 说明： 请结合limit参数使用，系统根据该参数值从查询结果中选择分页。                                                                                                                                                                                                                                                                                            |
| limit             | 否    | Integer（1-10000） | 10  | 指定本次查询返回的最大条数。 说明： 系统根据该参数值对查询结果进行分页处理。                                                                                                                                                                                                                                                                                                               |
| caller_number     | 否    | String(1-32)     | 无   | 主叫号码。                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| app_key           | 否    | String(1-128)    | 无   | 应用app_key。 说明： 预留参数，使用该参数的场景请联系华为云客服获取。                                                                                                                                                                                                                                                                                                             |
| sub_enterprise_id | 否    | String(1-128)    | 无   | 企业ID。                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| handle_status     | 否    | String(1-32)     | 无   | 处理状态： - dealing：处理中  - success：处理成功  - failed：处理失败   |
| create_start_time | 否    | String(1-32)     | 无   | 按创建时间查询，开始日期。 说明： 该参数为UTC时间（+8小时为北京时间），时间格式为"yyyy-MM-dd HH:mm:ss"。                                                                                                                                                                                                                                                                                  |
| create_end_time   | 否    | String(1-32)     | 无   | 按创建时间查询，结束日期。 说明： 该参数为UTC时间（+8小时为北京时间），时间格式为"yyyy-MM-dd HH:mm:ss"。                                                                                                                                                                                                                                                                                |
   
#### 响应参数
表3响应结果参数 
| 参数名称       | 是否必选 | 参数类型                                                                           | 默认值 | 说明         |
|:---|:---|:---|:---|:---|
| error_code | 是    | String                                                                         | 无   | 错误码。       |
| error_msg  | 是    | String                                                                         | 无   | 错误描述。      |
| totalitems | 否    | Integer                                                                        | 无   | 数据总数。      |
| results    | 否    | [CallerNumberWhitelist\[\]] | 无   | 主叫白名单号码信息。 |
   
 表4CallerNumberWhitelist结构 
| 参数名称              | 是否必选 | 参数类型           | 默认值 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|:---|
| caller_number     | 是    | String(1-32)   | 无   | 主叫号码。                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| sub_enterprise_id | 是    | String(1-128)  | 无   | 企业ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| app_key           | 否    | String(1-128)  | 无   | 应用app_key。                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| handle_status     | 是    | String(1-32)   | 无   | 处理状态： - dealing：处理中  - success：处理成功  - failed：处理失败   |
| create_time       | 是    | String(1-32)   | 无   | 创建时间。 说明： 该参数为UTC时间（+8小时为北京时间），时间格式为"yyyy-MM-dd HH:mm:ss"。                                                                                                                                                                                                                                                                                                 |
| update_time       | 否    | String(1-32)   | 无   | 处理状态更新时间。 说明： 该参数为UTC时间（+8小时为北京时间），时间格式为"yyyy-MM-dd HH:mm:ss"。                                                                                                                                                                                                                                                                                           |
| handle_desc       | 否    | String(1-1024) | 无   | 操作结果说明。                                                                                                                                                                                                                                                                                                                                                                                                                                                |
   
#### 结果码
表5结果码说明 
| 响应码 | error_code | error_msg              | 说明       |
|:---|:---|:---|:---|
| 200 | 0          | Operation success.     | 成功。      |
| 400 | VC.0001    | Internal server error. | 系统内部错误。  |
| 400 | VC.0002    | Invalid Parameter.     | 无效参数。    |
| 400 | VC.0005    | Order does not exist.  | 订单不存在。   |
| 400 | VC.0017    | Operation failed.      | 操作失败。    |
| 403 | VC.0003    | Request unauthorized.  | 请求鉴权未通过。 |
   
#### 接口示例
- 请求示例
  ```
  GET /v1/voicecall/caller-number/whitelist?offset=1&limit=10
  ```
  
- 响应示例
  ```
  成功：
  HTTP/1.1 200
  Content-Type: application/json;charset=UTF-8
  {
      "resultcode": "0",
      "resultdesc": "Operation success.",
      "totalitems": 100,
      "results": [
          {
              "caller_number": "13000000000",
              "sub_enterprise_id": "sub_enterprise_id",
              "app_key": "app_key",
              "create_time": "2024-01-01 01:00:00",
              "update_time": "2024-01-01 08:00:00"
          }
      ]
  }
  失败：
  HTTP/1.1 400
  Content-Type: application/json;charset=UTF-8
  {
      "error_code": "VC.0002",
      "error_msg": "Invalid Parameter."
  }
  ```