华为云用户手册

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

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 callSerialno string False 呼叫流水号 2 countId string False 账号 3 callId string False 呼叫ID 4 mediaAbility number False 媒体类别：1: 语音 2:视频 5 channelType number False 多媒体渠道 6 talkReason string False 会话原因ID 7 beginTime timestamp False 开始时间 8 callType number False 呼叫类型 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

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

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 请参考表5 表5 会议信息 序号 名称 参数类型 说明 3.1 confId long 会议id 3.2 confState int 会议状态。 0：正常会议通话。 1：会场放音 3.3 startTime long 会议开始时间，时间戳（毫秒） 3.4 applyConfTime int 申请会议时长，单位分钟 3.5 confHaveBeenTime int 会议已进行时长，单位分钟 3.6 addresses array 与会者列表，请参考表6 表6 与会者信息 序号 名称 参数类型 说明 3.6.1 addressType String 3地址类型。 6：电话号码 9：座席工号 3.6.2 address String 地址标识。 3.6.3 deviceCallType int 自定义的设备呼叫类型，详细见表3。 3.6.4 deviceType int 自定义的设备类型，详细见表2。 3.6.5 channelAttrib int 会议属性。 1：只听。 2：只说。 3：听说。 3.6.6 channelState int 会议通道状态。 0：正常会议通话中。 1：保持。 2：放音。 3.6.7 role int 会议角色。 0：与会者。 1：主席。 3.6.8 enterTime long 加入会议的时间，时间戳（毫秒）

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/queryconfinfos 其中，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 请求参数 { "confIds": [ 1029888, 1029889 ]} 响应参数 { "message": "", "retcode": "0", "result": { "confs": [ { "confId": 1029888, "confState": 0, "startTime": 1475745454000, "applyConfTime": 60, "confHaveBeenTime": 29, "addresses": [ { "addressType": "6", "address": "70005", "deviceCallType": 0, "deviceType": 0, "channelAttrib": 3, "channelState": 0, "role": 0, "enterTime": 1475745464000 }, { "addressType": "9", "address": "153", "deviceCallType": 0, "deviceType": 6, "channelAttrib": 3, "channelState": 0, "role": 1, "enterTime": 1475745454000 } ] } ] }}

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 modifyType int True 申请变更的类型。 0表示增加。 1表示减少。 2 modifyNum int True 申请变更的数目。 取值范围为2-118。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/modifyconfresource 其中，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 请求参数 { "modifyType": 0, "modifyNum": 3} 响应参数 { "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 destAgentNo int True 待转移的目标座席工号。

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

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

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 mediaType string True 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 51：多媒体Web Chat 53：Social Chat 说明： 待修改的媒体类型需要与座席签入的技能队列类型相同。 2 callnums string True 座席最大会话数，最大值：60，最小值：1。

接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/setcallnums 其中，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 请求参数 { "mediaType": "53", "callnums": "1"} 响应参数 { "message": "success", "retcode": "0"}

咨询失败 标示符 AgentEvent_Consult_Fail 作用 座席内部求助咨询失败。 附带信息 content：文本型，呼叫所属于的CallId（呼叫标示）。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Consult_Fail","workNo":"49999","content":"1456404043-39"}} 父主题： 音视频通话事件

新预览外呼 标示符 AgentEvent_Preview_CallOut_Ex 作用 座席接收到新预览外呼（预览呼出的电话号码长度是120）。 附带信息 controlid：预览呼出控制块号。 dialeddigits：预览呼出被叫号码。 callData：随路数据，最大长度16k。 示例： { "message":"", "retcode":"0", "event": {"eventType":"AgentEvent_Preview_CallOut_Ex", "workNo":"49999", content:{ "dialeddigits":"100,101,103,105", "controlid":"1536", "callData":"4" } } } 父主题： 外呼相关

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

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

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

请求说明 表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）

报文样例 请求头: 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"}

报文样例 请求头: x-app-key:6******************************b Authorization:Bearer e******************************6 Content-Type:application/json 请求参数: {"callSerialNo": "679218118865715226"} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"retMsg": "success","result": {"url": "https://aicc-obs0.obs.cn-south-1.myhuaweicloud.com:443/644429155876552705?AWSAccessKeyId=ZGUZVMUDBS2DKAQ5X141&Expires=1565681851&Signature=sb3ZDPyzg%2FXZLMIPK0zBTRA6x5s%3D"},"retCode": "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：已废弃 32：配置业务代表 33：配置技能 34：不可填写外呼主叫 35：配置审计 父主题： 订阅 语音识别 结果接口

报文样例 请求头: x-app-key:9******************************3Authorization:Bearer 9******************************7Content-Type:application/json 请求参数: { "caller": 8888888,"softPhone": 66666666, "called": 6666614} 响应参数: {"retMsg": "Called is not configured","retCode": "5"}

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 caller string False 主叫号码，客户经理手机号码，或是软电话号码 长度限制：string（32） 1.2 softPhone string True 软电话号码（座席对应） 长度限制：string（32） 1.3 called string True 被叫号码 长度限制：string（32） 1.4 callData string False 呼叫数据 长度限制：string（1024） 说明： ITA双呼不支持callData字段。 1.5 callerPresent string False 用户侧主叫显示号码，用户看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。 说明： ITA双呼不支持callerPresent字段。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string False 0：成功，其他为失败 1 ：添加外呼任务失败，外呼数据库中可能已存在相同外呼任务 2 ：呼叫数据信息 3 ：未查询出呼叫流水号字段 5 ：主被叫或外显号码格式不符 6 ：VDN不可用 8 ：主叫号码不在租户所分配的移动座席使用的软电话号码范围内 16 ：试用租户的座席侧号码未在白名单内 21 ：试用租户一键双呼超过每天10次限制 针对ITA双呼还有一些retCode，请参见表4 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string False 呼叫流水号 表4 针对ITA双呼的retcode说明 retcode retMsg 说明 90100100 Invalid Input Parameter 请求报文不正确。如缺少参数或者不支持的参数 90100200 Auth Failed 请求的来源或者请求的签名未通过校验 90100300 Bad Request 错误请求 90100400 Not found 请求资源不存在 90100600 Internal Server Error 系统内部错误 90102001 Insufficient Balance 额度不足 90102002 Request Restriction 请求限制 90104001 Insufficient Permission 权限不足 90104003 Request Forbidden 请求被禁止 90104004 Service Unavailable 不支持的业务功能或者未实现 90104008 Service Process Failure 业务处理超时或者处理失败 90104029 Too Many Requests 请求过多 90106001 Binding relationship already exists 小号绑定关系已存在 90106002 Binding relationship not exists 小号绑定关系不存在 90106003 Insufficient Number resources 小号号码池资源不足 90106004 No corresponding number found 未找到可用小号 90106005 Inconsistent binding data 小号绑定数据不一致 90106006 Other Error 小号其他原因导致错误 90106010 Policy Forbid 策略禁止 90106011 Caller Forbid 主叫限制 90106012 Callee forbid 被叫限制 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

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

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