队列管理
新增队列
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/queue/add
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|
| QueueName | string | 是 | 队列名称（64 长度以内） |
| Priority | Integer | 否 | 队列优先级：1 ~ 10，默认 10 （数值越小，优先级越高） |
| Global | Integer | 否 | 是否全局队列：0 否 1 是，默认 0 |
| QueDesc | string | 否 | 描述信息（200 长度以内） |
返回数据
| 名称 | 类型 | 说明 |
|---|
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
| 名称 | 类型 | 说明 |
|---|
| QueueID | Integer | 队列id |
| QueueName | string | 队列名称 |
| Priority | Integer | 队列优先级：1 ~ 10 （数值越小，优先级越高） |
| Global | Integer | 是否全局队列：0 否 1 是 |
| QueDesc | string | 描述信息 |
| CreateTime | string | 队列创建时间 |
返回状态码RspCode说明
| 数值 | 说明 |
|---|
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 队列名称已存在 |
修改队列
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/queue/modify
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|
| QueueID | Integer | 否 | 队列ID |
| QueueName | String | 否 | 队列名称 |
| NewQueueName | String | 否 | 新队列名称（64 长度以内） |
| QueDesc | String | 否 | 描述信息（200 长度以内） |
| Priority | Integer | 否 | 队列优先级：1 ~ 10（数值越小，优先级越高） |
| Global | Integer | 否 | 是否全局队列：0 否 1 是 |
注：队列ID和队列名称必须传值一个，以便确定需要修改的队列，多个同名队列时，不予修改
返回数据
| 名称 | 类型 | 说明 |
|---|
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
返回状态码RspCode说明
| 数值 | 说明 |
|---|
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 无法确定唯一队列 |
删除队列
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/queue/delete
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|
| QueueID | Integer | 否 | 队列ID |
| QueueName | String | 否 | 队列名称 |
注：队列ID和队列名称必须传值一个，以便确定需要修改的队列，多个同名队列时，不予删除
返回数据
| 名称 | 类型 | 说明 |
|---|
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
返回状态码RspCode说明
| 数值 | 说明 |
|---|
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 无法确定唯一队列 |
查询队列
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/queue/query
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|
| QueueID | Integer | 否 | 队列ID |
| QueueName | String | 否 | 队列名称（全文模糊查询） |
| QueDesc | String | 否 | 描述信息 |
| PageNumber | Integer | 否 | 分页查询页数，最小值 1 ，默认 1 |
| PageSize | Integer | 否 | 分页查询每页数量，最小值 1 最大值 50 ，默认 20 |
注：队列ID和队列名称传值可以过滤查询单个队列，PageSize和PageNumber超出范围按默认值查询
返回数据
| 名称 | 类型 | 说明 |
|---|
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
| 名称 | 类型 | 说明 |
|---|
| queueCount | Integer | 符合条件的队列总数 |
| queueList | List | 数据集合（数组） |
queueList数据
| 名称 | 类型 | 说明 |
|---|
| QueueID | Integer | 队列ID |
| QueueName | String | 队列名称 |
| Priority | Integer | 优先级 |
| Global | Integer | 是否全局队列：0 否 1 是 |
| QueDesc | String | 描述 |
| CreateTime | String | 创建时间 |
| UpdateTime | String | 最后修改时间 |
| AgentNum | Integer | 坐席数 |
| SrvNum | Integer | 正在服务人数 |
| WaitNum | Integer | 排队人数 |
| PrepareNum | Integer | 准备服务人数 |
| MaxWaitNum | Integer | 队列最大长度 |
| MaxWaitTime | Integer | 最大等待时间 |
返回状态码RspCode说明
| 数值 | 说明 |
|---|
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
