Get Employee Monitoring Data
This interface is used to obtain employee monitoring data.
Request Method
GET /agent_monitor_infos
Request Parameters (Query String)
Parameter Name | Type | Required | Description | Restrictions |
---|---|---|---|---|
user_group_id | Integer | No | Customer service group ID | |
module_type | String | No | Customer service system module |
Detailed Parameter Description
user_group_id
If not passed, all employee information will be returned.
module_type
If not passed, all module statuses will be returned.
- IM template status corresponds to im
- Ticket acceptance status corresponds to ticket_receive
- CC module status corresponds to call
- Video module status corresponds to mpv
Return Data
Attribute Name | Type | Description |
---|---|---|
code | Integer | Execution result code, 1000 means success |
data | Array | See below for details |
Structure of data
Parameter Name | Type | Description |
---|---|---|
id | Integer | Employee ID |
nick_name | String | Employee nickname |
avatar | String | Employee avatar link |
duty | String | Employee position |
ticket_receive_status | Boolean | Ticket acceptance status |
im_status | String | IM status |
call_status | String | Call center status |
mpv_status | String | Video status |
Status Meaning
- online: Online
- offline: Offline
- busy: Busy
- idle: Idle
Example
Request
curl https://demo.udesk.cn/open_api_v1/agent_monitor_infos?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
-X GET
-H 'content-type: application/json' \
Return
{
"code": 1000,
"data": [
{
"id": 1,
"nick_name": "agent1",
"avatar": "https://pro-cs.oss-cn-hangzhou.aliyuncs.com/agent_header/e_1579165834536_ua464.jpeg",
"duty": null,
"ticket_receive_status": true,
"im_status": "busy",
"call_status": "offline",
"mpv_status": "idle"
},
{
"id": 2,
"nick_name": "agent2",
"avatar": null,
"duty": null,
"ticket_receive_status": true,
"im_status": "offline",
"call_status": "offline",
"mpv_status": "online"
}
]
}