华为云用户手册

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 callid string False 呼叫ID。 2 calldata string False 随路数据。原始内容最大长度支持16K字节。 说明： 该信息采用AES128-CBC加密存储，采用TLS1.2加密通道传输。 该字段为敏感数据，日志中只使用calldatalength表示该字段长度。 3 isDataEncoded boolean False 呼叫数据是否经过base64编码，取值如下： true：calldata必须是经过base64编码后的字符。 false：calldata未经过base64编码。 默认值为false。 说明： Base64是一种编码方式，不是加密算法，不能用作任何敏感信息的加密用途。

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 查询成功后，返回呼叫保持列表对象。 该对象的参数说明请参见表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 未使用该返回参数 3.7 orgicallednum string 未使用该返回参数 3.8 calldata string 未使用该返回参数 3.9 begintime long 未使用该返回参数 3.10 endtime long 未使用该返回参数

报文样例 消息头 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", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null }, { "callfeature": 7, "callid": "1501127920-0", "caller": "10086", "called": "70941", "callskill": "", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null } ]}

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/holdlist 其中，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": "1476838963-224", "caller": "70004", "called": "60015", "callskill": "voice", "callskillid": 20011, "orgicallednum": "", "calldata": "", "begintime": 1476838963000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": { "waitBeginTime": 1626179227000, "waitEndTime": 1626179227000, "answerBeginTime": 1626179227000, "answerEndTime": 1626179227000, "talkBeginTime": 1626179227000, "talkEndTime": 1626179227000, "deviceNo": 2005, "deviceType": 2, "callDirectMode": "NORMAL_DIRECT", "enterReason": 0, "enterReasonDesc": "Normal reason", "leaveReason": 0, "leaveReasonDesc": "Normal reason", "vdnId": 214 } }}

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/callinfo?isNoContainLastCall={isNoContainLastCall} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号，{agentid}为座席工号。{isNoContainLastCall}表示当前座席无呼叫时，是否查询上一通呼叫信息（boolean型）。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 isNoContainLastCall boolean False 当前座席无呼叫时，是否查询上一通呼叫信息。取值范围： true：查询 false：不查询

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 查询成功后，返回呼叫信息对象。 该对象的参数说明请参见表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 呼叫轨迹扩展属性，请参见表5 表5 trace 对象参数说明 序号 名称 参数类型 说明 3.17.1 waitBeginTime long 等待开始时间，时间戳（毫秒） 3.17.2 waitEndTime long 等待结束时间，时间戳（毫秒），不支持查上一通的呼叫信息 3.17.3 answerBeginTime long 应答开始时间，时间戳（毫秒） 3.17.4 answerEndTime long 应答结束时间，时间戳（毫秒），不支持查上一通的呼叫信息 3.17.5 talkBeginTime long 谈话开始时间，时间戳（毫秒） 3.17.6 talkEndTime long 谈话结束时间，时间戳（毫秒），不支持查上一通的呼叫信息 3.17.7 deviceNo int 设备编号 3.17.8 deviceType int 设备类型。取值如下 1：呼叫队列 2：人工坐席 3：自动流程 4：会场资源 5：成对呼叫 6：座席队列 7：普通电话 3.17.9 callDirectMode string 此设备的处理方式，即离开设备的原因。取值如下 NORMAL_DIRECT：正常离开 KEEP_DIRECT：保持 WAIT_DIRECT：等待 RELEASE_DIRECT：释放 3.17.10 enterReason int 进入此设备的原因，参见表6 3.17.11 enterReasonDesc string 进入此设备的原因描述 3.17.12 leaveReason int 离开此设备的原因，参见表6，不支持查上一通的呼叫信息 3.17.13 leaveReasonDesc string 离开此设备的原因描述，不支持查上一通的呼叫信息 3.17.14 vdnId int VDN ID 表6 原因码 原因码 含义 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 空号 25 排队机无资源 26 用户不应答 27 被叫拒绝 28 成功转队列 29 三方转队列 30 成功转队列超时 31 三方转队列超时 34 超时/溢出/遇忙网呼失败排队 35 网呼回原中心排队 36 排队的呼叫重路由 37 由呼入路由进入 CDN 38 由座席咨询进入 CDN 39 CDN 正常返回路由结果 40 CDN 路由超时 41 咨询时座席取消 42 由 CDN 路由超时进入 PGR 43 由 CDN 正常返回路由进入 PGR 44 由呼入路由进入 PGR 45 由坐席咨询进入 PGR 46 坐席不可达，CDN 重路由 47 呼叫在多个队列排队 48 在从队列中接听主队列呼叫 50 座席拒绝呼叫 51 用户呼叫进入电话会议 52 会议主席主动释放会议，或 CSS 异常导致会议释放 53 与会者被请出会议 54 接通率低于阀值转接 88 座席接通后，用户挂机 89 座席应答后，用户挂机

报文样例 消息头 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}/callinfobeforeanswer 其中，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": [ "1456297722-1253", "1456297463-1249" ]}

报文样例 消息头 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。

报文样例 消息头 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": "" } ]}

接口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下面的座席。

响应说明 表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 呼叫技能描述

报文样例 消息头 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。

响应说明 表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 呼叫轨迹扩展属性，预留字段，默认为空。

报文样例 消息头 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 } ]}

接口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}/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}/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}/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。