3.3 同步接口列表

3.3.1 坐席登录（同步）

请求地址	https://cc.yuntongxun.com/api/v1/cti/setAgentState
请求方式	get/post
身份验证	用户名	1000@wucb
	密码	123456
请求头	Content-Type	application/json
请求体	{"cmd":"logon","online":1,"workType":1}

请求参数说明

cmd	String	是	固定值：logon
workType	integer	是	0 手机 1 sip
online	Intger	否	默认 0 0 自动空闲 1 手动预测外呼登录时只能为1
auto	Intger	否	默认0 1 预测外呼登录 0 非预测外呼登录

请求示例

{
 "cmd":"logon",
 "online":1,
 "workType":1
}


// 响应示例
{    "code": 0,    "message": "success",    "data":  {
    "agentKey":"1001@wucb",
    "message": {
        "reason":"上班成功",
        "stationNo":111,
        "type":"logon",
        "systemtime":"2020-08-12 16:11:46",
        "mainCaller":"8715628449220019",
        "status":0
 } }
}

响应包体

code	Integer	必选	返回码 0表示请求成功
message	String	必选	结果消息
data	Object	必选	返回结果
\|--agentKey	String	必选	坐席的唯一标识
\|-- message	Object	必选	操作的详细结果
\|--\|--status	integer	必选	0表示操作成， 1或其它的表示操作失败
\|--\|--type	String	必选	当前坐席的状态

ps: 当用户已经处于登录状态时返回参数

{ 
  "code" :  0 , 
  "message" :  "has bean logon" 
}

此时仍然可以正常进行后续其它操作.

3.3.2 坐席下班（同步）

请求地址	https://cc.yuntongxun.com/api/v1/cti/setAgentState
请求方式	get/post
身份验证	用户名	1000@wucb
	密码	123456
请求头	Content-Type	application/json
请求体	{"cmd":"logout"}

请求参数说明

cmd	String	是	固定值：logout

响应示例

// 下班结果通知
{    
    "code": 0,    
    "message": "success",    
    "data":  {
    "agentKey":"1001@wucb",
    "message": {
        "reason":"登出成功",
        "type":"logout",
        "systemtime":"2020-08-12 16:15:44",
        "status":0
    }
}}

响应包体

code	Integer	必选	返回码 0表示请求成功
message	String	必选	结果消息
data	Object	必选	返回结果
\|--agentKey	String	必选	坐席的唯一标识
\|-- message	Object	必选	操作的详细结果
\|--\|--status	integer	必选	0表示操作成功
\|--\|--type	String	必选	当前坐席的状态

3.3.3 坐席空闲（同步）

请求地址	https://cc.yuntongxun.com/api/v1/cti/setAgentState
请求方式	get/post
身份验证	用户名	1000@wucb
	密码	123456
请求头	Content-Type	application/json
请求体	{"cmd":"agentidle"}

请求参数说明

cmd

String

是

固定值：agentidle

响应示例

{    
    "code": 0,    
    "message": "success",    
    "data": {
    "agentKey":"1001@wucb",
    "message": {
        "reason":"示闲成功.",
        "type":"agentidle",
        "status":0
    }
}}

响应包体

code	Integer	必选	返回码 0表示请求成功
message	String	必选	结果消息
data	Object	必选	返回结果
\|--agentKey	String	必选	坐席的唯一标识
\|-- message	Object	必选	操作的详细结果
\|--\|--status	integer	必选	0表示操作成功
\|--\|--type	String	必选	当前坐席的状态

3.3.4 坐席忙碌（同步）

请求地址	https://cc.yuntongxun.com/api/v1/cti/setAgentState
请求方式	get/post
身份验证	用户名	1000@wucb
	密码	123456
请求头	Content-Type	application/json
请求体	{"cmd":"agentbusy"}

请求参数说明

cmd	String	是	固定值：agentbusy
busydescr	int	否	值为admin配置的忙碌类型的id 默认值0

响应示例

{    
    "code": 0,    
    "message": "success",    
    "data": {
        "agentKey":"1001@wucb",
        "message": {
            "reason":"示忙成功",
            "agentkey":"1001@wucb",
            "type":"agentbusy",
            "status":0
    }
}}

响应包体

code	Integer	必选	返回码 0表示请求成功
message	String	必选	结果消息
data	Object	必选	返回结果
\|--agentKey	String	必选	坐席的唯一标识
\|-- message	Object	必选	操作的详细结果
\|--\|--status	integer	必选	0表示操作成功
\|--\|--type	String	必选	当前坐席的状态

3.3.5 操作异常情况说明（同步）

参数	类型	是否必须	备注
code	integer	是	错误码
message	String	是	错误提示

响应示例

{ 
    "code": 6, 
    "message": "回调信息获取失败!请稍后重试."
}