华为云用户手册

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

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requeststopwhisperagent?whisperagentid={whisperagentid} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 whisperagentid string False 被质检耳语的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

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

报文样例 该接口的请求消息体举例如下： { "userName":"WANGWU", "serverInfo":{ "ip":"5.9.11.11", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******" } 该接口的响应消息体举例如下： { "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 serverInfo Object True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String False 服务密码。明文传递，后台密文保存，当serviceInfo.IP与原有IP值不一致时，必传 表4 serverInfo参数说明 序号 参数名 参数类型 是否必选 说明 1 ip String True 文件服务器IP。 2 port String True port 3 filePath String True 文件服务器默认路径 示例：/home/sftp

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

报文样例 场景描述：修改用户 URL：https:// 域名 /apiaccess/rest/sum/v1/tenantSpaces/users/{userId} 请求头 x-app-key:953587d812f642998ee1f633b81212f3 Authorization:Bearer e3fca9398eaa5cef4b57b523b9c75fae Content-Type:application/json 请求消息: { "userName":"userName01", "phone":"12012341234", "email":"test@huawei.com", "profile":"Operator" } 响应消息: { "message": "", "retcode": "0" }

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":113, "workNos":[57005,57006], "groupId":"159774518399110207461019283363" } 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": "新增成功", "resultDesc": "新增成功" }

请求URL https://ip:port/rest/cmsapp/v1/openapi/qcrelationconf/batchaddgroupmember 其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

响应说明 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/setcustomstate?customstate={customstate} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 customstate integer True 座席自定义状态，取值范围：0~65534。 说明： 由业务侧统一定义具体含义。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "vdn":1, "skillIds":[1,2] } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "agentLoginNums": 1, "agentTalkingNums": 0, "agentIdleNums": 0, "agentAvailableNums": 0, "agentSetBusyNums": 1, "agentRestNums": 0, "agentMaxIdleTimeIn5": 0, "agentWorkNums": 0, "agentStudyNums": 0, "agentOccupyNums": 0, "agentPreOccupyNums": 0, "totalCallNums": 0, "processingCallNums": 0, "maxCallWaitTimesIn5": 0, "callWaitNums": 0, "evenCallTimeIn5": 0, "evenWaitTimeIn5": 0, "allCallCount": 0, "cnnedIn20sCallCount": 0 }, { "skillId": 2, "agentLoginNums": 0, "agentTalkingNums": 0, "agentIdleNums": 0, "agentAvailableNums": 0, "agentSetBusyNums": 0, "agentRestNums": 0, "agentMaxIdleTimeIn5": 0, "agentWorkNums": 0, "agentStudyNums": 0, "agentOccupyNums": 0, "agentPreOccupyNums": 0, "totalCallNums": 0, "processingCallNums": 0, "maxCallWaitTimesIn5": 0, "callWaitNums": 0, "evenCallTimeIn5": 0, "evenWaitTimeIn5": 0, "allCallCount": 0, "cnnedIn20sCallCount": 0 } ], "resultDesc": [ { "skillId": 1, "agentLoginNums": 1, "agentTalkingNums": 0, "agentIdleNums": 0, "agentAvailableNums": 0, "agentSetBusyNums": 1, "agentRestNums": 0, "agentMaxIdleTimeIn5": 0, "agentWorkNums": 0, "agentStudyNums": 0, "agentOccupyNums": 0, "agentPreOccupyNums": 0, "totalCallNums": 0, "processingCallNums": 0, "maxCallWaitTimesIn5": 0, "callWaitNums": 0, "evenCallTimeIn5": 0, "evenWaitTimeIn5": 0, "allCallCount": 0, "cnnedIn20sCallCount": 0 }, { "skillId": 2, "agentLoginNums": 0, "agentTalkingNums": 0, "agentIdleNums": 0, "agentAvailableNums": 0, "agentSetBusyNums": 0, "agentRestNums": 0, "agentMaxIdleTimeIn5": 0, "agentWorkNums": 0, "agentStudyNums": 0, "agentOccupyNums": 0, "agentPreOccupyNums": 0, "totalCallNums": 0, "processingCallNums": 0, "maxCallWaitTimesIn5": 0, "callWaitNums": 0, "evenCallTimeIn5": 0, "evenWaitTimeIn5": 0, "allCallCount": 0, "cnnedIn20sCallCount": 0 } ] }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求消息体参数说明。 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535 2 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000 3 skillIds array True 技能队列ID信息的对象数组。数组长度不大于1000。 取值范围：1～2000。

响应消息 表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 skillId int 技能队列编号。 2.2 agentLoginNums long 签入座席数。 2.3 agentTalkingNums long 通话座席数。 2.4 agentIdleNums long 空闲座席数。 2.5 agentAvailableNums long 可用座席的数目(在座席可一对多通话时，此值与空闲座席数可能不同)。 2.6 agentSetBusyNums long 示忙座席数。 2.7 agentRestNums long 休息座席数。 2.8 agentMaxIdleTimeIn5 long 最长座席空闲时间（5分钟内）。 2.9 agentWorkNums long 事后整理座席数，包括调整态等。 2.10 agentStudyNums long 学习态座席数。 2.11 agentOccupyNums long 占用态座席数。 2.12 agentPreOccupyNums long 预占用座席数。 2.13 totalCallNums long 已处理的呼叫总数（包括正在处理的呼叫）。 2.14 processingCallNums long 正在处理的呼叫数。 2.15 maxCallWaitTimesIn5 long 最长呼叫等待时间（5分钟内）。 2.16 callWaitNums long 排队的呼叫数（等待呼叫数）。 2.17 evenCallTimeIn5 long 平均通话时长（5分钟内平均）。 2.18 evenWaitTimeIn5 long 平均呼叫等待时长（5分钟内平均）。 2.19 allCallCount long 当前5分钟呼入呼叫总和。 2.20 cnnedIn20sCallCount long 当前5分钟内在20S内接通呼叫总和。

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 archiveHistory int False 是否移历史表。 取值范围：0，1。 0：不移历史表，直接删除。1：移入历史表。默认为0。

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

与会者变更事件 标示符 AgentConf_ParticipantChanged 作用 被邀请座席将收到此事件。 附带信息 result表示变更结果。0：成功；其他：失败。 changeType表示变更类型。0：加入会议；1：退出会议；2：主席变更；3：禁止发言；4：恢复发言；5：保持；6：取消保持。 changeReason表示变更原因，当“ChangeType”为“1”时，此参数有意义，“ChangeType”为其他类型时无意义。0：参与者主动离开会议；1：会议主席强制移除与会者；2：与会者挂机；3：会议结束；4：与会座席签出；6：其他原因导致与会者被强制离开会议 confId表示会议ID。 participant表示会议成员标识。 participantType表示会议成员类型。6：电话号码；9：座席工号。 deviceCallType表示自定义的设备呼叫类型。 deviceType表示自定义的设备类型。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentConf_ParticipantChanged","workNo":"154","content":{"result":0,"changeReason":255,"changeType":3,"confId":1031168,"participant":"154","participantType":9,"deviceCallType":0,"deviceType":0}}} 父主题： 座席会议事件

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

报文样例 场景描述：指派人工复核任务。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "qualityTaskId": 954645333549048833, "setCountsType": 1, "isTakeEffect": 0, "setCounts": [{ "personID": "1600226476732482572", "count": 2 }] } 响应参数: { "resultCode": "0409000", "resultDesc": "操作成功" }

请求说明 表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 True 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 qualityTaskId number True 抽检任务ID 1.2 setCountsType number True 指派质检员类型，当前只支持1 1.3 isTakeEffect number True 是否立即生效，0、1 1.4 setCounts array[object] True 质检员列表 1.4.1 personID string True 质检员用户ID 1.4.2 count number False 指派任务数量，小于等于8位

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0409000 表示成功 其他表示失败 1.2 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 isGroup boolean True 是否在通话组 1.2 ruleType number True 规则类型 1.3 taskId string True 任务id 1.4 uuid string True 通话uuid 1.5 ruleInfo object True 规则信息 1.5.1 description string True 抽检备注 1.5.2 revise number True 抽检结果，1合规，0违规 1.5.3 reviseId number True 规则id

报文样例 场景描述：修改质检结果。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "isGroup": false, "ruleType": 60, "taskId": "951849982538539011", "uuid": "6e587bea-d752-4cd7-8ce4-96b6e4c9258a", "ruleInfo": { "description": "5454", "revise": 1, "reviseId": "sentitiveWordRule735bd2f5-0037-4b22-8eb5-49e354e3bac9" } } 响应参数: { "resultCode": 0409000, "resultDesc": "success" }

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "addressType": "9", "address": "2002" } 响应参数 { "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 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识。 最大长度为24字节。

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

报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************ } 请求参数: { "moduleId": "80031", "result": "save", "surveyId": "987654321", "custId":"123456789", "serviceId1": "987654321" } 响应参数: { "resultCode": "1203000", "surveyAnswerId": "123456789", "resultDesc": "Opration Successful." }