华为云用户手册

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addresses array True 批量删除的与会者信息。 数组最大长度为30。 该对象的参数说明请参考表4。 表4 AgentConfAddressExParam对象 序号 名称 参数类型 是否必选 说明 1.1 addressType String True 地址类型。 6：电话号码 9：座席工号 1.2 address String True 地址标识。 最大长度为24个字符。

响应说明 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 请参考表6 表6 不存在的与会者列表参数说明 序号 名称 参数类型 说明 3.1 noExistParticipants array 请参考表7 表7 与会者参数说明 序号 名称 参数类型 说明 3.1.1 addressType string 地址类型 3.1.2 address string 地址标识

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

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

消息样例 场景描述：查询任务列表 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/task/list 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "limit": 1,"start": 0 } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： { "resCode": "0", "resMsg": "成功", "result": { "count": 1, "taskList": [ { "closedDate": null, "contactId": "ciIy0000013y7cC8T2rA", "createdDate": "2023-07-07T06:51:35.000Z", "creatorId": "10gg00000148QvgpaLAm", "creatorName": "liuhuqiong001", "description": "test001", "dueDate": "2023-07-08 00:00:00", "id": "ccqG0000014iXvGKONQO", "ownerId": "10gg00000148QvgpaLAm", "ownerName": "liuhuqiong001", "priority": "Low", "relateId": "c6m80000014iXKHqDw3c", "status": "Pending", "stayDate": null, "taskId": "ccqG0000014iXvGKONQO", "taskNo": "000000000000000000000000001002", "title": "show0612", "type": "Case" } ] } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 taskList TaskList[] True 任务信息，该对象的参数说明请参见表4 2 count number True 符合条件的总数 表4 Tasklist参数说明 序号 名称 参数类型 是否必选 说明 1 taskId string True 任务id 2 taskNo string True 任务No 3 title string True 任务标题 4 ownerId string True 处理人id 5 priority string False 优先级 dataType : SingleSelect 枚举值： Critical High Medium Low 6 dueDate Datetime False 期望完成时间，时间格式为YYYY-MM-DD HH:mm:ss 7 status string True 任务状态 8 description string False 任务描述 9 creatorName string True 创建人名 10 ownerName string False 处理人名 11 creatorId string True 创建人id

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 title string 128 False 任务名称模糊查询 2 status string 128 False 任务状态 dataType : SingleSelect 枚举值： Completed Pending Processing 3 priority string 128 False 优先级 dataType : SingleSelect 枚举值： Critical High Medium Low 4 ownerId string 20 False 任务的责任人id 5 type string - False 关联类型： 取值： Case 6 relateId string 20 False 如果关联任务类型有值，这里也必须有值 7 start number - True 起始行数。（min:0） 8 limit number - True 本次查询要求返回的行数（min：1，max:100） 9 classification string 128 False 任务分类类型 （Todo；Processed；Created） 10 contactId string 20 False 联系人id 11 creatorId string 20 True 创建人id 12 startTime string - False 创建开始时间， 格式为YYYY-MM-DD HH:mm:ss 13 endTime string - False 创建结束时间， 格式为YYYY-MM-DD HH:mm:ss

消息样例 场景描述：分配任务 URL：https://域名/service/AICC__Case/1.0.0/openapi/task/transfer 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "id": "ccqG0000014iXvGKONQO", "ownerId": "10gg00000148QvgpaLAm", "creatorId": "10gg00000148QvgpaLAm" } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 任务id 2 ownerId string 20 True 被分配人id 3 creatorId string 20 True 创建人id

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

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 详情请参见错误结果码 3 result object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 phonetoken string 临时token。 3.2 phonenum string 座席签入的软电话号码。

录音播放停止 标示符 AgentMediaEvent_StopPlayDone 作用 录音被停止播放。 附带信息 cause表示停止播放的原因。0：正常播放结束；1：座席主动停止播放；2：录音播放失败而停止播放。 示例 {"message":"","retcode":"0","event":{"eventType":"AgentMediaEvent_StopPlayDone","workNo":"49999","content":{"cause":0}}} 父主题： 质检放音事件

报文样例 请求样例 { "tenantId":"202104237142", "timestamp":1630684800000, "type":"month", "authToken":"0kQl*******************PHFhoyDy" } 响应样例 { "tenantId": "202104237142", "recordTime": 1630684800000, "type": "month", "qaCount": 78, "intentCount": 42, "talkCount": 45, "effectiveQaCount": 1, "effectiveIntentCount": 7, "effectiveTalkCount": 6, "effectiveQaSum": 1, "effectiveIntentSum": 17, "effectiveTalkSum": 22, "qaList": [ { "name": "我们在测试", "count": 1 } ], "intentList": [ { "name": "话费查询(话费查询)", "count": 7 }, { "name": "套餐降级(套餐降级)", "count": 3 }, { "name": "无需服务(无需服务)", "count": 2 }, { "name": "是否(是否)", "count": 2 }, { "name": "Taxa de chamada(Taxa de chamada)", "count": 1 }, { "name": "公积金业务(公积金)", "count": 1 }, { "name": "公积金问题(公积金问题)", "count": 1 } ] }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 day: 按天查询,特定日期的报表数据 month: 按月查询,以timestamp往后一天作为结束时间,三十日内的报表数据 tenantId String body True 租户ID timestamp long body False 查询日期的毫秒时间戳 如果不传,仅返回租间问答、意图和语聊的数目。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

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

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

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

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "curPage": 1, "totalSize": 3, "rowsPerPage": 10, "data": [ { "id": 3, "name": "666", "status": 1, "strBeginTime": "2018-11-30", "strEndTime": "2018-11-30", "deviceType": 2, "callerNo": "10080" }, { "id": 4, "name": "666333696", "status": 1, "strBeginTime": "2018-11-30", "strEndTime": "2018-11-30", "deviceType": 2, "callerNo": "10080" }, { "id": 2, "name": "SAAS_JST", "status": 3, "strBeginTime": "2018-11-29", "strEndTime": "2018-12-08", "deviceType": 2, "callerNo": "10080" } ], "curSkillQueueCount": 3, "curIvrCount": 0 }

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 4 returnDesc String 描述。 5 curPage int 当前页。 6 totalSize int 总记录数。 7 rowsPerPage int 每页记录数。 8 curSkillQueueCount int 当前技能队列外呼活动总数。 9 curIvrCount int 当前IVR外呼活动总数。 10 data List 查询成功后，返回外呼活动信息的对象(Campaign)。 参见表4

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 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}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 name String False 外呼活动的名称。 长度为0~30，默认值为空。 3 status int True 外呼活动的状态。 取值范围： 2：已开始 3：暂停 4：已完成 0：默认查询全部状态 4 deviceType int True 外呼设备类型。 取值范围： 1：智能外呼的IVR 2：预测外呼的技能队列 3：自动外呼的IVR 5：预览外呼的技能队列 6：预占外呼的技能队列 0：默认查询全部类型 5 beginTime String False 外呼活动的最小开始时间，格式为yyyy-MM-dd HH:mm:ss。 6 endTime String False 外呼活动的最大结束时间，格式为yyyy-MM-dd HH:mm:ss。 7 curPage int True 当前第几页。 默认值为1，输入值小于1时自动修正为1。 8 rowsPerPage int True 每页记录数。 该值不输入的时候，默认查询10条，且最大值为100。 9 ccId int False 传了就按指定的ccid过滤，不传就不过滤

报文样例 场景描述：新增定时抽检计划 请求头: Content-Type:application/json x-app-key:xxxx-xxxx-xxx-xxxx x-UserId:xxxxxxxxx Authorization:Bearer ******************************** 请求参数: { "extractionRange": { "customColumns": null, "fixedColumns": { "durationEnd": "100", "durationStart": 1, "interactionType": 0, "maxNum": "10", "qualityCondition": 2, "qualityNum": "100", "qualityType": 1, "staffIds": [], "scoreStart": "0", "scoreEnd": "100" }, "currentRole": "qualityDirector" }, "appointQuality": { "setCounts": [{ "personID": "1679888547924121791", "count": 0 }], "setCountsType": 0 }, "cronStructure": { "qiqtCycleType": "1", "qiqtStartTime": 1692171720, "qiqtEndType": "2", "qiqtTotalTimes": 1, "qiqtEndTime": 1692258120 }, "qiqtName": "test082101", "currentRole": "qualityDirector" } 响应头: Content-Type: application/json;charset=UTF-8 响应参数: { "objId": "954637368599307266", "resultCode": 0, "resultDesc": "success" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 objId string False 抽检计划唯一标识 1.2 resultCode string False 返回码 0408000 表示成功 其他表示失败 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 True 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 appointQuality object True 指派质检员 1.1.1 setCounts array[object] True 设置质检员 1.1.1.1 count number False 数量，最大长度8位 setCountsType!=2时，count必填。 setCountsType==2时，setCounts中所有count总和为100。 1.1.1.2 personID string True 质检员ID，最大长度64位 1.1.2 setCountsType integer True 设置数量的类别：0-平均分配，2-百分比 1.2 cronStructure object True 设置周期 1.2.1 qiqtCycleType string True 重复方式： 1，每天，2.每周，3.每月 1.2.2 qiqtEndTime integer False 结束时间：当qiqtEndType 为2 时有效，秒级，最大长度10位 1.2.3 qiqtEndType string True 结束条件： 1.次数 2.时间 1.2.4 qiqtStartTime integer True 开始时间，秒级，最大长度10位 1.2.5 qiqtTotalTimes integer False 定时任务执行次数，最大长度8位。 qiqtEndType==1时，qiqtTotalTimes必填。 1.3 currentRole string False 用户角色 1.4 extractionRange object True 设定抽检范围 1.4.1 currentRole string False 用户角色 1.4.2 fixedColumns object True 抽检范围条件设定 1.4.2.1 qualityType integer True 抽检类型：1.通话范围 2.座席抽检数量类型 3.座席抽检百分比类型 1.4.2.2 durationStart integer False 通话最短时间，毫秒级，最大长度11位 1.4.2.3 qualityNum string True 抽检数量，最大长度8位 1.4.2.4 qualityCondition integer True 抽检状态：0.不限制 1.未抽检 2.已抽检 1.4.2.5 durationEnd string False 通话最长时间，毫秒级，最大长度11位 1.4.2.6 maxNum string False 最大抽检量，最大长度8位。 qualityType!=2时，maxNum参数必填且参数值大于等于1。 1.4.2.7 scoreEnd string False 最高分数，最大分数10000 1.4.2.8 scoreStart string False 最低分数，最大分数10000 1.4.2.9 staffIds array[string] False 座席人员 1.4.2.10 interactionType integer True 交互类型。取值范围： 0：录音 2：文本 1.4.3 userId string False 用户ID 1.5 qiqtName string True 计划名称，最大长度64位 1.6 userId string False 用户ID

报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "hjbLfhU*******************Fv3nq", "uid": "0c9358552188478a8d5ff9203db8791f" } 响应消息样例 { "errorCode": 0, "errorMsg": null, "jobDetail": { "jobName": "AICC_RPA", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "workstationName": "AICC_RPA", "runMode": "online", "timeout": 120, "mode": "queueTrigger", "uid": "0c9358552188478a8d5ff9203db8791f", "procedureVersion": "1.0.5", "queueName": "创建工单", "createTime": "2022-04-24 17:12:02", "procedureName": "AICC_RPA", "startTime": "2022-04-29 11:47:25", "jobType": "procedure", "recentTaskStatus": "failed", "status": "running" } }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度：64 jobName String body False 任务名称（根据jobName来查询,uid可设置为null,jobName或者uid必须传入一个值。） uid String body False 任务UUID（jobName和uid都填,以uid为准,jobName或者uid必须传入一个值。） authToken String body True 访问接口的有效Token值。 有效Token信息通过 获取Token 接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度：32

响应说明 表2 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0：成功 其他值：失败 errorMsg String body False 错误信息 jobDetail RpaDetailJobResult[] body False 队列详情 表3 RpaDetailJobResult参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid string body True 任务UUID jobName string body True 任务的名称 startTime string body False 作业开始时间, 格式：yyyy-mm-dd HH:mm:ss createTime string body True 作业创建时间, 格式：yyyy-mm-dd HH:mm:ss workstationName string body False 执行器名称 clusterName string body False 集群名称 runMode string body True 运行模式：在线online mode string body True 执行方式：once、repeat、queueTrigger jobType string body True 任务类型固定为procedure status string body True 任务状态条件搜索,如下： init：待执行 running：运行 suspend：暂停 success：完成 procedureName string body True 脚本包名称 procedureVersion string body True 脚本包版本 description string body True 任务描述 timeout int body False 任务超时时间 recentTaskStatus string body False 最近一次作业状态,没有生成作业的任务不会返回该字段 queueUid string body False 队列的UUID queueName string body False 队列名称

呼叫离开设备原因 表1 呼叫进入/离开设备原因 原因码 含义 0 普通接入/转移 1 溢出转 2 超时转 3 无人上班转 4 取消排队转移 5 座席久不应答转移 6 挂起恢复 7 连接保持 8 三方求助 9 取保持 10 三方通话 11 内部求助，求助方释放 12 拦截 13 代答 14 呼叫的被叫分析未配置 15 用户主动释放 16 座席释放 17 转出 18 保持 19 内部处理错误 20 被叫忙 22 手机关机 23 手机不在服务区 24 空号 25 排队机无资源 26 用户不应答 27 被叫拒绝 28 成功转队列 29 三方转队列 30 成功转队列超时 31 三方转队列超时 34 超时/溢出/遇忙网呼失败排队 35 网络呼叫返回原呼叫中心排队 36 排队的呼叫重路由 37 由呼入路由进入CDN 38 由座席咨询进入CDN 39 CDN正常返回路由结果 40 CDN路由超时 41 咨询时座席取消或路由失败 42 由CDN路由超时进入PGR 43 由CDN正常返回路由进入PGR 44 由呼入路由进入PGR 45 由座席咨询进入PGR 46 座席不可达，CDN重路由 47 呼叫在多个队列排队 48 在从队列中接听主队列的呼叫 49 座席拒绝呼入来话（取消） 50 座席拒接呼叫 51 用户呼叫进入电话会议 52 会议主席主动释放会议，或C CS 异常导致会议释放 53 与会者被请出会议 54 接通率低于阈值转接 88 座席应答后，用户挂机 89 座席应答前，用户挂机 父主题： 参考说明

报文样例 该接口的请求消息体举例如下： 可以根据业务需要选择不同的策略组合。 全局策略+普通策略policyType=0，type=0。 { "policyJson":"[{'type':0,'retryTimes':1,'retryDay':1}]", "policyType": 0 } 全局策略+结果策略policyType=0，type=1。 { "policyJson":"[{'type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]", "policyType": 0 } 号码类型匹配策略+普通策略policyType=1，type=0。 { "policyJson" : "[{'dataType':'ST','type':0,''policy':{'retryTimes':2,'retryDay':1}}]", "policyType": 1 } 号码类型匹配策略+结果策略policyType=1，type=1。 { "policyJson":"[{'dataType':'ST','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]", "policyType": 1 } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "" }