# 查询外呼活动批次
#### 前置条件
已经申请了开发者账号。
#### 场景描述
通过该接口为查询外呼活动批次。
#### 接口方法
该接口支持GET方法。
#### 接口URL
https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callbatch/{campaignId}/list
其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。
表1URL中携带的参数说明 
| 序号 | 参数名        | 参数类型 | 是否必选 | 说明                                                                                                                                      |
|:---|:---|:---|:---|:---|
| 1  | vdnId      | int  | True | 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 |
| 2  | campaignId | int  | True | 外呼活动的ID。                                                                                                                                |
   
#### 请求说明
表2请求消息头参数 
| 序号 | 名称            | 参数类型   | 是否必选 | 说明                                                                                                                            |
|:---|:---|:---|:---|:---|
| 1  | Content-Type  | String | True | 固定填 application/json;charset=UTF-8。                                                                                           |
| 2  | Authorization | String | True | 生成方式参见[C2 监控/系统外呼/话单/知识库类接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0003.html#ZH-CN_TOPIC_0000002481273406)。 |
   
表3请求消息体参数说明 
| 序号 | 参数名    | 参数类型   | 是否必选  | 说明                                                                                                                                                                                                                                |
|:---|:---|:---|:---|:---|
| 1  | status | int    | False | 批次状态， 1：启动 2：暂停。 |
| 2  | name   | String | False | 批次名称，支持模糊查询。                                                                                                                                                                                                                      |
| 3  | offset | int    | True  | offset用于确定查询的起始页。offset取值为：offset=limit\*(page-1)                                                                                                                                                                                 |
| 4  | limit  | int    | True  | 表示每页的查询数量。                                                                                                                                                                                                                        |
   
#### 响应说明
表4消息体参数说明 
| 序号 | 参数名        | 参数类型   | 说明                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| 1  | resultCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表6]。 |
| 2  | resultDesc | String | 描述。                                                                                                                                                                                                                                                    |
| 3  | returnCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表6]。 |
| 4  | returnDesc | String | 描述。                                                                                                                                                                                                                                                    |
| 5  | totalCount | int    | 返回列表中结果总条数。                                                                                                                                                                                                                                            |
| 6  | data       | List   | [表5 data参数说明]                                                                                                                              |
   
 表5data参数说明 
| 序号 | 参数名    | 参数类型   | 说明                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| 1  | id     | String | 批次id                                                                                                                                                                                                                           |
| 2  | name   | String | 批次名称。                                                                                                                                                                                                                          |
| 3  | status | int    | 批次状态， 1：启动 2：暂停 |
   
#### 触发事件
无
#### 错误结果码
 表6错误原因码说明 
| 序号 | 错误码     | 说明                       |
|:---|:---|:---|
| 1  | 0200001 | 参数异常，异常详情在resultDesc中描述。 |
| 2  | 0200006 | 数据库操作异常                  |
| 3  | 0200007 | 外呼活动不存在                  |
   
#### 报文样例
- 该接口的请求消息体举例如下：
  ```
  {
      "name": "te",
      "status": 1,
      "offset": 0,
      "limit": 5
  }
  ```
  
- 该接口的响应消息体举例如下：
  ```
  {
      "returnCode": "0200000",
      "data": [
          {
              "name": "test2",
              "id": "174712034211433247704877116507",
              "status": 1
          }
      ],
      "resultCode": "0200000",
      "resultDesc": "success",
      "totalCount": 1,
      "returnDesc": "success"
  }
  ```