华为云用户手册

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 workNo number True 座席工号

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

响应说明 表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 座席应答后，用户挂机

接口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 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 呼叫轨迹扩展属性，预留字段，默认为空。

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

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/rejectagentconf 其中，ip为agentgateway服务器地址，port为agentgateway服务器的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" ]}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 1：查询状态失败 3：呼叫流水号格式不符 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 state number False 呼叫状态： 0：待呼叫 1：正在呼叫 2：通话中 3：通话结束 长度限制：number（1） 1.3.2 reasonCode number False 通话结束原因码： 0~65535， 0: 通话结束，被叫挂机 1：通话结束，主叫挂机 2：外呼主叫失败 3：外部被叫失败 4：外呼主叫无应答 5：外呼被叫无应答 6：启动呼叫失败 xxx：其他异常 长度限制：number（5） 针对ITA双呼还有一些reasonCode，请参见表4 1.3.3 callData string False 第三方自定义的呼叫数据信息 长度限制：string（1024） 1.3.4 caller string False 主叫号码 长度限制：string（32） 1.3.5 called string False 被叫号码 长度限制：string（32） 1.3.6 startTime string False 外呼开始时间，时间戳，如1572794607000 1.3.7 endTime string False 通话结束时间，时间戳，如1572794607000 1.3.8 callerPresent string False 外显号码，来电显示的号码 长度限制：string（32） 1.3.9 agentPresent string False 外显号码，客户经理来电显示的号码 表4 针对ITA双呼的reasonCode说明 retCode 原因值描述 0 不涉及 1 无法找到号码 2 无法路由到网络 3 无法路由到目的地 4 发送特殊消息 5 中继前缀出错 6 通道无法接入 7 已经建立频道 8 抢先占有 9 抢先占有保留 16 正常呼叫清除 17 用户忙 18 无应答 19 无用户应答 20 用户不可及 21 拒绝呼叫 22 号码已改变 23 重定向 25 交换路由错误 26 无用户准许 27 目标无序 28 非法号码格式 29 设备拒绝 30 状态查询 31 正常 34 路由不可达 38 网络状态不好 39 服务链接不上 40 链接进行中 41 暂时失败 42 设备拥塞 43 信息丢弃 44 通道无法接入 46 呼叫阻塞 47 无可用资源 49 品质无效 50 设备没预订 53 闭合群OCB呼出受限 55 闭合群ICB呼入受限 57 无权限发送 58 发送无效 62 等级不一致 63 服务无效 65 发送无法执行 66 通道无法执行 69 设备无效 70 发送有效 79 CV服务没设置 81 引用非法值 82 通道不存在 83 ID不存在 84 呼叫ID不存在 85 无呼叫等待 86 隐藏号码呼叫 87 CUG无成员 88 目标冲突 90 CUG不存在 91 无效网络 95 无效信息 96 非托管元素 97 类型不存在 98 信息没执行 99 信息单元不存在 100 无效的信息单元 101 呼叫状态不一致 102 定时器超时 103 参数不存在 110 消息中带有未识别的参数 111 协议错误 127 未指定的交互 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: {"callSerialNo": "645735364434067472"} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"retMsg": "Query call state successfully","retCode": "0","result": {"caller": "88889050","called": "88889060","callerPresent": "640003","startTime": 1621823865000,"state": 3,"reasonCode": 0,"agentPresent": "640060","endTime": 1621823872000}}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callSerialNo string True 呼叫流水号 长度限制：string（50）

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 1：查询失败 2：移动座席信息为空 3：注册服务地址或端口为空 4：limit或offset分页数据为空 5：虚拟呼叫中心信息为空 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 total number False 总记录数 1.3.2 singleRegServ array[object] False single模式 1.3.2.1 regIPAddress string False 注册地址 长度限制：string（50） 1.3.2.2 regPort string False 注册端口 长度限制：number（5） 1.3.2.3 sipServicePort string False 软电话注册端口 长度限制：number（5） 1.3.2.4 sipServiceIp string False 软电话注册地址 长度限制：string（50） 1.3.3 poolRegServ object False pool模式 1.3.3.1 node1 array[object] False 节点1 1.3.3.1.1 regIPAddress string False 注册地址 长度限制：string（50） 1.3.3.1.2 regPort string False 注册端口 长度限制：number（5） 1.3.3.1.3 sipServicePort string False 软电话注册端口 长度限制：number（5） 1.3.3.1.4 sipServiceIp string False 软电话注册地址 长度限制：string（50） 1.3.3.2 node2 array[object] False 节点2 1.3.3.2.1 regIPAddress string False 注册地址 长度限制：string（50） 1.3.3.2.2 regPort string False 注册端口 长度限制：number（5） 1.3.3.2.3 sipServicePort string False 软电话注册端口 长度限制：number（5） 1.3.3.2.4 sipServiceIp string False 软电话注册地址 长度限制：string（50） 1.3.4 phone array[object] False 软电话信息列表 1.3.4.1 phoneNum string False 软电话号码 长度限制：string（32） 1.3.4.2 password string False 软电话密码 长度限制：string（50） 1.3.4.3 id number False 配置信息Id 1.3.4.4 status number False 注册状态，0：已注册，1：暂停状态 1.3.4.5 remark string False 备注信息 1.3.4.6 tenantId string False 租间id 1.3.4.7 partdbId string False 分区id 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: x-app-key:2******************************8 Authorization:Bearer e******************************5 Content-Type:application/json 请求参数: {"offset": "0","limit": "3"} 响应参数: {"retMsg": "successfully","retCode": "0","result": {"total": 2,"regPort": "5060","phone": [{"phoneNum": "88881196","password": "****"}, {"phoneNum": "88881197","password": "****"}],"regIPAddress": "10.162.98.43"}}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 limit string False 分页查询时单页最多的记录条数，默认值100，即每页显示100条，非必选 limit的值大于100则查询100条记录。 limit的值小于1则查询1条记录。 1 offset string False 分页查询偏移量，默认值0，即不需要偏移，非必选

请求消息 消息头 表2 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 serviceCallBackUri string True 事件通知回调地址。 最大长度200。 2 nlpFlag boolean 必填 是否语义智能分析 3 flowAccessCode string 选填 流程接入码

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "serviceCallBackUri": "https://10.10.10.1:8080/rest/cc-ai/nlrresult", "nlpFlag": "true", "flowAccessCode": "801166010768953344"} 响应参数 { "message": "success", "retcode": "0"}

响应消息 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 返回消息 2 retcode string 操作的结果原因码。 取值类型为整数。 0：成功 非0：失败，具体见“错误码定义”章节 3 result object 返回结果。该对象参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 3.1 serverId string 业务客户端向CTI平台发起订阅注册请求且成功注册后，CTI平台返回的订阅任务编号。

接口URI https://IP:Port/agentgateway/resource/config/subscribe/modify?serverId=xxx 表1 URI携带的参数说明 序号 名称 参数类型 是否必选 说明 1 serverId string True CTI平台已存在的订阅任务的编号，也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

接口URI https://IP:Port/agentgateway/resource/config/subscribe/handshake/{serviceid} 表1 URI携带的参数说明 序号 名称 参数类型 是否必选 说明 1 serverid string True CTI平台已存在的订阅任务的编号，也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 returnCode string True 0：成功 其他值表示失败 2 returnDesc string False 响应结果描述。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: {"userId": "10gg000000y6OOrNaUFs"} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"returnCode": "0","returnDesc": "The AgentSettings delete successfully."}

请求消息 消息头 表2 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 3 service_token string True 鉴权token，通过订阅生成，例如：3320EA1E5E**********************7112A68E336ED638 最大长度256。

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

预览发起 标示符 AgentEvent_Preview 作用 座席接收到预览发起。 附带信息 controlid：预览呼出控制块号。 dialeddigits：预览呼出被叫号码。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Preview","workNo":"49999","content":{"controlid":"1456404043","dialeddigits":""}}} 父主题： 外呼相关

外呼失败检测失败原因 标示符 OUTBOUND_DETECT_EVENT 作用 座席接收到外呼失败原因码，以及失败原因。 附带信息 callid：呼叫标识。 detect：外呼失败原因码。准确度依赖于核心网，或对接网关返回信令中的原因码，详情请参见表3。 desc：外呼失败原因描述。 示例： {"message":"success","event":{"eventType":"OUTBOUND_DETECT_EVENT","workNo":"464","content":{"callId":"1589167025-134428","detect":1552,"desc":"The calling number is not allowed to make a call."}},"retcode":"0"} 父主题： 音视频通话事件

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。

座席久不应答 标示符 AgentEvent_No_Answer 作用 座席久不应答，呼叫挂断通知事件。 附带信息 content：呼叫的CallID。 触发条件 通知座席对于手工应答的呼叫请求，已经挂断。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_No_Answer","workNo":"49999","content":"1456403745-23"}} 父主题： 音视频通话事件

录音开始失败 标示符 AgentMediaEvent_Record_Fail 作用 当前座席录音开始失败。 附带信息 taskId表示平台内部的录音任务号。 caller表示主叫号码。 called表示被叫号码。 locationId表示录音对应的中心节点ID。 recordID表示录音流水号。 fileName表示录音文件地址。 callId表示呼叫唯一标记。 fileMediaType表示媒体类型，1是音频，2视频。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentMediaEvent_Record_Fail","workNo":"20011","content":{"taskId":5255,"caller":"70006","recordID":"Cc1v6a20011d20161025t1930326","called":"60015","locationId":"65535","fileName":"C:/6/0/20161025/20011/1930326.V3","fileMediaType":"1","callId":"1477395030-183"}}} 父主题： 录音事件

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

录音播放停止 标示符 AgentMediaEvent_StopPlayDone 作用 录音被停止播放。 附带信息 cause表示停止播放的原因。0：正常播放结束；1：座席主动停止播放；2：录音播放失败而停止播放。 示例 {"message":"","retcode":"0","event":{"eventType":"AgentMediaEvent_StopPlayDone","workNo":"49999","content":{"cause":0}}} 父主题： 质检放音事件