华为云用户手册

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

响应说明 响应状态码: 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 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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字段。

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 请参考表4 表4 会议ID数组 序号 名称 参数类型 说明 3.1 confIds array 会议ID数组

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

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 只有失败时，才返回该参数。请参考表5 表5 放音失败原因 序号 名称 参数类型 说明 3.1 errorReason int 放音失败时透传排队机侧返回的失败原因码。

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/playvoicetoparticipant 其中，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 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识。 最大长度为24字节。 3 playMode int False 放音模式。 2：播放指定文件音。 默认值为2。 4 voicePath voicePath True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 最大长度为127个字符。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "2002", "addressType": "9", "playMode": 2, "voicePath": "y:/conf/120/1136287.V3"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "88887946", "addressType": "6", "playMode": 2, "voicePath": "y:/conf/120/1136287.V3"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/holdparticipant 其中，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 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识。 最大长度为24字节。 3 playMode int False 放音模式。 2：播放指定文件音。 默认值为2。 4 voicePath String True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 最大长度为127个字符。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 userType string True 用户类型。 默认为“agent”代表座席 2 callid string True 呼叫标识。

接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/getconnectinfo 其中，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 请求参数 {"callid":"1552524689-16797284","userType":"agent"} 响应参数 {"message": "success","retcode": "0","result":{ "userId": "坐席工号", "ctime": "过期时间", "channelId": "15945185-345", "appId": "8345234631", "ip": "xxx.xxx.xxx.xxx", "port": "6500", "role": "0", "signalingDomainIn": "https: //in.isdpdomain.com", "signalingDomainOut": "https: //out.isdpdomain.com", "locationId": "65535", "signature": "xxx", "appId": "sdcp0BPcVGymItWppGX6XqrZGTCYa13d" }}

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 retcode string 消息发送结果。 0：成功 非0：失败 2 message string 描述 3 result object 查询成功后，返回连接信息对象。 该对象的参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 1 userId string 坐席工号 2 ctime string 过期时间 3 channelId string 频道ID（房间ID） 4 role string 角色 5 ip string 媒体服务器接入点IP地址 6 port string 媒体服务器接入点端口 7 signalingDomainIn string 内侧信令domain； 格式：https:// 域名 :端口 8 signalingDomainOut string 外侧信令domain； 格式：https://域名:端口 9 locationId string 节点 10 signature string 签名 11 appId string 用户标识

请求说明 消息头 表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 True 呼叫标识。 2 caller string False 主叫号码。 3 devicetype int True 转出的设备类型。 1：技能队列 2：座席 4：系统接入码 4 mode int True 转出的模式，详细释义见表4。 当devicetype值为1时取值： 0：释放转 2：成功转 当devicetype值为2时取值： 0：释放转。 2：成功转。 当devicetype值为4时取值： 0：释放转。 2：成功转。 5 address string True 转移地址，即转移设备类型对应的设备ID。最大长度24。 当devicetype为1时，此处为技能队列编号；当devicetype为2时，此处为座席平台工号；当devicetype为4时，此处为系统接入码。 6 calldata string False 携带数据给转接的座席，最大不能超过2048个字节。 7 skillId Integer 可选 技能ID。当devicetype为业务代表为2时，设置该字段才有效。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid": "1552524689-16797284", "caller": "88880021", "devicetype": 2, "mode": 2, "address": "205", "calldata": "help"} 响应参数 { "message": "success", "retcode": "0"}

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

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

响应说明 表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 } ]}

停止录音成功 标示符 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"]} 父主题： 录音事件

监视座席通知事件 表示符 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:监视座席签出事件。 父主题： 实时质检事件

音视频切换 标示符 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"]} 父主题： 音视频通话事件

从IVR返回 标示符 AgentEvent_ReturnFromIvr 作用 音视频呼叫的转移场景中，座席调用转移接口，选择转移设备类型为IVR，转移模式为挂起转进行呼叫转移，转移成功后呼叫从IVR返回到座席时，座席会收到该事件表示从IVR返回成功。 附带信息 content：文本型，呼叫所属于的CallId（呼叫标示）。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_ReturnFromIvr","workNo":"108","content":"1529571145-1187"}}} 父主题： 音视频通话事件

请求说明 表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的值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 id string False 主键id 2 callType string False 呼叫类型 0：直呼 1：双呼 2：透显呼叫 3 callerPresent String[] False 被叫显示号码。 最多5个，多个号码之间以，隔开 每个号码长度限制：string（15） 4 callNumber String[] False 坐席软电话号码。 最多5个，多个号码之间以，隔开 每个号码长度限制：string（15） 5 userId String False 用户id t_aicc_pub_appcube_user表中SUM_USER_ID的值。 6 callNumberDefault String False 默认坐席绑定的软电话号码。 长度限制：string（15） 7 callerPresentDefault String False 被叫默认显示号码。 长度限制：string（15） 8 agentName String False 坐席绑定的业务帐号。 9 returnCode string True 0：成功 其他值表示失败 10 returnDesc string False 响应结果描述。 11 createTime string False 配置创建时间 12 partdbId string False 分区id 13 tenantId string False 租间id 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。