呼叫中心客服监控接口

呼叫中心客服组监控接口

该接口用于获取当前公司下的某个客服组中所有成员的呼叫中心监控信息

请求方法

GET /callcenter_analysis/agents_of_group

请求参数

参数名 必填 类型 说明 限制
group_id 整型 不填时,返回所有客服状态
page 整型 页码,从1开始,默认为1
perpage 整型 每页数量,默认30,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
server_time DateTime 当前服务器时间
items 数组 详情见下
meta 对象 分页信息,详情如下

items的结构

参数名 类型 说明
id 整型 客服id
name 字符串 客服姓名
agent_work_state 字符串 客服当前状态1
agent_neaten_time 整型 客服整理时间
agent_work_way 字符串 客服工作方式2
cc_custom_state_id 整型 自定义小休状态id
subaccount_state 字符串 设备状态3
agent_call_state 字符串 坐席通话状态4
callout_count 整型 外呼次数
callin_answer_count 整型 呼入接听次数
callin_noanswer_count 整型 呼入未接次数
callout_answer_count 整型 呼出接听次数
category 字符串 最近一次通话的类型5
answer_delay 整型 最近一次通话的接听延时
talking_time 整型 最近一次通话的通话时长
conversation_id 整型 最近一次通话的通话记录id
customer json 最近一次通话的客户信息
id 整型 最近一次通话的客户id
cellphone 字符串 最近一次通话的客户的电话
other_start_at 日期 客服切换为当前状态的开始时间

详解

参数名 说明
1 agent_work_state offline 离线
idle 空闲
busy 忙碌
resting 小休
neaten 整理
2 agent_work_way voip_online 网页电话
fixed_voip_online IP话机
phone_online 传统电话(手机/座机)
3 subaccount_state offline 话机离线
unregister 未注册
expire 到期
idle 空闲
busy 通话中
4 agent_call_state off 未通话
ring 振铃中
in 通话中
5 category normal 普通通话
transfer 转接
transfer_outline 转接外线
consult 咨询
consult_outline 咨询(外线)
three_party 三方
three_party_outline 三方(外线)
listening 监听
barge_in 组长强插
substitute 组长强拆

分页信息

获取列表等接口,在返回数据中通常都会携带分页信息(meta),其内容如下:

属性名 类型 说明
current_page 整型 当前页号
total_pages 整型 总页数
count 整型 数据总量

示例

请求

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/agents_of_group?
     group_id=269&page=1&perpage=1&email=admin@demo.udesk.cn&timestamp=1525774685&sign=ce7ce9d189a8b1c5ce86cf8c335c611e8ccfc6ce \
-X GET \
-H 'content-type: appliacation/json' \

返回

{
  "code": 1000,
  "server_time": "2018-05-08T20:09:47+08:00",
  "items": [{
    "id": 269,
    "name": "展示",
    "agent_work_state": "idle",
    "agent_neaten_time": 10,
    "agent_work_way": "fixed_voip_online",
    "cc_custom_state_id": null,
    "subaccount_state": "idle",
    "web_subaccount_state": null,
    "subaccount_state": "idle",
    "web_subaccount_state": "offline",
    "agent_call_state": "off",
    "callout_count": 2,
    "callin_answer_count": 0,
    "callin_noanswer_count": 0,
    "callout_answer_count": 2,
    "category": "normal",
    "answer_delay": 0,
    "talking_time": 0,
    "customer": {
      "id": 196001,
      "cellphone": "13261998838"
    },
    "other_start_at": "2018-05-08T16:56:05.000+08:00"
  }]
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "count": 1
  }
}

今日呼叫数据

该接口用于获取当前公司今日呼叫数据

请求地址

请求参数

字段名称 类型 是否必填
group_id string 否, 不填时返回所有客服组数据
page Integer 否, 页码, 默认从1开始
perpage Integer 否,每页数量,默认30,最大100

返回数据

字段名称 类型 字段说明
code Integer 执行结果,成功为1000
server_time DateTime 当前服务器时间
items 数组 详情见下
meta 对象 分页信息

items说明

字段名称 类型 字段说明
group_id Integer 客服组ID,为空时表示所有客服组的整体数据
callin_count string 呼入数
transfer_agent_count string 转人工/ 入队数
queue_success_count string 排队成功数
queue_quit_count string 排队放弃数
callin_ringing_count string 呼入振铃数
callin_answered_count string 呼入接通数
callin_answered_rate string 呼入接听率
survey_rated_ratio string 参评率
callout_count string 呼出数
callout_no_answered_count string 呼出未接
callout_answered_count string 呼出接通
callout_answered_rate string 呼出接通率

请求示例

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/calls_info_of_today?
     group_id=1,2&page=1&perpage=1&email=admin@demo.udesk.cn&timestamp=1525774685&sign=ce7ce9d189a8b1c5ce86cf8c335c611e8ccfc6ce \
-X GET \
-H 'content-type: appliacation/json' \

返回结果

{
  code: 1000,
  server_time: "2018-05-08T20:09:47+08:00",
  items: [
    {
      group_id: ,
      callin_count: 10,
      transfer_agent_count: 4,
      queue_success_count: 5,
      queue_quit_count: 3,
      callin_ringing_count: 12,
      callin_answered_count: 13,
      callin_answered_rate: 0.43,
      survey_rated_ratio: 0.71,
      callout_count: 40,
      callout_no_answered_count: 20,
      callout_answered_count: 20,
      callout_answered_rate: 0.50
    },
    {
      group_id: 1,
      callin_count: 10,
      transfer_agent_count: 4,
      queue_success_count: 5,
      queue_quit_count: 3,
      callin_ringing_count: 12,
      callin_answered_count: 13,
      callin_answered_rate: 0.43,
      survey_rated_ratio: 0.71,
      callout_count: 40,
      callout_no_answered_count: 20,
      callout_answered_count: 20,
      callout_answered_rate: 0.50
    },
    {
      group_id: 2,
      callin_count: 10,
      transfer_agent_count: 4,
      queue_success_count: 5,
      queue_quit_count: 3,
      callin_ringing_count: 12,
      callin_answered_count: 13,
      callin_answered_rate: 0.43,
      survey_rated_ratio: 0.71,
      callout_count: 40,
      callout_no_answered_count: 20,
      callout_answered_count: 20,
      callout_answered_rate: 0.50
    }
  ]
  meta: {
    current_page: 1,
    total_pages: 1,
    count: 2
  }
}

当前排队状况

该接口用于获取当前公司当前排队数据

请求地址


请求参数

字段名称 类型 是否必填
group_id string 否, 不填时返回所有客服组数据
page Integer 否, 页码, 默认从1开始
perpage Integer 否,每页数量,默认30,最大100

返回数据

字段名称 类型 字段说明
code Integer 执行结果,成功为1000
server_time DateTime 当前服务器时间
items 数组 详情见下
meta 对象 分页信息

items说明

字段名称 类型 字段说明
group_id Integer 客服组ID,为空时表示所有客服组的整体数据
cellphone string 客户电话号码
name string 客户姓名
queue string 队列名称
start_at string 开始时间
queue_time string 排队时长

请求示例

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/calls_in_queue?
     group_id=1&page=1&perpage=1&email=admin@demo.udesk.cn&timestamp=1525774685&sign=ce7ce9d189a8b1c5ce86cf8c335c611e8ccfc6ce \
-X GET \
-H 'content-type: appliacation/json' \

返回结果

{
  code: 1000,
  server_time: "2018-05-08T20:09:47+08:00",
  items: [{
    group_id: 1,
    cellphone: '18710812345',
    name: 'udesk',
    queue: '排队放弃',
    start_at: '20180710',
    queue_time: '10'
  }]
  meta: {
    current_page: 1,
    total_pages: 1,
    count: 1
  }
}

排队状况

该接口用于获取当前公司当前排队放弃数据

请求地址


请求参数

字段名称 类型 是否必填
group_id string 否, 不填时返回所有客服组数据
page Integer 否, 页码, 默认从1开始
perpage Integer 否,每页数量,默认30,最大100

返回数据

字段名称 类型 字段说明
code Integer 执行结果,成功为1000
server_time DateTime 当前服务器时间
items 数组 详情见下
meta 对象 分页信息

items说明

字段名称 类型 字段说明
group_id Integer 客服组ID,为空时表示所有客服组的整体数据
cellphone string 客户电话号码
name string 客户姓名
abort_at string 放弃时间
queue string 队列名称
sub_call string 后续通话
task_name string 外呼任务名称

请求示例

curl https://demo.udesk.cn/open_api_v1/callcenter_analysis/calls_quitted_queue?
     group_id=1&page=1&perpage=1&email=admin@demo.udesk.cn&timestamp=1525774685&sign=ce7ce9d189a8b1c5ce86cf8c335c611e8ccfc6ce \
-X GET \
-H 'content-type: appliacation/json' \

返回结果

{
  code: 1000,
  server_time: "2018-05-08T20:09:47+08:00",
  items: [{
    group_id: 1,
    cellphone: '18710812345',
    name: 'udesk',
    abort_at: '20180710',
    queue: '排队放弃',
    sub_call: 21,
    task_name: '外呼任务'
  }]
  meta: {
    current_page: 1,
    total_pages: 1,
    count: 1
  }
}