华为云用户手册

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdnId":4, "agentId":667, "groupId":"159282396714302232563636876268", "groupName":"话务组", "groupType":"" } 响应参数： { "result": { "groupName": "话务组A", "groupId": "161960203515344228641565404173" }, "message": "success", "retcode": "0" }

响应消息 表3 消息体参数说明 参数名 数据类型 说明 message string 描述 retcode string 错误码。取值如下： 0：成功 非0：失败 错误码的参数说明请参见表5。 result object 加入成功后，返回结果信息的对象。该对象的参数说明请参见表4。 表4 result对象参数说明 参数名 数据类型 说明 groupId string 座席加入的用户组编号 groupName string 座席加入的用户组名称 （不允许非法字符，长度不超过20） 表5 错误结束码说明 错误结束码 说明 处理意见 300-010 VDN用户ccid和vdnid匹配错误 检查输入参数是否正确。 300-016 VDN下不存在此座席 检查VDN下是否存在该座席，如果存在建议1分钟后重试一次 300-017 质检用户组名已存在 更改待创建的质检用户组名称 300-018 质检用户组名为空 检查是否携带groupName参数或者其值是否为空 300-019 待加入的质检用户组不存在 检查groupId对应的质检用户组是否存在 1 参数不合法或系统报错 检查输入参数是否正确。

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/appdata?isEncodeResult={isEncodeResult}&callId={callId} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 isEncodeResult boolean False 查询到的呼叫数据是否经过base64编码。取值范围： true：查询到的呼叫数据经过了base64编码 false：查询到的呼叫数据没有经过base64编码 true以外的参数都作为false处理。 说明： Base64是一种编码方式，不是加密算法，不能用作任何敏感信息的加密用途。 3 callid string False 被查询呼叫ID。多媒体会话时为必传。

接口参数说明 接口中需要传入的技能队列ID、接入码、VDNID、座席工号、班组ID、callId等参数，必须真实存在的。CC-Gateway对接口参数的校验限制在用户有效性校验，接口参数的有效性在CC-Gateway调用CTI接口时由CTI负责校验。 接口返回值和入参中时间参数如不特殊说明，默认 long 类型为时间戳格式，单位为ms。 查询类接口： 1、/resource/queuedevice/* （队列签入、排队人数等） 2、/resource/agentgroup/* （技能队列信息） 3、/resource/calldata/* （随路数据、呼叫信息等） 4、/resource/onlineagent/{agentid}/agentskills (查询配置技能队列) 5、/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno} (查询指定座席配置技能队列) 6、/resource/onlineagent/{agentid}/agentstatus (获取当前座席的状态) 7、/resource/onlineagent/{agentid}/syncagentinfo (座席页面刷新时同步座席状态status和通话信息) 8、/resource/onlineagent/{agentid}/updateGuid (座席页面刷新时主动请求更新Guid) 这些接口，应用于座席综合接续应用中的转接、求助过程中，查询座席和队列的相关信息的配套查询，以及座席的当前的呼叫处理信息。为了避免多租第三方异常开发，影响系统稳定性，做了系统层级以及座席层级的流控，不可频繁的调用。 父主题： 附录

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 data List 查询成功后，返回的特殊日期信息列表数据。 参见表4。 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 5 returnDesc String 描述。

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "data": [ { "id": 11, "name": "周末", "type": 1, "week": "5,7", "beginTime": null, "endTime": null }, { "id": 14, "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24" } ] }

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

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "playType": 0, "playMode": 2, "voicePath": "y:/conf/120/1136287.V3" } 响应参数 { "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 playType int False 放音类型。 0：播放会议前景音。 1：播放会议背景音。 默认值为0。 2 playMode int False 放音模式。 2：播放指定文件音。 默认值2。 3 voicePath String True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名，例如： y:/conf/120/1136287.V3 最大长度为127个字符。

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

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

休息超时提醒 标示符 AgentState_Rest_Timeout 作用 表示某个座席请求休息后已经超时，提醒用户超时信息（此事件为提醒，并不代表座席退出休息态）。 附带信息 无。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentState_Rest_Timeout","workNo":"49999","content":null}} 父主题： 座席状态类事件

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 caller string False 主叫号码。内容可为空，为空时为平台默认主叫号码，0-24位数字 2 called string True 被叫号码。内容不可为空，1-24位数字或*或# 3 skillid int False 技能ID。数字类型，内容可为空，为空时为平台配置默认的技能队列ID。 4 callappdata string False 随路数据信息。可为空，最大长度为16k。 5 mediaability int False 媒体能力，默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。 说明： 视频呼音频，接听后会导致通话直接挂断，原因是媒体协商失败，推荐视频外呼时，mediaability配置为2，以最大能力呼叫。 6 userVideoDirection int False 用户视频方向。取值范围： 1：用户只接收视频不发送视频 2：用户只发送视频不接收视频 3：用户既发送也接收视频 4：不设置接收发送方向 缺省值：4。 说明： 仅在mediaability配置为1时，可使用该参数。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "caller": "40038", "called": "40040", "skillid": 25, "callappdata": "", "mediaability": 1, "userVideoDirection": 4 } 响应参数 { "message": "", "retcode": "0", "result": "1455885056-1095" }

前置条件 座席已签入 座席当前无正在接听的呼叫（不包括保持后的呼叫） 如果您需要使用单向视频能力来指定用户视频方向，如用户只接收视频不发送视频、用户只发送视频不接收视频，请登录UAP9600的客户端CDE执行下面MML命令修改参数。 查询软参P978的比特位、比特位值是否都为0。 LST SFP: ID=P978; 若不是执行如下命令修改。 MOD SFP: ID=P978, MODTYPE=P1, BIT=0, BITVAL=0;

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

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

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

报文样例 场景描述：发起申诉。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "taskDescription": "remark", "callId": "c6a31191-6c69-486b-b8f9-c3412ef44bfd", "callGroupId": "c6a31191-6c69-486b-b8f9-c3412ef44bfd", "isGroup": false, "chooseRuleGroupList": [{ "ruleGroupId": "groupid_fa1d9f72-f961-4ad6-9277-008bbe1c3802", "reviseIdList": ["silenceRule4a0e94cf-c357-4d53-9beb-4cefb2a81fb4", "silenceRule4aa85a8a-f914-4488-bf11-adbbfde3fe95"] }], "leaderUUID": "1600226359041729505", "leaderRole": "10", "fileName": "766" } 响应参数: { "callId": "c6a31191-6c69-486b-b8f9-c3412ef44bfd", "available": true }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 status string False 状态 1.2 message 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 callGroupId number True 通话业务规则id 1.2 callId number True 通话标识id 1.3 isGroup boolean False 是否是关联通话 1.4 leaderRole string True 提交申诉领导职别 1.5 leaderUUID string True 申诉领导id 1.6 taskDescription string True 申诉原因 1.7 chooseRuleGroupList array[object] True 待申诉规则列表 1.7.1 ruleGroupId string True 规则id 1.7.2 reviseIdList array[string] True 待申诉规则列表 1.8 callType string True 文件类型、交互类型

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":4, "agentIds":[11,12], "indexIds":["IDX_DURATION_AGENT_REST","IDX_COUNT_AGENT_REQUEST"], "beginDayTime":"2020-08-21 00:00:00", "endDayTime":"2020-08-22 00:00:00", "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "11" }, { "idxs": [ { "val": "5", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "15", "id": "IDX_DURATION_AGENT_REST" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "11" }, { "idxs": [ { "val": "5", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "15", "id": "IDX_DURATION_AGENT_REST" } ], "id": "12" } ] }

响应消息 该接口的响应消息体举例如下： { "result": "0", "resultDatas": { "workno": 101, "vdnid": 1, "citStatus": 0, "name": "HW35154101", "phonenumber": null, "logindate": 4294967295000, "currentstatetime": 436879, "mediatype": 0, "status": 2 } } 该接口的响应消息体参数说明请参见表3。 表3 消息体参数说明 参数名 数据类型 说明 result string 查询结果。取值如下： 0：成功 非0：失败 失败的原因说明请参见错误码参考。 resultDatas object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 resultDatas对象参数说明 参数名 数据类型 说明 workno int 座席工号。 vdnid int 所属VDN ID。 citStatus Int 座席平台状态，请参见CTI平台座席状态码参考。 name String 座席名称。 phonenumber String 座席电话号码。 logindate long 签入时间。 currentstatetime long 当前状态时长。 mediatype Int 座席媒体类型，请参见表1 status Int 座席状态。取值： 0：未知。对应CTT平台状态的9 2：签出状态。对应CTT平台状态的0 3：示忙状态。对应CTI平台状态的7 4：空闲状态。对应CTT平台状态的1 5：整理态。对应CTT平台状态的6 7：通话态。对应CTT平台状态的2、3、4、5 8：休息状态。对应CTT平台状态的8

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 消息头 Content-Type:application/json; charset=UTF-8 消息体 该接口的请求消息体举例如下： { "queryParam": { "ccId":1, "vdn":1, "agentId":101 } } 该接口的请求消息体参数说明请参见表2。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 ccId int True 呼叫中心编号。 取值范围：1～65535 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000 agentId Int True 座席工号。 取值范围：101-59999

响应说明 表3 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 返回0：成功 其他值：失败 errorMsg String body False 错误信息 total int body False 队列数据条数,成功时必须返回。 queueData QueueData[] body False 队列数据,成功时必须返回。 表4 QueueData参数说明 参数名称 数据类型 参数位置 必选/可选 描述 id long body False 队列数据自增ID uid string body False 队列数据UUID queueName string(32) body False 队列名称 queueUid string body False 队列UUID createTime long body False 创建时间(0-7258089600000L)时间戳 expectStartTime long body False 计划开始时间(0-7258089600000L)时间戳 expectEndTime long body False 计划结束时间(0-7258089600000L)时间戳 status string body False 队列状态枚举类型为： init：等待处理 processing：处理中 success：成功 failed：失败 priority string body False 优先级枚举类型为： low：低 normal：中 high：高 inactived string body False 队列启用状态枚举类型为： active：已启用 inactive：已停用 tag string(32) body False 队列数据标签 inputJsonData string(65535) body False 输入的队列数据,json格式字符串 outputJsonData string(65535) body False 输出的结果数据,json格式字符串 analysisJsonData string(65535) body False 中间的队列数据,json格式字符串 failedReason string(512) body False 失败原因 failedReasonDetail string(65535) body False 失败原因细节 description string(100) body False 队列数据描述 progress int body False 进度(0-100)

报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "oqyo*******************fGMCu", "pageNo": 1, "pageSize": 10, "conditions": { "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a" } } 响应消息样例 { "errorCode": 0, "errorMsg": null, "total": 1, "queueData": [ { "id": 44, "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueName": "创建工单", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "createTime": 1651027548328, "expectStartTime": null, "expectEndTime": null, "status": "success", "priority": "normal", "inactived": "active", "tag": null, "inputJsonData": "{\"caseId\":\"0607000000t1FY2F0Mb2\"}", "outputJsonData": null, "analysisJsonData": null, "failedReason": null, "failedReasonDetail": null, "description": "描述队列数据", "progress": null } ] }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度：64 authToken String body True 访问接口的有效Token值。 有效Token信息通过 获取Token 接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度：32 pageNo Integer body False 查询页数,默认1页 pageSize Integer body False 每页多少条,默认50条 可选值：5,10,20,50 conditions RpaQueueDataConditions body True 查询条件。 队列数据uid或者队列queueUid必须传入一个值。 表2 RpaQueueDataConditions参数 参数名称 数据类型 参数位置 必选/可选 描述 uid string body False 根据队列数据UUID查询（至少传递uid、queueUid、queueName中一个参数） queueUid string body False 根据队列数据UUID查询（至少传递uid、queueUid、queueName中一个参数） queueName string(32) body False 根据队列名称查询（至少传递uid、queueUid、queueName中一个参数） tag string body False 根据队列数据标签查询 status string body False 根据队列状态查询,枚举类型为 init：等待处理 processing：处理中 success：成功 failed：失败 inactived string body False 根据队列启用状态查询,枚举类型为： active：已启用 inactive：已停用 不传该参数,默认查询已启用 priority string body False 根据队列优先级查询,枚举类型为： low：低 normal：中 high：高

报文样例 请求头: x-app-key: XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/json Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "userAccount":"test123456" } 响应参数: { "resultCode": "0", "resultMessage": "delete AgentAccount success" }