更新时间:2023-12-19 GMT+08:00

根据座席状态分页查询座席信息

场景描述

根据座席状态分页查询座席信息。

接口方法

POST

内部封装接口

BMS接口:/ccbms/ws/monitor/siteagentinfobyagentids

接口URI

https://ip:port/rest/cmsapp/v1/openapi/vdn/queryAgentByStatus

其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求Headers参数说明

参数名称

是否必选

参数类型

默认值

说明

Content-Type

必选

String

固定填 application/json; charset=UTF-8。

Authorization

必选

String

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

表2 请求Body参数说明

参数名称

是否必选

参数类型

默认值

说明

ccId

必选

String(1-25)

呼叫中心ID

取值:1~65535

vdn

必选

String

虚拟呼叫中心ID

取值: 1~5000

status

可选

String

座席状态。

取值参考CTI平台座席状态码参考

offset

必选

number

offset用于确定查询的起始页。

offset取值公式为:offset=limit*(page-1),取值范围:>=0

page为需要查询的起始页。

limit

必选

number

每页数量,最大1000

响应说明

表3 响应消息参数说明

参数名称

参数类型

说明

returnCode

String

请求返回的结果码。

0:表示成功

其他:失败

description

String

请求结果描述

data

array

请求响应数据。

表4 响应消息data参数说明

参数名称

参数类型

说明

agentId

number

座席工号

locationId

number

所属分布式接入节点

CTI保留字段,无实际意义

currentState

number

座席状态。

参数说明请参考CTI平台座席状态码参考

currentStateTime

number

该状态持续时间,单位秒(s)

错误码

报文样例

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 请求参数:
    {
      "ccId": "1","vdn": "3","status": "0","limit": 10,"offset": 0
    }
  • 响应参数:
    {
      "returnCode": "0",
      "data": [
        {
          "agentId": 108,
          "locationId": 65535,
          "currentStateTime": 426849,
          "currentState": 0
        },
        {
          "agentId": 109,
          "locationId": 65535,
          "currentStateTime": 426849,
          "currentState": 0
        }
      ],
      "description": "success"
    }