1 概述

接口地址（Base URL）

/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentStatus

请求头字段

Accept: application/jsonContent-Type: application/json;charset=utf-8Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

鉴权说明

基于主账号Basic Authorization鉴权

2 坐席登入

请求地址

/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentStatus/login

请求参数

参数	约束	说明
agentNo	M	坐席工号
workStatus	M	坐席初始状态。1:就绪；2:未就绪；
phoneType	M	话机类型。1:SIP话机；2:PSTN电话

请求消息示例

{"agentNo":"1111","workStatus":"1","phoneType":"1"}

响应参数

参数	说明
statusCode	状态码
statusMsg	状态描述

statusCode取值	statusMsg	说明
"00000"	"success"	成功
"00001"	"not registered"	失败，原因是SIP终端未注册

响应消息示例

{"statusCode":"00000","statusMsg":"success"}

3 坐席登出

请求地址

/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentStatus/logout

请求参数

参数	约束	说明
agentNo	M	坐席工号
phoneType	O	话机类型。1:SIP话机；2:PSTN电话

---

4 坐席就绪（置闲）

请求地址

/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentStatus/ready

请求参数

参数	说明
agentNo	坐席工号

---

5 坐席暂停（置忙）

请求地址

/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentStatus/pause

请求参数

参数	说明
agentNo	坐席工号

---

6 坐席状态查询

请求地址

/Accounts/{accountSid}/Applications/{applicationSid}/ccpaas/AgentStatus/query

请求参数

参数	约束	说明
agentNo	O	坐席工号。如果填写，则查询坐席的状态
queueId	O	队列id。如果填写，则查询与此队列关联的所有坐席的状态

响应参数

参数	R	说明
statusCode	M	"00000"成功
statusMsg	O	状态描述
data	O	JOSN数组，描述每个坐席状态的列表
agentNo	O	坐席工号
workStatus	O	坐席状态。0：未登录；1:就绪；2:非就绪；
sipNumber	O	坐席SIP号码
sipStatus	O	坐席SIP状态：0:话机终端未注册；1:话机终端已注册
sipContact	O	坐席SIP话机联系地址
sipUserAgent	O	SIP终端类型
registerTime	O	SIP（最近）注册时间
validTime	O	SIP注册有效截至时间
callState	O	坐席呼叫状态：idle,ringing,connected

响应消息示例

{  "statusCode": "00000",  "statusMsg": "succ",  "data": [
    {      "agentNo":"3001",      "workStatus":"1",      "sipNumber":"7001000093001",      "sipStatus":"1",      "sipContact":"sip:218.241.227.35:1026",      "sipUserAgent":"MicroSIP/3.19.31",      "registerTime":"2020-06-30 20:20:12",      "validTime":"2020-06-30 20:25:12",      "callState": "idle"
    },
    {      "agentNo":"3002",      "workStatus":"1",      "sipNumber":"70010000930021",      "sipStatus":"1",      "sipContact":"sip:218.241.227.36:1026",      "sipUserAgent":"MicroSIP/3.19.31",      "registerTime":"2020-06-30 20:20:23",      "validTime":"2020-06-30 20:25:23",      "callState": "idle"
    }
  ]
}