华为云用户手册

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

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas long CTI平台所在服务器UTC的时间戳。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc long CTI平台所在服务器UTC的时间戳。

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1} 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": 1605057110000, "resultDesc": 1605057110000}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 say(可以修改) object True 请求报文，代码中不会对这个报文做任何处理，会回写到响应消息体中。

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode String 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 表4 resultDesc对象参数说明 参数名 数据类型 说明 beginTime String 统计开始时间，毫秒级时间戳(五分钟统计区间开始时间) ccId int 呼叫中心编号 uapIp String UAP的IP agentOnlineCount int 软终端注册数

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "uapIP":"1.1.1.1", "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,"uapIp": "1.1.1.1","agentOnlineCount": 1 } ], "count": 1 }}

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

请求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端口号。

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

响应消息 表2 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 表3 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 ccId int 呼叫中心ID。 2.2 vdnId int 虚拟呼叫中心ID。 2.3 accessCode string 接入码。 2.4 subCode string 后续接入码。 最大长度：100。 取值：0123456789*#。 2.5 deviceType string 设备类型，请参见表1 返回值的类型为四字节整数。 2.6 deviceName string 设备名称。 当设备类型为1表示技能队列时，设备名称为技能队列名称。 当设备类型为3表示IVR自动流程时，设备名称为流程描述。 2.7 deviceNo string 设备编号。 2.8 dnid string 配置编号。

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "timeGrain":"15MIN", "serviceNos":[3,2], "indexIds":["IDX_COUNT_IVR_INBOUND_CALL"], "mediaType":53, "subMediaType":3} 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_IVR_INBOUND_CALL" } ], "id": "3" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_IVR_INBOUND_CALL" } ], "id": "3" } ]}

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数 无。 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "ccId": 1, "vdnId": 1, "accessCode": "6045", "subCode": "1110", "deviceType": "1", "deviceName": "test", "deviceNo": "22", "dnid": "22" } ], "resultDesc": [ { "ccId": 1, "vdnId": 1, "accessCode": "6045", "subCode": "1110", "deviceType": "1", "deviceName": "test", "deviceNo": "22", "dnid": "22" } ]}

请求URL https://ip:port/rest/cmsapp/v1/openapi/configures/calledconfigs/{ccId}/{vdn} 其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。 {ccId}为呼叫中心ID，取值范围：1～65535，{vdn}为虚拟呼叫中心ID，取值范围：1～5000。

请求说明 表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 page number True 页码 1.2 limit number True 每页数量 取值范围：5, 10, 20, 50， 100 1.3 keyword string False 敏感词名称的关键字

报文样例 场景描述：取得敏感词列表的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"page": 1,"limit": 10, "keyword":"更改"} 响应参数: { "data": [ { "category_id": "1065038086678777856", "sw_id": "1067229455178534912", "sw_name": "更改敏感词名称766" }, { "category_id": "1071491122737451008", "sw_id": "1071495709510864896", "sw_name": "更改敏感词名称131" } ], "resultCode": "0401000", "paging": { "total": 2 }, "resultDesc": "操作成功"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 paging object False 分页信息对象 1.1.1 total number False 查询结果总数 1.2 data array[object] False 查询结果记录 1.2.1 sw_id string False 敏感词唯一标识 1.2.2 sw_name string False 敏感词名称 1.2.3 category_id string False 敏感词分类的唯一标识 1.3 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.4 resultDesc string False 返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的路径未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "skillIds":[1,2]} 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "queueSize": 0, "loggedOnAgents": 0, "queueTime": 0, "availAgents": 0, "skillDescrip": "defaultVedioSkill", "callId": "4294967295-4294967295", "maxQueueSize": 100 }, { "skillId": 2, "queueSize": 0, "loggedOnAgents": 1, "queueTime": 0, "availAgents": 0, "skillDescrip": "defaultAudioSkill", "callId": "4294967295-4294967295", "maxQueueSize": 100 } ], "resultDesc": [ { "skillId": 1, "queueSize": 0, "loggedOnAgents": 0, "queueTime": 0, "availAgents": 0, "skillDescrip": "defaultVedioSkill", "callId": "4294967295-4294967295", "maxQueueSize": 100 }, { "skillId": 2, "queueSize": 0, "loggedOnAgents": 1, "queueTime": 0, "availAgents": 0, "skillDescrip": "defaultAudioSkill", "callId": "4294967295-4294967295", "maxQueueSize": 100 } ]}

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 skillId int 技能队列编号 2.2 queueSize int 当前等待在队列中的呼叫数目 2.3 queueTime long 队列中等待最久的呼叫的等待时间，单位为秒 2.4 loggedOnAgents int 当前签入该技能的座席数量 2.5 availAgents int 该技能队列中当前可用的座席数目 2.6 skillDescrip string 技能描述 2.7 callId string 等待最久的呼叫ID 2.8 maxQueueSize int 队列最大可排多少呼叫 如何配置请参见《(For Engineer) ICD VxxxRxxxCxx 产品文档 01 (ICD)》的 配置排队处理/接通率参数

请求说明 表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。 技能队列ID取值范围：1～2000。

座席操作类型 表1 操作类型 操作类型 含义 操作对象 操作原因 说明： 下面操作对象和操作原因都为“-”，表示对该操作类型不写座席操作详单。 US_NO_USE=0xFFFF; 65535 0 座席签出C CS 。 US_NO_USE 1~255：客户端传入原因 256：座席与平台断连 257：座席被质检员强制签出 258：座席主动签出 259：座席重新签入前的签出 260：媒体服务器和CCS关于座席控制块握手超时 261：CCS检测到与UIS关于座席控制块握手超时 262：媒体服务器与CCS握手断连导致座席签出 263：UIS与座席握手超时 264：具有相同工号的座席正在新的客户端强制登录，导致本座席被强制签出 1 座席签入。 US_NO_USE US_NO_USE 2 空闲。 - - 3 示忙。 US_NO_USE 1：自己示忙 2：久不应答被示忙 3：被质检员强制示忙 4：休息 5：座席电话不可用 7：座席拒接呼叫 200～250：业务自定义原因码 4 通话态。 US_NO_USE 1：座席未真实退出通话态时，每个准点0分和5分输出的话单。 0：座席完全退出通话态时输出的话单。 5 等待应答。 给业务代表分来话后等业务代表应答。 - - 6 业务代表应答或业务代表呼出成功后等待连接成功的消息。 - - 7 业务代表拆线。 - - 8 请求释放。 - - 9 呼出时等被叫振铃。 - - 10 三方通话。 工号 US_NO_USE 11 座席通道坏或座席死机。 - - 12 座席通道或座席已恢复。 - - 13 人工转自动，业务代表处于挂起状态。 US_NO_USE US_NO_USE 14 被监听或插入。 - - 15 停止被监听或插入。 - - 16 被录音。 - - 17 停止被录音。 - - 18 被监视。 - - 19 停止被监视。 - - 20 监听/插入/耳语。 工号 0：监听座席 2：监听中继 US_NO_USE 21 停止监听/插入/耳语。 - - 22 放音。 US_NO_USE US_NO_USE 23 停止放音。 - - 24 监视。 - - 25 停止监视。 - - 26 座席休假(休息)。 工号 休息原因由客户端调用CCC_REQUEST_REST_EX_Msg时指定（默认0）。 27 工作状态。 US_NO_USE 0：事后整理 业务侧设置自动进入工作态。 0~255：手动调整 由业务座席通过调用接口手动进入工作态。 缺省为0，即事后整理。 28 监听插入呼叫。 - - 29 强制签出。 工号 US_NO_USE 30 强制示闲。 工号 US_NO_USE 31 强制示忙。 工号 US_NO_USE 32 座席对用户静音。 US_NO_USE US_NO_USE 33 结束静音，座席取消对用户静音。 - - 34 座席进入学习态。 US_NO_USE US_NO_USE 35 座席进入工作态。 - - 36 座席进入调整态。 - - 37 工作态结束。 - - 38 座席保持呼叫。 质检员工号 1：被质检员强制保持 US_NO_USE 39 座席取保持。 - - 40 座席发起内部求助。 工号 0：无组合操作 1：两方人工求助 2：三方人工求助 3：通话转被叫应答后先和业务代表通话，业务代表释放时连接主被叫用户。 4：三方通话转被叫应答后实现三方通话，业务代表释放时连接主被叫用户。 5：三方通话 6：连接呼叫 41 座席发起内部呼叫。 工号 US_NO_USE 42 座席进行连接保持。 - - 43 拦截呼叫。 工号 US_NO_USE 44 暂停放音。 US_NO_USE US_NO_USE 45 内部转移。 工号 US_NO_USE 46 转出。 US_NO_USE US_NO_USE 47 签入媒体服务器。 US_NO_USE US_NO_USE 50 静像（只静视频，不静音）。 US_NO_USE US_NO_USE 51 静音视频。 US_NO_USE US_NO_USE 52 签出媒体服务器。 US_NO_USE US_NO_USE 53 转移正在公有队列中排队的呼叫。 US_NO_USE US_NO_USE 54 释放转。 US_NO_USE US_NO_USE 55 转移到其他设备。 US_NO_USE US_NO_USE 56 设置座席的自定义状态。 US_NO_USE 业务自定义的座席状态码。 57 内部求助时切换保持。 US_NO_USE 内部求助切换。 58 座席进入“会议态”。 座席工号 - 59 多媒体协作。 座席工号 0：发起多媒体会议 1：参加多媒体会议 父主题： 附录

请求说明 表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 category_id string True 需要删除的句子分类的唯一标识

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

报文样例 场景描述：删除句子分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"category_id": "923019012181331968"} 响应参数: {"resultCode": "0403000","resultDesc": "Opration Successful."}

报文样例 场景描述：移动句子到指定分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"sentenceIds": "14161,14171","category_id": "894378237264662528"} 响应参数: {"resultCode": "0403000","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 sentenceIds string True 句子的唯一标识 1.2 category_id string True 分类的唯一标识

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

报文样例 场景描述：创建句子分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"name": "cs"} 响应参数: {"category_id": "925086177642418176","resultCode": "0403000","resultDesc": "操作成功"}

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