华为云用户手册

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

录音开始 标示符 AgentMediaEvent_Record 作用 当前座席录音开始。 附带信息 taskId表示平台内部的录音任务号。 caller表示主叫号码。 called表示被叫号码。 locationId表示录音对应的中心节点ID。 recordID表示录音流水号。 fileName表示录音文件地址。 callId表示呼叫唯一标记。 fileMediaType表示媒体类型，1是音频，2视频。 示例： 音频： {"message":"","retcode":"0","event":{"eventType":"AgentMediaEvent_Record","workNo":"20011","content":{"taskId":5206,"caller":"70006","recordID":"Yc1v6a20011d20161025t1902050","called":"60015","locationId":"256","fileName":"Y:/6/0/20161025/20011/1902050.V3","fileMediaType":"1","callId":"1477393325-164"}}} RSE视频录制： {"eventType":"AgentMediaEvent_Record","workNo":"25002","content":{"recordID":"0a08082d-df1e-4c06-9a97-c7c6f7a4724e","callId":"1606459553-176","fileName":"conferenceId=7a008307-34ad-435b-bccd-222be5ac5385;recordId0=0a08082d-df1e-4c06-9a97-c7c6f7a4724e;","caller":"25002","called":"22061","locationId":"255","taskId":5065,"fileMediaType":2,"jsonKey":["recordID","callId","fileName","caller","called","locationId","taskId","fileMediaType"]},"jsonKey":["eventType","workNo","content"]} 第三方视频录制： {"eventType":"AgentMediaEvent_Record","workNo":"503","content":{"recordID":"Yc1v1a503d20201202t1714442.","callId":"1606900483-31","fileName":"Y:/1/0/20201202/503/1714442.mp4","caller":"83110091","called":"94865001","locationId":"65535","taskId":5007,"fileMediaType":2,"jsonKey":["recordID","callId","fileName","caller","called","locationId","taskId","fileMediaType"]},"jsonKey":["eventType","workNo","content"]} 父主题： 录音事件

音视频切换 标示符 AgentEvent_MediaSwith 作用 音频呼叫切换视频呼叫场景中，座席调用音视频切换接口，选择媒体类型为视频，调用成功后呼叫从音频切换到视频时，座席会收到该事件，reason为0时表示从IVR返回成功。 附带信息 reason表示切换原因码，0代表成功，其余为失败。 caller表示主叫号码。 called表示被叫号码。 callId表示呼叫唯一标记。 mediaType表示媒体类型。 示例： {"eventType":"AgentEvent_MediaSwith","workNo":"111","content":{"callid":"1603286369-16773","reason":0,"caller":"","mediaType":3,"called":"88022","jsonKey":["callid","reason","caller","mediaType","called"]},"jsonKey":["eventType","workNo","content"]} 父主题： 音视频通话事件

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

录音开始失败 标示符 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"}}} 父主题： 录音事件

停止录音成功 标示符 AgentMediaEvent_StopRecordDone 作用 座席停止录音成功。 附带信息 beginTime：录音开始时间。 endTime：录音结束时间。 taskId表示平台内部的录音任务号。 fileMediaType表示媒体类型，1是音频，2视频。 示例： {"eventType":"AgentMediaEvent_StopRecordDone","workNo":"1115","content":{"beginTime":1566867437000,"endTime":1566867472000,"fileMediaType":"1","taskId":5451,"jsonKey":["beginTime","endTime","taskId"]},"jsonKey":["eventType","workNo","content"]} 父主题： 录音事件

座席物理话机摘机 标示符 AgentOther_PhoneOffhook 作用 表示某个座席的物理话机已经摘机。 附带信息 type表示事件呼叫类型。unknown表示未知呼叫，main表示主呼叫，assistant表示协助呼叫。 示例： {"message":"","retcode":"0","event":{"eventType": "AgentOther_PhoneOffhook","workNo": "56020","content": {"type": "main"}}} 父主题： 物理话机事件

监视座席通知事件 表示符 QC_AgentState_Notify 作用 表示某个座席的监视（质检）事件。 附带信息 agentname：表示座席工号或用户名。 subtype：子类型，表示被监视座席的状态或操作。 示例： {"eventType":"QC_AgentState_Notify","workNo":"107","content":{"subtype":"QC_AgentState_Login","monitoredagent":"108","agentname":"108","mediaserver":"CtiServer","jsonKey":["subtype","monitoredagent","agentname","mediaserver"]},"jsonKey":["eventType","workNo","content"]} 其中subtype的类型有： QC_AgentState_Login:监视座席签入事件 QC_AgentState_Logout:监视座席签出事件。 父主题： 实时质检事件

容灾事件 标示符 Agent_Recover 作用 表示当前座席在CC-Gateway发生重启后容灾恢复完成。 附带信息 无。 示例： {"message":"","retcode":"0","event":{"eventType":"Agent_Recover","workNo":"49999","content":{"agentStatus":"4"}}} 收到该事件，表示CC-Gateway发生了异常切换，该切换过程中，当前呼叫的部分接口调用和事件有影响，对下一通来话无影响。 具体的影响场景有： 两方求助、三方求助 (求助到队列、座席、外部号码)，会缺少AgentEvent_Call_Release和AgentEvent_Customer_Release、AgentEvent_Talking等事件。 成功转、通话转、三方转等场景，缺少部分AgentEvent_Call_Release、AgentEvent_Customer_Release、AgentEvent_Talking、AgentEvent_Call_Release等事件。 恢复措施： 挂断座席电话（软电话、固话，或手机）。 座席手工签出，再签入。 父主题： 事件

座席签出成功 标示符 AgentOther_ShutdownService 作用 表示某个座席签出成功 附带信息 loginTime：登录时间。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentOther_ShutdownService","workNo":"49999","content":{"loginTime":"1471585949806"}}} 父主题： 其它座席相关事件

多媒体消息事件 标示符 AgentEvent_MessageData 作用 表示座席接收多媒体会话上行消息 附带信息 workNo：座席号。 content：消息对象，JSON格式。包含字段如下： callid：呼叫标示。 caller：主叫号码。 called：被叫号码。 feature：呼叫类型，例如0普通呼入，7普通外呼。 type：呼叫媒体类型，协助呼叫(assistant)和主呼叫(main)。 message：发送的消息内容。 mediaAbility：媒体能力，1表示语音，2表示视频，3表示音视频，5表示文字，6表示H5视频。 示例： {"eventType":"AgentEvent_MessageData","workNo":"211","content":{"callid":"1552038964-16797222","caller":"88880022","called":"20012","feature":0,"type":"main","message":"testmessage","mediaAbility":"5","jsonKey":["callid","caller","called","feature","type","message","mediaAbility"]},"jsonKey":["eventType","workNo","content"]} 父主题： 多媒体事件

座席状态说明 表1 CCGateway状态 状态值 说明 0 未知。对应CTI平台状态的9。 1 签入状态。未使用。 2 签出状态。对应CTI平台状态的0。 3 示忙状态。对应CTI平台状态的7。 4 空闲状态。对应CTI平台状态的1。 5 整理态。对应CTI平台状态的6。 6 同空闲态。未使用。 7 通话态。对应CTI平台状态的2、3、4、5。 8 休息状态。对应CTI平台状态的8。 9 预休息状态。 表2 CTI平台状态 值 说明 0 未签入状态 1 空闲状态 2 预占用状态 3 占用状态 4 应答状态 5 通话状态 6 事后调整 7 示忙状态 8 休息状态 9 学习状态 表3 座席状态表 值 说明 1 空闲状态 2 整理态 3 休息态 4 示忙 5 放音 6 外呼 7 占用 8 请求应答 9 通话态 10 3方通话 11 保持 12 静音 13 求助 14 通话转 15 插入 16 监听 17 耳语 255 异常状态 父主题： 附录

设备类型 表1 设备类型 类型编号 类型描述 1 技能队列 2 座席工号 3 IVR 表2 自定义设备类型 类型编号 类型描述 0 未知 1 普通电话 2 无线数字设备 3 无线模拟设备 4 短波 5 手机 6 座席 7 eLTE 表3 自定义设备呼叫类型 类型编号 类型描述 0 常规呼叫 1 组呼 2 秘密呼叫，即点呼 表4 转移模式说明 定义 含义 释放转 不管呼叫转移/转出是否成功，业务代表均释放呼叫 成功转 系统监视呼叫转移/转出过程，成功后业务代表才释放呼叫 通话转 系统监视呼叫转出过程，被叫应答并和业务代表通话，业务代表释放呼叫 三方转 系统监视转出过程，被叫应答后实现三方通话，业务代表释放呼叫 挂起转 将呼叫转移到某自动流程，该流程处理完呼叫后将呼叫转回原座席继续处理 父主题： 附录

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: {"id":"1307145259662215169","callType":"1","userId":"10gg000000y6OOrNaUFs","callerPresent":["12323"],"callNumber":["12323","232343","233","239343"],"callNumberDefault":"23232323","callerPresentDefault":"1212121212"} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"returnCode": "0","returnDesc": "update success.","id": "1307145259662215169"}

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 id String True 主键id。 创建App个人设置 (create)中响应体参数id的值。 2 callType string False 呼叫类型 0：直呼 1：双呼 2：透显呼叫 3 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。 4 callerPresent String[] False 被叫显示号码。 最多5个，多个号码之间以,隔开 每个号码长度限制：string（15） 5 callNumber String[] False 坐席软电话号码。 最多5个，多个号码之间以,隔开 每个号码长度限制：string（15） 6 callNumberDefault string False 默认坐席绑定的软电话号码。 长度限制：string（15） 7 callerPresentDefault string False 被叫默认显示号码。 长度限制：string（15）

报文样例 请求消息样例: POST /twopartiescall/statusnotify HTTP/1.1Request:AppKey: CMCCGX_0001X-Sdk-Date: 20210512T115430ZContent-Type: application/json;charset=UTF-8Host: 10.10.10.10:9003Authorization: SDK-HMAC-SHA256 Access=1BRBCTQ1BIK12F4J8Q5T, SignedHeaders=appkey;content-type;host;x-sdk-date, Signature=77c4f32ccc226ac4845f5a3c855c246d95462f48bcb4873e1d9ad9c1acc34b9b{"appKey": "CMCCGX_0001", "remark": "2022091800","telA": "15800000001","telX": "18463180497","telB": "15800000002","calleeDisplay": "15800000001","startTime": "20210512115422","callerAnswerTime": "20210512115422","calledAnswerTime": "20210512115422","finishTime": "20210512115430","callID": "cmccgx20210512195422","releaseCause": "1","callDuration": 8} 响应消息样例: HTTP/1.1 200 OK Date: Mon, 12 Nov 2007 15:55:01 GMT Content-Length: xxx Content-Type: application/json; charset=UTF-8 { }

响应说明 响应状态码: 200 收到消息后返回200 OK, 务必保证响应Content-Type为 application/json; charset=UTF-8 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 AppKey string False ITA侧的appKey字段，用户标识 2 Host string True 指定请求资源的Internet主机和端口号。 hostname：axb服务IP或域名 port：端口号。 HTTP默认端口号为XXXX，HTTPS默认端口号为XXXX。 说明： HTTP/1.1请求必须包含主机头域，否则系统会以400状态码返回。 3 Content-Type string True 用于指明发送给接收者(即服务器端)的实体正文的媒体类型。 4 X-Sdk-Date string True 发起请求的时间 5 Authorization string True 鉴权字段，具体鉴权说明请参见ITA文档 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callID string True 呼叫唯一标识，下载录音文件使用 2 remark string True 来自发起呼叫时的标注。预留字段（当前信息为租间ID） 3 startTime string False 发起呼叫时间，精确到秒 格式YYYYMMDDHHmmss 4 finishTime string False 通话结束时间 5 callDuration string False 通话时长，单位秒，供参考。 以双方通话建立开始计算 6 callerAnswerTime string False 主叫应答时间 7 calledAnswerTime string False 被叫应答时间 8 releaseCause string False 呼叫结束事件携带，原因值 9 appKey string False 客户分配资源标识 10 telA string False 原主叫号码 11 telX string False 落地业务号码 12 telB string False 原被叫号码 13 calledDisplay string False 被叫号显号码

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: {"callType":"1","userId":"10gg000000y6OOrNaUFs","callerPresent":["12323","232232","12323","12323"],"callNumber":["12323","232343","233","232343"],"callNumberDefault":"23232323","callerPresentDefault":"1212121212"} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"returnCode": "0","returnDesc": "The AgentSettings created successfully.","id": "1307145259662215169"}

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

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callType string False 呼叫类型 0：直呼 1：双呼 2：透显呼叫 2 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。 3 callerPresent String[] False 被叫显示号码。 最多5个，多个号码之间以,隔开 每个号码长度限制：string（15） 4 callNumber String[] False 坐席软电话号码。 最多5个，多个号码之间以,隔开 每个号码长度限制：string（15） 5 callNumberDefault string False 默认坐席绑定的软电话号码。 长度限制：string（15） 6 callerPresentDefault string False 被叫默认显示号码。 长度限制：string（15）

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

请求消息 消息头 表1 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 消息体 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 serverId string True CTI平台已存在的订阅任务的编号，也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

请求消息 消息头 表1 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 消息体 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 subscribeType string True 订阅类型。 1：识别。 其他保留。 2 serviceToken string False 鉴权token，第三方业务负责生成，例如：3320EA********************36ED638 最大长度256字符。 在后续调用握手(扩展)和识别结果通知接口时，需要传递该参数。 3 serviceCallBackUri string True 事件通知回调地址。 最大长度200字符。 4 nlpFlag boolean 必填 是否使用语义智能分析，取值范围： true：使用语义智能分析，需要联系运维人员在CC-Gateway的basic.properties文件中配置CC-Gateway回调地址 false：不使用语义智能分析 5 flowAccessCode string 选填 智能IVR机器人接入码，新增机器人时返回的接入码。仅当nlpFlag设置为true时需要配置。

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

响应消息 表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平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

请求消息 消息头 表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 选填 流程接入码