座席操作类接口:onlineagent-华为云

云客服-座席签入平台接口:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 password string True 座席密码（最大长度为32，可为空）。 2 phonenum string False 座席电话（最大长度为24） 3 autoanswer boolean False 是否自动应答，默认为true。 4 autoenteridle boolean False 是否自动进入空闲态，默认为true。 5 releasephone boolean False 座席挂机后是否进入非长通态(呼叫结束后话机挂断)：默认为true。 6 agenttype int False 签入的座席类型，默认为4。4：pc+phone座席，11：pc+phone视频座席 7 status int False 签入后的状态，默认为空闲态。 3：示忙 4：空闲 5：整理态 8 ip string False 座席ip，默认127.0.0.1（最大长度为15），暂不支持IPV6 9 entryIp string False 座席客户端应用网关IP 10 phonelinkage boolean False 是否启动话机联动（接续和硬话机联动控制）。默认为false。 11 checkInWebm boolean False 是否签入Webm媒体服务器。默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。默认为false。

云客服座席操作类接口:onlineagent

云客服-座席签入平台接口:触发事件

触发事件如果签入时status参数设置3（示忙态），触发如下事件：座席开始执行签入动作（AgentOther_InService）示闲（AgentState_Ready）示忙成功（AgentState_SetNotReady_Success）如果签入时status参数设置4（空闲态），触发如下事件座席开始执行签入动作（AgentOther_InService）示闲（AgentState_Ready）如果签入时status参数设置5（整理态），触发如下事件：座席开始执行签入动作（AgentOther_InService）示闲（AgentState_Ready）工作中（AgentState_Work）

云客服座席操作类接口:onlineagent

云客服-座席签入平台接口:响应说明

响应说明表4 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result Map 查询成功后，返回结果信息的对象。该对象的参数说明请参见表5。表5 result对象参数说明序号名称参数类型说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。说明：如果为false有安全风险，请谨慎使用，建议使用true，表示下次登录必须修改密码。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。空字符串则表示座席密码永不过期。取值范围为0~180（天）。说明：空字符串有安全风险，请谨慎使用，建议设置取值范围内的值，保证定期修改密码。

云客服座席操作类接口:onlineagent

云客服-座席签入平台接口:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "password": "", "phonenum": "40038", "status": "4", "releasephone": "false", "agenttype": "4" } 响应参数 { "message": "", "retcode": "0", "result": { "vdnid": 1, "workno": "291", "mediatype": "TTF", "loginTime": "1471585949806", "isForceChange": "false", "serverName": "AgentGateway", "timeRemaining": "9" } }

云客服座席操作类接口:onlineagent

云客服-座席签入平台接口:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/loginex 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服座席操作类接口:onlineagent

云客服-签出:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/logout 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服座席操作类接口:onlineagent

云客服-获取当前座席的状态:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentstatus 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服座席操作类接口:onlineagent

云客服-获取当前座席的状态:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数无响应参数 { "message": "", "retcode": "0", "result": { "agentState": 4, "isWorking": false } }

云客服座席操作类接口:onlineagent

云客服-获取当前座席的状态:响应说明

响应说明表3 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result array 请参考表4 表4 座席状态信息序号名称参数类型说明 3.1 agentState int 座席状态。请参考表1 3.2 isWorking boolean false表示没有正在通话。 true表示正在通话。

云客服座席操作类接口:onlineagent

云客服-座席页面刷新时同步座席状态status和通话信息:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数无响应参数 { "result": { "callinfo": null, "agentStateInfo": { "callFeature": 0, "callData": "", "lastState": 255, "preBusy": false, "firsttalkingFlag": false, "workNo": "41001", "qcWorkNo": "", "callerNo": "", "beginHoldTime": null, "state": 1, "talkingCallfeature": 0, "releaseFlag": 0, "calledNo": "", "mainCallId": "", "secondTalkingTime": null, "preRest": false, "recordID": "", "currentTime": "1566636307992", "beginTalkingTime": null, "partner": "", "holdCallId": "", "agentStateBeginTime": 1566636286408, "curCommand": 0, "curCallId": "", "cmdBeginTime": "" } }, "message": "success", "retcode": "0" }

云客服座席操作类接口:onlineagent

云客服-座席页面刷新时同步座席状态status和通话信息:响应说明

响应说明表3 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result object 查询成功后，返回结果信息的对象。该对象的参数说明请参见表4。表4 result对象参数说明序号名称参数类型说明 3.1 callinfo string 通话信息。 3.2 agentStateInfo object 座席状态信息，该对象的参数说明请参见表5。表5 agentStateInfo对象参数说明序号名称参数类型说明 3.2.1 callFeature int 呼叫原始类型。特征ID，详细见表6。 3.2.2 callData string 呼叫相关信息。 3.2.3 lastState int 座席最后的状态。 3.2.4 preBusy boolean 是否示忙。 3.2.5 firsttalkingFlag boolean 是否第一次通话。 3.2.6 workNo string 座席工号。 3.2.7 qcWorkNo string qc座席工号。 3.2.8 callerNo string 主叫号码。 3.2.9 beginHoldTime string 开始保持时间，时间戳，单位：ms。 3.2.10 state int 座席状态。详细状态码和含义请参见表3。 3.2.11 talkingCallfeature int 通话呼叫原始类型，详细见表6。 3.2.12 releaseFlag int 会话是否释放。暂未使用。 3.2.13 calledNo string 被叫号码。 3.2.14 mainCallId string 首次发起呼叫的callid。 3.2.15 secondTalkingTime string 第二次通话时间，时间戳，单位：ms。 3.2.16 preRest boolean 是否休息。 3.2.17 recordID string 录音流水号。 3.2.18 currentTime string 当前时间，时间戳，单位：ms。 3.2.19 beginTalkingTime string 开始通话时间，时间戳，单位：ms。 3.2.20 partner string 合作伙伴。 3.2.21 holdCallId string 保持的呼叫callid 3.2.22 agentStateBeginTime string 座席状态开始时间，时间戳，单位：ms。 3.2.23 curCommand int 当前命令，详细含义见表7。 3.2.24 curCallId string 当前的呼叫callid。 3.2.25 cmdBeginTime string 命令开始时间，时间戳，单位：ms。表6 呼叫类型信息状态值说明 -1 其他。 0 普通呼入。 6 内部呼叫。 7 普通呼叫。 41 HPS预占式外呼。 44 HPS预测式外呼。 45 HPS预约回呼。 51 内部两方咨询。 52 内部三方咨询。 53 多方通话表7 操作命令信息状态值说明 0 无命令。 1 座席挂机。 2 座席断开连接。 3 用户挂机。 4 首次外呼。 5 外呼。 6 保持。 7 取消保持。 8 静音。 9 取消静音。 10 释放转。 11 成功转。 12 通话转。 13 三方转。 14 挂起转。 15 特殊转。 16 两方求助。 17 三方求助。 18 三方通话。 19 放音。 20 插入。 21 侦听。 22 切换。 23 拦截。 24 耳语。 30 示忙。 31 休息。

云客服座席操作类接口:onlineagent

云客服-座席页面刷新时同步座席状态status和通话信息:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/syncagentinfo 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服座席操作类接口:onlineagent

云客服-座席取消设置自定义状态:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/cancelsetcustomstate 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服座席操作类接口:onlineagent

云服务器内容精选

座席操作类接口:onlineagent

7*24

备案

专业服务

退订

建议反馈

售前咨询热线