华为云用户手册

请求说明 表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 callId string True 呼叫ID 4 logDate long True 查询时间，用于解析月份，查询指定表；毫秒级时间戳

报文样例 场景描述：删除句子 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sentence_id": "14412" } 响应参数: { "resultCode": "0403000", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string False 返回码 0403000 表示成功 其他表示失败 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 sentence_id string True 句子的唯一标识

CTI返回系统配置接口错误码 表1 VDN 错误结果码 说明 120501 同时签入的最大业务代表数超过限制 120502 并发语音最大呼叫数超过限制 120503 并发Web最大呼叫数超过限制 120504 最大并发OutBound呼出数超过限制 120505 CP会场方数超过限制 120506 同时签入的最大视频业务代表数超过限制 120507 限制主叫号码不能存在包含关系 120508 启用限制,限制主叫号码前缀不能为空 120509 启用限制,默认主叫以限制主叫号码前缀开头 120510 VDN名称与其它VDN名称重复 120511 VDN名称与VDN组名称重复 120512 VDN工号范围与其它VDN重复 120513 VDN引用的OBS不存在 120514 VDN引用的分布式资源不存在 120515 VDN引用的数据源不存在 120516 VDN引用的IVR不存在 120517 RMS 基本信息配置中录音系统为无时,本VDN采用的录音系统只能配置为华为排队机资源录音 120519 VDN强制自录音中使用的分布式节点在VDN设置中未分配 120520 VDN引用的系统接入码不存在 120521 VDN的呼叫类型不支持Email/Fax,当前VDN分配了该媒体类型的系统接入码 120522 VDN的呼叫类型不支持Web,当前VDN分配了该媒体类型的系统接入码 120523 VDN分配的系统接入码已经分配到其它VDN 120524 VDN分配的系统接入码已经分配到VDN组 120525 IVR数据源不在VDN分配的VDN数据源或第三方数据源中 120526 默认IVR数据源不在VDN分配的VDN数据源或第三方数据源中 120527 该VDN被本地CCP客户端引用,不能删除 120528 启用座席挂起转,呼叫转回座席后放提示音,必须配置提示音参数 120529 VDN管理员必须在工号范围内 120530 VDN引用的盘符不存在 120531 VDN基本信息的接入码没有分配当前VDN 120533 VDN工号范围重复 120534 VDN引用的C CS 资源组不存在 120535 工号范围已使用,不能取消 120536 可用VDN的长度不能为0 120537 可用VDN不能包含转移VDN 120538 可转移工号个数不足 120539 多媒体许可类型无效 120540 多媒体许可值超出范围 120541 座席并发处理能力1~60 120550 并发视频IVR最大呼叫数不能超过并发IVR最大呼叫数 120552 uap视频会场方数限制 120624 修改的vdn对接密码与旧密码相同 表2 接入码 错误结果码 说明 120201 系统接入码重复 120202 系统接入码与特殊路由接入码重复 120203 系统接入码与NIRC的网络呼叫接入码重复 120204 系统接入码被VDN引用，不能删除 120205 系统接入码被VDN组引用，不能删除 父主题： 错误码定义

取消示忙成功 标示符 AgentState_CancelNotReady_Success 作用 表示某个座席取消示忙成功。 附带信息 无。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentState_CancelNotReady_Success","workNo":"49997","content":null}} 父主题： 座席状态类事件

报文样例 请求头 POST /CCFS/resource/ccfs/ivr/deleteFile HTTP/1.1 Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed0******************941bdd106 Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/3rdfile/2/thirdvoicebotfile/5dckNDei_1647502396161.wav" } } 响应参数 { "resultData": null, "resultCode": "0", "resultDesc": "success" }

响应说明 当调用本接口响应成功，则返回0和operate success。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据

报文样例 该接口的请求消息体举例如下： { "blocklist": [ "13100000000", "13100000001", "13100000002", "13100000003" ], "validityExpirationTime":"2020-12-31 10:06:25", "restrictTimes":3, "restrictPeriod":"0" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "The blocklist is added successfully" }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 blocklist List True 新增黑名单号码列表，最多20条。 号码最大长度为24个字符，有效字符为：0~9、*、# 2 validityExpirationTime String False 到期时间，到期时间=新增时间点+有效时长。例：“2020-12-31 10:06:25”新增2条黑名单号码，有效时长120小时，则到期时间为“2021-01-05 10:06:25”。 3 validityTime INT False 有效时长，单位小时，取值范围1~120。 4 restrictTimes INT False 限制次数（与限制周期绑定，两者都填或都不填，范围：1-100） 5 restrictPeriod String False 限制周期（0：每小时；1：每天） 示例1："restrictTimes":1，"restrictPeriod":"0" 表示2020-12-30 10:06:25 呼出一次，下次可呼出时间为2020-12-30 11:00:00 示例2："restrictTimes":1，"restrictPeriod":"1" 表示2020-12-30 10:06:25 呼出一次，下次可呼出时间为2020-12-31 00:00:00

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 号码已存在黑名单中。 4 0200018 存在重复的号码。 5 0200029 超过了每次添加允许的最大值。 6 02000001 参数值为空 7 02000002 参数包含非法字符 8 02000003 参数长度不能大于规定长度 9 02000004 参数长度不能小于规定长度 10 02000005 参数长度需要介于规定长度之间 11 02000006 参数值类型不正确 12 02000007 参数值大小不正确 13 02000008 参数转换异常，请检查请求参数 14 02000009 参数组合不正确，请检查请求参数 15 02000010 hour和minute必须同时存在 16 02000011 参数个数不能大于规定个数

使用说明 前提条件 已经申请了开发者账号。 使用限制 黑名单号码最大长度为24个字符。 黑名单号码有效字符为：0~9、*、#。 每次只能增加20条黑名单号码，否则提示“超过单次新增最大数量”，且不新增黑名单号码。 每次追加的黑名单号码不能有重复，否则提示“号码重复”，且不新增黑名单号码。 每次追加的黑名单号码中不能存在已有黑名单号码。 当同时传入有效时长和到期时间时，则以指定时间（validityexpirationtime）为准处理。 限制次数小于重试策略设置的试呼次数。

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

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/resetskill/{autoflag}?skillid={skillid}&phonelinkage={phonelinkage} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 autoflag boolean True 是否签入所有技能队列的标志，取值范围： true：自动签入座席所配置技能 false：签入指定的技能队列 true以外的参数值都作为false处理。 3 skillid string False 技能队列ID。 当签入方式{autoflag}为false时，skillid如果为空则不签入任何技能队列；skillid为技能队列ID字符串组，例如1;2;3，最大长度为4000。座席签入的技能队列为此skillid和所配置技能队列的交集。 4 phonelinkage int False 是否话机联动，接续和硬话机联动控制。取值范围： 1：是 0：否 目前仅支持CC组网下的espace 7910 话机。

客户退出呼叫 标示符 AgentEvent_Customer_Release 作用 表示客户从指定的callId呼叫中退出。 附带信息 callid：呼叫的CallID。 number：用户号码。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Customer_Release","workNo":"49999","content":{"callid":"1456404171-43","number":"70093"}}} 父主题： 音视频通话事件

呼叫数据:calldata 本节下所列接口应用场景为： 在座席转接、求助过程中，查询座席和队列的相关信息，以及座席的当前的呼叫处理统计信息。 为了确保系统稳定性，该类接口在系统层级以及座席层级做了过负荷控制： 系统最大允许查询请求个数，默认为15000次/2秒 单个座席允许的查询请求消息数为，默认为5次/2秒 因此使用此类接口时请考虑过负荷机制，请勿短时间频繁调用接口导致系统崩溃。 查询呼叫信息 查询呼叫随路数据 设置呼叫随路数据（扩展） 查询保持列表 查询应答来话前呼叫信息 根据呼叫CallID查询呼叫信息 查询指定座席呼叫ID 查询座席当前的话路数 查询座席当前呼叫统计信息 查询座席当前呼叫统计信息（扩展） 查询指定技能队列排队等待呼叫信息 质检员查询指定座席的保持列表 父主题： 座席控制

请求URL https://ip:port/rest/cmsapp/v1/openapi/qcrelationconf/deleteqcrelationconf 其中，公有云环境请联系管理员获取，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 结果描述

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "qcGroupId":"159282396714302232563636876268", "inspectedGroupIds":["159253666192354492596520647666"], "vdn":113 } 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": "删除配置成功", "resultDesc": "删除配置成功" } 该接口的响应消息体参数说明请参见响应消息。

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

报文样例 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":4 } 响应参数： { "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 55002, "state": 0 }, { "agentId": 833, "state": 0 }, { "agentId": 834, "state": 0 }, { "agentId": 835, "state": 0 } ], "resultDesc": [ { "agentId": 55002, "state": 0 }, { "agentId": 833, "state": 0 }, { "agentId": 834, "state": 0 }, { "agentId": 835, "state": 0 } ] }

报文样例 场景描述：查询所有业务场景 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "limit": 10, "page": 1, "scenarioName": null, "startTime": null, "endTime": null, "scenarioStatus": null } 响应参数: { "total": 1, "data": [{ "tenant_id": "202106114153", "silence_rules": ["920806740809748480"], "other": {}, "speed_rules": [], "interposal_rules": [], "create_time": 1623391966, "group_name": "test3", "ignore_sensitive": 0, "is_enable": 1, "description": "3", "rules": [], "group_id": "groupid_1760cfbb-e24c-4c9f-92f7-2701f154577c", "rule_count": 1 }] }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 total number False 查询结果数据总数 1.2 data array[object] False 业务场景查询结果对象 1.2.1 group_id string True 业务场景标识 1.2.2 group_name string False 业务场景名称 1.2.3 is_enable number True 是否正在被启用（0 代表不启用，1 代表启用） 1.2.4 create_time number True 业务场景创建时间 1.2.5 description string False 业务场景描述 1.2.6 other object False 场景的整体通话过滤条件 1.2.6.1 call_from number False 通话起始时间，时间戳毫秒 1.2.6.2 call_end number False 通话结束时间，时间戳毫秒 1.2.7 rule_count number False 已配置的质检规则总数 1.2.8 ignore_sensitive number False 是否计入敏感词分数（0 代表计入，1 代表不计入） 1.2.9 interaction_type number False 交互类型 0和不填表示语音 2表示多媒体 响应状态码: 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 limit number True 每页查询总数 1.2 page number True 查询页数 1.3 scenarioName string False 业务场景名称 1.4 scenarioStatus string False 是否正在被启用（0 代表不启用，1 代表启用） 1.5 startTime string False 创建开始时间 1.6 endTime string False 创建结束时间

请求消息 消息头 表1 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 消息体 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 serverId string True CTI平台已存在的订阅任务的编号，也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

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

报文样例 场景描述：套用质检评分设置档。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "id": "1828287446" } 响应参数: { "resultCode": "0412000", "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 False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 设置档唯一标识

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

响应说明 表5 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 serverId String 生成文件服务ID 全局唯一 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6 5 returnDesc String 描述。