华为云用户手册

云客服-强制签入:接口URI

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

云客服
云客服-重置技能队列:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/resetskill/{autoflag}?skillid={skillid}&phonelinkage={phonelinkage} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 autoflag boolean True 是否签入所有技能队列的标志，取值范围： true：自动签入座席所配置技能 false：签入指定的技能队列 true以外的参数值都作为false处理。 3 skillid string False 技能队列ID。当签入方式{autoflag}为false时，skillid如果为空则不签入任何技能队列；skillid为技能队列ID字符串组，例如1;2;3，最大长度为4000。座席签入的技能队列为此skillid和所配置技能队列的交集。 4 phonelinkage int False 是否话机联动，接续和硬话机联动控制。取值范围： 1：是 0：否目前仅支持CC组网下的espace 7910 话机。

云客服
云客服-示忙:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/saybusy?reason={reason}&prolong={false} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号名称参数类型是否必选说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 reason int False 示忙原因码。为空或者等于0时，表示无示忙原因码。取值类型为整数，取值范围为200～250。座席示忙状态下再次示忙时此参数必选。 3 prolong boolean False 已示忙状态下是否重新设置示忙原因，取值true/false，默认值false。座席示忙状态下再次示忙时此参数必选。

云客服
云客服-修改密码(扩展):报文样例

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

云客服
云客服-修改密码(扩展):请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 oldPassword string True 旧密码，长度最小8位，最大32位。 2 newPassword string True 新密码，长度最小8位，最大32位。

云客服
云客服-修改密码(扩展):接口URI

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

云客服
云客服-强制签出:接口URI

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

云客服
云客服-签出:接口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。

云客服
云客服-强制签出带原因码:接口URI

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

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

响应说明表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表示正在通话。

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

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

云客服
云客服-设置是否接听来话:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/settalkright?flag={flag} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号，{agentid}为座席工号，{flag}为表示是否接听来话（1表示接听来话，0表示不接听来话）。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 flag int True 是否接听来话，取值范围： 1：表示接听来话 0：表示不接听来话

云客服
云客服-获取当前座席的状态:接口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。

云客服
云客服-座席页面刷新时主动请求更新Guid:报文样例

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

云客服
云客服-座席页面刷新时主动请求更新Guid:接口URI

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

云客服
云客服-座席页面刷新时主动请求更新Guid:响应说明

响应说明表3 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result object 查询成功后，返回结果信息的对象。该对象的参数说明请参见表4。表4 result对象参数说明序号名称参数类型说明 3.1 guid string 每个配置用户登录后获得唯一的Guid标识

云客服
云客服-呼叫应答:接口URI

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/answer?{callid=XXXX} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 callid string False 呼叫ID，在多媒体通话时会有多个callid存在，呼叫应答需要携带callid。

云客服
云客服-普通外呼:接口URI

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

云客服
云客服-普通外呼:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "caller": "40038", "called": "40040", "skillid": 25, "callappdata": "", "mediaability": 1} 响应参数 { "message": "", "retcode": "0", "result": "1455885056-1095"}

云客服
云客服-普通外呼:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 caller string False 主叫号码。内容可为空，为空时为平台默认主叫号码，0-24位数字 2 called string True 被叫号码。内容不可为空，1-24位数字或*或# 3 skillid int False 技能ID。数字类型，内容可为空，为空时为平台配置默认的技能队列ID。 4 callappdata string False 随路数据信息。可为空，最大长度为16k。 5 mediaability int False 媒体能力，默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。说明：视频呼音频，接听后会导致通话直接挂断，原因是媒体协商失败，推荐视频外呼时，mediaability配置为2，以最大能力呼叫。

云客服
云客服-普通外呼:触发事件

触发事件物理话机振铃（AgentOther_PhoneAlerting）物理话机摘机（AgentOther_PhoneOffhook）座席忙中（AgentState_Busy）对方振铃（AgentEvent_Customer_Alerting）座席进入Talking（AgentEvent_Talking）外呼失败（AgentEvent_Call_Out_Fail）外呼失败检测失败原因事件（OUTBOUND_DETECT_EVENT）

云客服
云客服-座席签入平台接口:接口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。

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

请求说明消息头表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。

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

响应说明表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（天）。说明：空字符串有安全风险，请谨慎使用，建议设置取值范围内的值，保证定期修改密码。

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

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

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

报文样例消息头 Content-Type:application/json; charset=UTF-8Guid：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" }}

云客服
云客服-预览外呼:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 called string True 被叫号码。called必须包含在预览事件的dialeddigits字段中，不在此字段中的号码，不能呼叫。 2 callcontrolid long True 预呼控制块号。callcontrolid是预览外呼事件中的controllid。

云客服
云客服-静音:接口URI

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

云客服
云客服-预览外呼:接口URI

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

云客服
云客服-预览外呼:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "called": "88889039", "callcontrolid": "11776"} 响应参数 { "message": "", "retcode": "0", "result": "1455885056-1095"}

云客服

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线