华为云用户手册

请求说明 表1 请求消息头参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json;charset=UTF-8。 2 X-TenantSpaceID String True 无 租户id。 3 X-Access-Token String True 无 生成方式参见SIA鉴权（SIA鉴权填写）。 4 Authorization String True 无 生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。 5 userId String True 无 用户ID。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 keyword String True 无 关键字。 2 offset Number True 无 分页查询偏移量，默认值0，即不需要偏移。 3 limit Number True 无 分页查询时单页最多的记录条数。 4 code String False 无 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 5 coluKngType String False 无 栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识 6 startTime Number False 无 开始时间。(时间戳) 7 endTime Number False 无 结束时间。(时间戳) 8 ccId Number False 无 呼叫中心id。AKSK鉴权必填。 9 vdn Number False 无 vdnId。AKSK鉴权必填。

响应参数 { "AccessToken": "zzzzzzzzzzzzzzzzzz"， "ApplyType": "Bearer"， "CreateTime": "1545650171"， "Expires": "600"， "Scope": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"， "AppKey": "xxxxxxxxxxxxxxxxx"， "UserID": "Anonymous" } AccessToken为API的token。

场景描述 Api Fabric生成token URL：https://Domain Address/apigovernance/api/oauth/tokenByAkSk Domain Address请根据CEC实际的地址或域名进行替换。 例如，在华为公有云生产环境，请将Domain Address替换为service.besclouds.com，则调用URL为https://service.besclouds.com/apigovernance/api/oauth/tokenByAkSk

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租戶ID callId String body True 会话ID agentId String body True 座席ID nodeId String body True 图元节点ID，传给静默座席，静默座席回传 nodeIndex int body False 回复的图元节点执行位置，传给静默座席，静默座席回传 replyType int body False 回复类型，默认为0 0：意图回复 1：内容回复 replyIntentCode String body True 意图码，当静默座席回复自定义内容（即replyType为1）时，若为插入状态，固定赋值slientInsertReply。 replyIntentContent String body True 座席返回的答复。意图中配置的回复内容。 若为自定义内容，即直接输入静默座席回复的话。 replyIntentName String body True 意图名称，若为内容回复，则同replyIntentCode字段值。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求消息样例 { "callId":"16064786965020f6fb86792bd25dbbb489426"， "agentId":"10001"， "nodeId":"node_action_97511fbc15d9b23074405ee736187a82c529"， "nodeIndex":2， "replyType":0， "replyIntentCode":"car"， "replyIntentContent":"测试汽车"， "replyIntentName":"ssq测试"， "authToken": "t*****************************" } 响应消息样例 { "errorCode" : "0"， "errorMsg" : "" }

请求说明 表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 } } 该接口的请求消息体参数说明请参见表2。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 ccId int True 呼叫中心编号。 取值范围：1～65535 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000

响应消息 该接口的响应消息体举例如下： { "result": "0", "resultDatas": { "allowrestnum": 101, "onrestnum": 1, "waitrestnum": 0, "agentsrestdetails": {[ "agentname": "z1", "workno":55001 "cantrestreason":1 "begintime":2345 "restduration":22333 ]} } } 该接口的响应消息体参数说明请参见表3。 表3 消息体参数说明 参数名 数据类型 说明 result string 查询结果。取值如下： 0：成功 非0：失败 失败的原因说明请参见错误码参考。 resultDatas Object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 resultDatas对象参数说明 参数名 数据类型 说明 allowrestnum int 已经允许休息人数，但是座席仍然未休息的座席人数 onrestnum int 正在休息的座席数 waitrestnum Int 申请休息的座席数 agentsrestdetails array VDN上休息座席的详情对象列表。 该对象的参数说明请参见表5。 表5 agentsrestdetails对象参数说明 参数名 数据类型 说明 agentname string 座席名称。 workno int 座席工号。 cantrestreason int 座席不允许休息的原因，此参数仅对于等待休息的座席有效。 该对象的参数说明请参见表6。 begintime long 开始时间(正在休息指休息开始时间，还未休息指申请或批准休息开始时间) 时间格式：时间戳 restduration long 请求休息时长，单位：秒。 表6 不允许休息原因 不允许休息原因值 原因值说明 0 等待批准 1 座席示忙 2 VDN 休息人数已满。 3 座席不接来话，未签入任何技能队列。 4 签入队列休息人数已满。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "vdn":1, "skillIds":[1,2] } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "agentIds": [ 291 ] }, { "skillId": 2, "agentIds": [] } ], "resultDesc": [ { "skillId": 1, "agentIds": [ 291 ] }, { "skillId": 2, "agentIds": [] } ] }

响应消息 表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 agentIds array 签入该技能的座席工号数组。

请求消息 表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。

响应消息 表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 配置编号。

请求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。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数 无。 响应参数： { "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" } ] }

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

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

报文样例 请求样例 { "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": "删除成功" }

请求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 结果描述

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body True 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 th_TH：泰语 pt_BR：葡萄牙语 注意：智能工单分类场景，以Lodas文本分类模型支持语言为准。 text String body True 输入语句。 文本分类的依据，最大长度4096字符。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求样例 { "tenantId":"fangyg"， "language":"zh_CN"， "text":"发票开不出来"， "authToken":"XI0*******************lYbYACW" } 响应样例 { "results": [ { "label": "移动业务→基础服务→电子发票→全局流转→功能使用→发票无法打印→全局流转"， "probability": 0.41408610343933105 }， { "label": "移动业务→服务触点→一点对接业务→全局流转→业务规则→对业务规定/流程不满→全局流转"， "probability": 0.012493142858147621 }， { "label": "移动业务→业务营销→资费套餐→降档套餐→办理规范→限制渠道办理不认可→全局流转"， "probability": 0.004905845504254103 } ] }

响应说明 表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 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "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 }

接口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过滤，不传就不过滤

错误结果码 表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}/blocklist/delete 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 blocklistNo String True 需要删除的黑名单号码。最大长度为24个字符，有效字符为：0~9、*、#

响应消息样例1 { "userid": "1528780879-9581"， "outaction": 9， "outparams": { "call_id": "1528780879-9581"， "prompt_type": "1"， "prompt_wav": "welcome"， "prompt_text": "查询话费"， "language": "0"， "inter_idx": "1"， "model_type":"1011201" "timeout": "10"， "tone": ""， "grammar": ""， "question_id": "Q1"， "question_name": "问题1"， "answer_id": "Y" } }