# 遍历坐席分机

## 接口描述

按照一定条件遍历当前账号（AccessKey 所属公司）的坐席分机列表。

坐席分机是绑定客服人员的分机，用于接听/拨打（参见[使用指南](/voip/使用指南.md)）。列表按公司维度返回，包含公司级（默认分组）与各对讲分组下的坐席分机；可通过 `wheres` 的 `voip_group_id` 筛选指定对讲分组下的坐席分机（`0` 筛选公司级默认分组）。

分机密码不会在任何接口中返回。

## 请求说明
| 接口ID | 协议 | 方法 | PATH |
| --- | --- | --- | --- |
| 100 | HTTPS | GET | /openapi/v1/voip/agents |

### PATH参数

无

### URL参数
| 参数 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| page | int | 否 | 页码，默认 1 |
| size | int | 否 | 每页条数，默认 10000 |
| wheres | string | 否 | 参见[WHERES参数](/WHERES参数.md) |
| accesskey_id | string | 是 | 参见[签名认证](/签名认证.md) |
| expires | int | 是 | 参见[签名认证](/签名认证.md) |
| signature | string | 是 | 参见[签名认证](/签名认证.md) |

*wheres允许填入的k：*

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | int | 坐席分机ID |
| enable | int | 启用状态（0:启用 / 1:停用） |
| dial_id | string | 分机号 |
| display_name | string | 坐席显示名称 |
| voip_group_id | int | 所属对讲分组ID |

### 请求示例

```
GET https://open.vzicloud.com/openapi/v1/voip/agents?page=1&size=10&accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
```

## 返回说明


### 返回参数
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| page | int | 当前页码 |
| size | int | 当前分页大小 |
| total | int | 符合条件的坐席分机总数 |
| items | array | 坐席分机列表 |
| items[].id | int | 坐席分机ID |
| items[].dial_id | string | 分机号 |
| items[].display_name | string | 坐席显示名称 |
| items[].enable | int | 启用状态（0:启用 / 1:停用） |
| items[].remark | string | 备注 |
| items[].agent_call_timeout | int | 坐席振铃时长（秒） |
| items[].wx_online | int | 微信小程序端是否在线（0:离线 / 1:在线） |
| items[].domain | string | SIP 域名（公司级如 `2.voip1.sip`，分组级如 `2.xiaoqu-a.voip1.sip`） |
| items[].voip_group_id | int | 所属对讲分组ID；`0` = 公司级默认分组（与修改接口的 `voip_group_id` 取值一致） |
| items[].voip_group_name | string | 所属对讲分组名称；公司级默认分组时为 `-` |
| items[].pms_user_id | int | 关联的臻云账号用户ID；未关联时不返回该字段 |

**注：返回参数里可能还包含其他信息但未在上面的表格内列出，请勿使用！**

### 返回示例


```json
{
  "page": 1,
  "size": 10,
  "total": 2,
  "items": [
    {
      "id": 501,
      "dial_id": "80001",
      "display_name": "客服-张三",
      "enable": 0,
      "remark": "",
      "agent_call_timeout": 20,
      "wx_online": 0,
      "domain": "2.xiaoqu-a.voip1.sip",
      "voip_group_id": 12,
      "voip_group_name": "小区A"
    },
    {
      "id": 502,
      "dial_id": "80002",
      "display_name": "客服-李四",
      "enable": 0,
      "remark": "",
      "agent_call_timeout": 20,
      "wx_online": 1,
      "domain": "2.voip1.sip",
      "voip_group_name": "-"
    }
  ]
}
```