华为云用户手册

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "callfeature": 0, "callid": "1476070409-38", "caller": "70001", "called": "10086", "callskill": "voice_jst", "callskillid": 3, "orgicallednum": "12345678", "calldata": "", "begintime": 1476070413000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null }}

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回呼叫信息对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型，请参考表1 3.2 callid string 呼叫ID 3.3 caller int 主叫号码 3.4 called int 被叫号码 3.5 callskill string 呼叫技能描述 3.6 callskillid int 呼叫技能ID 3.7 orgicallednum string 未使用该返回参数 3.8 calldata string 随路数据 3.9 begintime long 应答开始时间 3.10 endtime long 未使用该返回参数 3.11 userPriority int 客户优先级 3.12 trunkNo int 中继号 3.13 logontimes int 进入总时长 3.14 mediaType int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.15 mediaAbility int 媒体能力。其中： 1：音频 2：视频 3：音视频 3.16 waitTime long 等待应答时间，时间戳（秒） 3.17 trace HWCallDeviceTraceEx 呼叫轨迹扩展属性，预留字段，默认为空。

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回排队等待呼叫信息对象列表。 该对象的参数说明请参考表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型，请参考呼叫类型 3.2 callid string 呼叫ID 3.3 caller int 主叫号码 3.4 called int 被叫号码 3.5 callskill string 呼叫技能描述

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/holdlistex/{workno} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workno string True 待查询的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "callfeature": 7, "callid": "1501127996-2", "caller": "10086", "called": "70943", "callskill": "voice" }, { "callfeature": 7, "callid": "1501127920-0", "caller": "10086", "called": "70941", "callskill": "" } ]}

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "talktime": 4328, "answernums": 5, "noanswernums": 0, "calloutnums": 0, "intercallnums": 5, "interhelpnums": 0, "transfernums": 0, "transferoutnums": 0, "transferivrnums": 0, "redirectnums": 0, "keepnums": 0, "busynums": 0, "restnums": 0, "restoutnums": 0, "resttime": 0, "restouttime": 0, "agentrelease": 1, "busytime": 0 }}

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 查询成功后，返回座席当前呼叫统计信息对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 talktime long 本次签入后总通话时长，单位 s。 3.2 answernums int 本次签入后接听次数 3.3 noanswernums int 本次签入后久不应答次数 3.4 calloutnums int 本次签入后外呼次数 3.5 intercallnums int 本次签入后内部呼叫次数 3.6 interhelpnums int 本次签入后内部求助次数 3.7 transfernums int 本次签入后转接次数 3.8 transferoutnums int 本次签入后转出次数 3.9 transferivrnums int 本次签入后转IVR次数 3.10 redirectnums int 重定向的次数 3.11 keepnums int 保持次数 3.12 busynums int 示忙次数 3.13 restnums int 请假次数 3.14 restoutnums int 超假次数 3.15 resttime long 请假时长（秒） 3.16 restouttime long 超假时长（秒） 3.17 agentrelease int 主动释放数 3.18 busytime long 示忙时长（秒）

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/statistics 其中，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 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "callfeature": 0, "callid": "1476707884-279", "caller": "70004", "called": "60015", "callskill": "voice", "callskillid": 1, "orgicallednum": "", "calldata": "", "begintime": 1476707884000, "endtime": null, "userPriority": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null }, { "callfeature": 0, "callid": "1476707885-280", "caller": "70003", "called": "60015", "callskill": "voice", "callskillid": 1, "orgicallednum": "", "calldata": "", "begintime": 1476707885000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null } ]}

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回排队等待呼叫信息对象列表。 该对象的参数说明请参考表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型，请参考呼叫类型 3.2 callid string 呼叫ID 3.3 caller int 主叫号码 3.4 called int 被叫号码 3.5 callskill string 呼叫技能描述 3.6 callskillid int 呼叫技能ID 3.7 orgicallednum string 未使用该返回参数 3.8 calldata string 随路数据 3.9 begintime long 应答开始时间，时间戳（毫秒） 3.10 endtime long 未使用该返回参数 3.11 userPriority int 客户级别 3.12 trunkNo int 中继号 3.13 logontimes int 进入总时长（秒）。 3.14 mediaType int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.15 mediaAbility int 媒体能力。其中： 1：音频 2：视频 3：音视频 3.16 waitTime long 等待应答时间，时间戳（秒） 3.17 trace HWCallDeviceTraceEx 呼叫轨迹扩展属性，预留字段，默认为空。

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/waitcallinfo/{skillid} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 skillid int True 被查询技能队列ID。

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

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 workNo string False 指定的座席工号 2 skills array False 技能队列ID的数组，数组长度最大1000

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requestwhisperagent?whisperagentid={whisperagentid} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 whisperagentid string False 被质检耳语的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/switch/{workNo} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workNo string True 指定座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requeststopwhisperagent?whisperagentid={whisperagentid} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 whisperagentid string False 被质检耳语的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcerest/{workNo}/{time}/{reason} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workNo string True 指定座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。 3 time long True 休息时长，单位：秒，取值范围：1-86399。 4 reason int True 休息原因码，取值范围：1-255。

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requestswitchinsertwhisperagent?whisperagentid={whisperagentid}&switchtype={switchtype} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 whisperagentid string False 被质检耳语的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。 3 switchtype int True 切换类型，取值范围： 0：表示切换为侦听 1：表示切换为插入 2：表示切换为耳语

请求说明 消息头 表1 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 3 service_token string False 自定义，最大长度为50，不能包含特殊字符，否则会返回100-001，建议1分钟动态刷新一次。 消息体 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 workNo string True 座席工号。 2 eventList array True 事件列表。 该对象的参数说明请参见表3。 说明： 事件列表按照事件产生顺序，从左往右排列，最新的事件放在最右边。 表3 eventList对象参数说明 序号 名称 参数类型 说明 2.1 eventType string 事件类型。 2.2 workNo string 座席工号。 2.3 content object 事件内容。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1service_token:****************** 请求参数 { "workNo": "", "eventList": [ { "eventType": "", "workNo": "", "content": "" }, { "eventType": "", "workNo": "", "content": "" } ]} 响应参数 { "message": "success", "retcode": "0"}

示忙成功 标示符 AgentState_SetNotReady_Success 作用 表示某个座席示忙成功。 附带信息 reason表示请求示忙时传入示忙原因码，无示忙原因码时返回：0。为7时表示话务员拆线。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentState_SetNotReady_Success","workNo":"49997","content":{"reason":"200"}}} 父主题： 座席状态类事件

响应说明 表2 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 event object 座席事件对象 该对象的参数说明请参见表3。 表3 event对象参数说明 序号 名称 参数类型 说明 3.1 eventType string 事件类型，参考事件 3.2 workNo string 座席工号 3.3 content object 事件内容对象，根据不同的事件，其相关的定义也不同

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

场景描述 轮询方式获取单座席事件。 座席没有事件时，这个接口需要10s才会有返回，如果有事件，则立即返回。请参考配置agentgateway/WEB-INF/config/basic.properties。 AGENT_POLL_WAIT_FLAG = ON //是否等待事件，ON表示启动，没有事件时，10s后，服务端返回响应 AGENT_POLL_WAIT_TIMES = 100 // 没有事件时，最大等待100次 AGENT_POLL_WAIT_INTERVAL = 100 //每次等待时间，单位毫秒 注：业务在调用该接口时，等待请求响应后，间隔200ms~500ms，再次调用该接口获取事件。

座席进入Talking 标示符 AgentEvent_Talking 作用 表示某个座席进入Talking状态。 附带信息 called：被叫号码。 caller：主叫号码。 callid：呼叫标示。 type：呼叫媒体类型，协助呼叫(assistant)和主呼叫(main)。 feature：呼叫类型，请参考呼叫类型。 mediaAbility：媒体能力，1表示语音，3表示音视频，5表示文字，6表示H5视频。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Talking","workNo":"49999","content":{"caller":"10086","callid":"1456401416-3","called":"70092","feature":"7","type":"main","mediaAbility":"1"}}} 父主题： 音视频通话事件

休息超时提醒 标示符 AgentState_Rest_Timeout 作用 表示某个座席请求休息后已经超时，提醒用户超时信息（此事件为提醒，并不代表座席退出休息态）。 附带信息 无。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentState_Rest_Timeout","workNo":"49999","content":null}} 父主题： 座席状态类事件

休息成功 标示符 AgentState_SetRest_Success 作用 表示某个座席请求休息成功。 附带信息 无。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentState_SetRest_Success","workNo":"49999","content":{"reason":"200"}}} 父主题： 座席状态类事件

保持成功 标示符 AgentEvent_Hold 作用 表示当前座席已处于保持状态。 附带信息 content：文本型，呼叫所属于的CallId（呼叫标示）。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Hold","workNo":"49999","content":"1456402370-7"}} 父主题： 音视频通话事件

对方振铃 标示符 AgentEvent_Customer_Alerting 作用 表示座席相关的其它用户正在发生振铃。 附带信息 otherPhone: 字符串，振铃方的电话号码或者振铃座席的工号。 callid:呼叫标示。 type:呼叫类型，协助呼叫(assistant)和主呼叫(main)。 触发条件 准备通话的对方正在振铃。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Customer_Alerting","workNo":"49999","content":{"callid":"1456401416-3","otherPhoneWorkno":"","otherPhone":"70092","type":"main"}}} 父主题： 音视频通话事件