华为云用户手册

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 group_name string True 业务场景名称 1.2 description string False 业务场景描述 1.3 ignore_sensitive number False 是否要计算敏感词的扣分（0 代表计入，1 代表不计入，不传默认为0） 1.4 other object True 场景的通话过滤条件 1.4.1 call_end number False 通话结束时间，时间戳毫秒 1.4.2 call_from number False 通话起始时间，时间戳毫秒 1.5 interaction_type integer False 交互类型 0和不填表示语音 2表示多媒体

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result Map 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。 说明： 如果为false有安全风险，请谨慎使用，建议使用true，表示下次登录必须修改密码。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180（天）。 说明： 空字符串有安全风险，请谨慎使用，建议设置取值范围内的值，保证定期修改密码。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "password": "", "phonenum": "40038", "status": "4", "releasephone": "false", "agenttype": "4" } 响应参数 { "message": "", "retcode": "0", "result": { "vdnid": 1, "workno": "291", "mediatype": "TTF", "loginTime": "1471585949806", "isForceChange": "false", "serverName": "AgentGateway", "timeRemaining": "9" } }

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 password string True 座席密码（最大长度为32，可为空）。 2 phonenum string False 座席电话（最大长度为24） 3 autoanswer boolean False 是否自动应答，默认为true。 4 autoenteridle boolean False 是否自动进入空闲态，默认为true。 5 releasephone boolean False 座席挂机后是否进入非长通态(呼叫结束后话机挂断)：默认为true。 6 agenttype int False 签入的座席类型，默认为4。4：pc+phone座席，11：pc+phone视频座席 7 status int False 签入后的状态，默认为空闲态。 3：示忙 4：空闲 5：整理态 8 ip string False 座席ip，默认127.0.0.1（最大长度为15），暂不支持IPV6 9 entryIp string False 座席客户端应用网关IP 10 phonelinkage boolean False 是否启动话机联动（接续和硬话机联动控制）。 默认为false。 11 checkInWebm boolean False 是否签入Webm媒体服务器。 默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。 默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。 默认为false。

触发事件 如果签入时status参数设置3（示忙态），触发如下事件： 座席开始执行签入动作（AgentOther_InService） 示闲（AgentState_Ready） 示忙成功（AgentState_SetNotReady_Success） 如果签入时status参数设置4（空闲态），触发如下事件 座席开始执行签入动作（AgentOther_InService） 示闲（AgentState_Ready） 如果签入时status参数设置5（整理态），触发如下事件： 座席开始执行签入动作（AgentOther_InService） 示闲（AgentState_Ready） 工作中（AgentState_Work）

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

响应说明 响应状态码: 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 regIPAddress string False 注册地址 长度限制：string（50） 1.3.3 phone array[object] False 软电话信息列表 1.3.3.1 phoneNum string False 软电话号码 长度限制：string（32） 1.3.3.2 password string False 软电话密码 长度限制：string（50） 1.3.3.3 id string False 配置信息id 1.3.3.4 status number False 注册状态，0：已注册，1：暂停状态 1.3.3.5 remark string False 备注信息 1.3.3.6 tenantId string False 租间id 1.3.3.7 partdbId string False 分区id 1.3.4 regPort number False 注册端口 长度限制：number（5） 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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，即不需要偏移，非必选

报文样例 请求头： x-app-key:9******************************3 Authorization:Bearer c******************************f Content-Type:application/json 请求参数： { "offset": "0", "limit": "3" } 响应头： { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数： { "retMsg": "successfully", "retCode": "0", "result": { "total": 6, "regPort": "5060", "phone": [{ "phoneNum": "999000", "password": "****" }, { "phoneNum": "999001", "password": "****" }, { "phoneNum": "999002", "password": "****" } ], "regIPAddress": "10.10.18.36" } }

报文样例 该接口的响应消息体举例如下： { "returnCode": "0200000", "obResult": { "defId": "1402245659", "displayResult": "就是不接电话6", "vdnId": 40, "resultCode": "002", "resultMapList": [ { "mapId": "1059886898", "defId": "1402245659", "failCode": "34609", "vdnId": "40" }, { "mapId": "1162133679", "defId": "1402245659", "failCode": "00008", "vdnId": "40" } ] }, "resultCode": "0200000", "resultDesc": "queryObsResultDetail success", "returnDesc": "queryObsResultDetail success" }

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/queryObsResultDetail 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 defId int True 需要查询的外显结果ID

会议申请失败 标示符 AgentConf_RequestFailed 作用 表示会议申请失败。 附带信息 cause表示失败原因码。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentConf_RequestFailed","workNo":"153","content":{"cause":21234}}} 父主题： 座席会议事件

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

报文样例 场景描述：查询质检件 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "rows": 10000, "page": 1, "startTimeMillis": 1623318494, "endTimeMillis": 1623923294, "fixedColumns": { "agentUserIds": [], "qualityUserIds": [], "taskType": null, "taskStatus": null } } 响应参数: { "data": [{ "taskType": "APPEAL", "calls": [{ "call_uuid": "8b595000-b02a-4290-9548-a4915001e89f" }], "initiatorName": "zxry0611", "taskOperatorName": "zxzg0611", "id": "16237434242323475065", "taskStatus": "reviewed", "createTimeStr": "2021-06-15 15:50:24", "updateTimeStr": "2021-06-15 15:50:25", "setting": { "file_name": "a1" } }, { "taskType": "APPEAL", "calls": [{ "call_uuid": "473fbc39-f231-43f4-b1d7-7fc415c6e990" }], "initiatorName": "zxry0611", "taskOperatorName": "", "id": "16233956459326867354", "taskStatus": "processing", "createTimeStr": "2021-06-11 15:14:06", "updateTimeStr": "2021-06-15 15:26:00", "setting": { "file_name": "a3" } }, { "taskType": "APPEAL", "calls": [{ "call_uuid": "473fbc39-f231-43f4-b1d7-7fc415c6e990" }], "initiatorName": "zxry0611", "taskOperatorName": "zxry0611", "id": "16233929966871311191", "taskStatus": "end", "createTimeStr": "2021-06-11 14:29:57", "updateTimeStr": "2021-06-11 15:06:20", "setting": { "file_name": "a3" } }] }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 total number False 总条数 1.2 pages number False 总页数 1.3 data array[object] False 质检件数据 1.3.1 id number False 质检件标识 1.3.2 taskTypeName string False 申诉件类型名称 1.3.3 inspectorName string False 质检人员名称 1.3.4 reviewingOfficerName string False 复核人员名称 1.3.5 initiatorName string False 发起人员名称 1.3.6 taskOperatorName string False 处理人员名称 1.3.7 agentName string False 经办人名称 1.3.8 taskStatusName string False 申诉件状态名称 1.3.9 calls array[object] False 通话详情列表 1.3.9.1 call_uuid string False 通话质检标识 1.3.10 createTimeStr string False 创建时间（格式：yyyy-MM-dd） 1.3.11 updateTimeStr string False 更新时间（格式：yyyy-MM-dd） 1.3.12 setting object False 通话详情列表 1.3.12.1 file_name string False 文档名 1.4 pageSize number False 每页条数 1.5 pageNum number False 页码 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 fixedColumns object False 高级查询的条件 1.1.1 agentUserIds array False 座席组座席的用户ID合集 1.1.2 qualityUserIds array False 质检组质检员的用户ID合集 1.1.3 taskType string False 质检件类型（1 问题件，2 申诉件） 1.1.4 taskStatus number False 质检件状态（21:审核中，22:完结，24:处理中，27:核实中） 1.2 startTimeMillis number False 质检件开始时间，时间戳秒 1.3 endTimeMillis number False 质检件结束时间，时间戳秒 1.4 rows number False 每页条数（限制一页回传笔数，目前最大值一百万） 1.5 page number False 搜寻的页数，以1为底，一页大小由rows决定

H5截图事件 标示符 AgentEvent_ImageCapture 作用 表示H5截图结果事件 附带信息 workNo：座席号。 content：消息对象，JSON格式。包含字段如下： callid：呼叫标示。 filename：截图文件地址。 locationId：截图文件对应的节点ID。 result：截图结果，0表示成功，1表示失败，2表示用户拒绝。 示例： {"eventType": "AgentEvent_ImageCapture","workNo": "1002","content": {"callid": "1654917192-17845843","result": 0,"filename": "F:/5/1/20220611/1002/1113201.jpg","locationId": 256}} 父主题： 多媒体事件

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 retCode string False 返回码 200：表示验证码发送成功 201：表示验证码已存在，请稍后发送 202：表示发送短信验证码出现异常，请联系运营人员 204：表示发送短信失败，请联系运营人员 205：表示今日系统发送邮件已达阈值，请联系运营人员修改系统每天总发送阈值 1.2 retMsg string False 返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

取消静音 标示符 AgentEvent_linkagePhoneUnMute 作用 表示某个呼叫被话机取消静音。 附带信息 callId：表示被取消静音的呼叫的唯一标记。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneUnMute","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题： 话机联动事件

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 表4 resultDesc对象参数说明 参数名 数据类型 说明 beginTime String 统计开始时间，毫秒级时间戳(五分钟统计区间开始时间) ccId int 呼叫中心编号 vdn int 虚拟呼叫中心编号 onlineAgentNums int 在线座席数（包含不接来话的座席数量） talkingNums int 通话座席数（不包含不接来话的座席数量） ideaAgentNum int 空闲坐席数（不包含不接来话的座席数量） busyNums int 示忙座席数（不包含不接来话的座席数量） restNums int 休息座席数（不包含不接来话的座席数量） incallNums int 五分钟内呼入呼叫数 rateNum int 五分钟内人工呼入接通数 callRate int 五分钟内人工呼入接通率 callOutNums int 五分钟内呼出呼叫数

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":[1,2,3], "beginDate":"2021-09-09 00:00:00", "endDate":"2021-09-11 23:00:00", "limit":"100", "offset":"0" } 响应参数： { "resultCode": 0, "resultDesc": { "data": [ { "beginTime": "1631594100000", "ccId": 1, "vdn": 1, "onlineAgentNums": 1, "talkingNums": 1, "ideaAgentNum": 1, "busyNums": 1, "restNums": 1, "inCallNums": 1, "rateNum": 1, "callRate": 1, "callOutNums": 1 } ], "count": 6 } }

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

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：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": "" } ] }

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

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

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.12及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.12及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 restReasonId int 休息原因码 2.2 restReason string 休息原因描述

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： 无。 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "restReasonId": 100, "restReason": "身体不适" } ], "resultDesc": [ { "restReasonId": 100, "restReason": "身体不适" } ] }