华为云用户手册

转出通知 标示符 AgentEvent_linkagePhoneTransferOut 作用 表示座席正在通过话机转出当前呼叫。 附带信息 addrOut：表示被转出的电话号码。 addrSelf：表示座席的电话号码。 address：表示地址标识。 addressType：表示地址类型（当前只会为6，表示电话号码）。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneTransferOut","workNo":"120","content":{"addrOut":{"address":"70002","addressType":6},"addrSelf":{"address":"70001","addressType":6}}}} 父主题： 话机联动事件

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 id String True 主键id。 创建App个人设置 (create)中响应体参数id的值。 2 callType string False 呼叫类型 0：直呼 1：双呼 2：透显呼叫 3 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。 4 callerPresent String[] False 被叫显示号码。 最多5个，多个号码之间以，隔开 每个号码长度限制：string（15） 5 callNumber String[] False 坐席软电话号码。 最多5个，多个号码之间以，隔开 每个号码长度限制：string（15） 6 callNumberDefault string False 默认坐席绑定的软电话号码。 长度限制：string（15） 7 callerPresentDefault string False 被叫默认显示号码。 长度限制：string（15）

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "id": "1307145259662215169", "callType": "1", "userId": "10gg000000y6OOrNaUFs", "callerPresent": [ "12323" ], "callNumber": [ "12323", "232343", "233", "239343" ], "callNumberDefault": "23232323", "callerPresentDefault": "1212121212" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "returnCode": "0", "returnDesc": "update success.", "id": "1307145259662215169" }

报文样例 场景描述：新增语速规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "setting": { "name": "APIcs", "score": 4, "min": 80, "max": 120, "other": { "call_from": 1622515590, "call_end": 1625021193 } }, "exception": { "under": {}, "over": {} } } 响应参数: { "resultCode": "0405000", "speed_id": "925095745760006144", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 speed_id string False 创建的语速规则ID 1.2 resultCode string False 返回码，0405000表示成功，其他表示失败 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 False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 setting object True 基本信息 1.1.1 name string True 语速规则名称 1.1.2 score number True 违规扣分数0-100 1.1.3 min number True 语速最小限制1-220 1.1.4 max number True 语速最大限制1-2147483647 1.1.5 other object False 触发条件 1.1.5.1 call_from number False 通话发生开始时间 ：时间戳，单位秒 1.1.5.2 call_end number False 通话发生结束时间 ：时间戳，单位秒 1.2 exception object True 例外设置信息 1.2.1 under object True 语速低于最小限制时，客户说出以下句子 1.2.1.1 customer array[string] False 客户说的句子id 1.2.2 over object True 语速大于最高限制时，客户有说出以下句子 1.2.2.1 customer array[string] False 客户说的句子id

静态鉴权 在agentgateway/WEB-INF/config/basic.properties中修改配置： AUTHMODE = 1 座席调用登录接口登录成功后，可以从请求的响应头中获取到名称为Set-GUID的header，值例如为“JSESSIONID=27************f5.AgentGateway0”，其中27************f5.AgentGateway0为guid，这个guid就是这个座席的鉴权信息。座席调用其他接口时需要将该guid设置到http请的header中，header的名称必须为guid。CC-Gateway会从请求的header中获取guid进行比较，判断是否合法用户，如果不是合法用户，则返回结果码为100-006或000-003。

前置条件 座席已签入。 座席有正在通话中的语音呼叫。 目前音视频切换支持如下场景： 客服代表呼出音频通话或者用户通过拨打被叫接入座席，语音通话后，支持音视频切换。 呼叫保持、取消保持和静音取消静音后支持音视频切换。 呼叫转移时，转移对象为座席、技能队列时，支持音视频切换。 如果您需要使用单向视频能力来指定用户视频方向，如用户只接收视频不发送视频、用户只发送视频不接收视频，请登录UAP9600的客户端CDE执行下面MML命令修改参数。 查询软参P978的比特位、比特位值是否都为0。 LST SFP: ID=P978; 若不是执行如下命令修改。 MOD SFP: ID=P978, MODTYPE=P1, BIT=0, BITVAL=0;

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/mediaswitch?mediaType=3&videoDirection=4 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 mediaType int True 切换的目标媒体类型，取值范围： 1：音频 3：视频 3 videoDirection int False 视频方向，取值范围： 1：用户只接收视频不发送视频 2：用户只发送视频不接收视频 3：用户既发送也接收视频 4：不设置接收发送方向 缺省值：4。 说明： 仅在mediaType配置为3时，可使用该参数。

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 licenseMaxAgentNum long License支持的最大签入座席数 2.2 licenseMaxVideoAgentNum long License支持的最大签入视频座席数 2.3 licenseMaxVdnNum long License支持的最大VDN个数 2.4 licenseMaxIvrCallNum long License支持的最大自动业务呼叫数 2.5 licenseMaxVoiceCallNum long License支持的最大语音呼叫数 2.6 licenseMaxWebCallNum long License支持的最大Web呼叫数 2.7 loginAgentNum long 当前签入座席数 2.8 loginVideoAgentNum long 当前签入视频座席数 2.9 vdnNum long 当前配置的VDN个数 2.10 ivrCallNum long 当前自动业务呼叫数 2.11 voiceCallNum long 当前语音呼叫数 2.12 webCallNum long 当前Web呼叫数 2.13 historyMaxAgentNum long 历史最大签入座席数 2.14 historyMaxVideoAgentNum long 历史最大签入视频座席数 2.15 historyMaxIvrCallNum long 历史最大自动业务呼叫数 2.16 historyMaxVoiceCallNum long 历史最大语音呼叫数 2.17 historyMaxWebCallNum long 历史最大Web呼叫数 2.18 licenseStartDate long License开始时间 2.19 licenseEndDate long License结束时间

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "licenseMaxAgentNum": 4, "licenseMaxVideoAgentNum": 4294967295, "licenseMaxVdnNum": 10, "licenseMaxIvrCallNum": 4, "licenseMaxVoiceCallNum": 6, "licenseMaxWebCallNum": 4294967295, "loginAgentNum": 1, "loginVideoAgentNum": 4294967295, "vdnNum": 1, "ivrCallNum": 0, "voiceCallNum": 1, "webCallNum": 4294967295, "historyMaxAgentNum": 4294967295, "historyMaxVideoAgentNum": 4294967295, "historyMaxIvrCallNum": 4294967295, "historyMaxVoiceCallNum": 4294967295, "historyMaxWebCallNum": 4294967295, "licenseStartDate": 0, "licenseEndDate": 0 }, "resultDesc": { "licenseMaxAgentNum": 4, "licenseMaxVideoAgentNum": 4294967295, "licenseMaxVdnNum": 10, "licenseMaxIvrCallNum": 4, "licenseMaxVoiceCallNum": 6, "licenseMaxWebCallNum": 4294967295, "loginAgentNum": 1, "loginVideoAgentNum": 4294967295, "vdnNum": 1, "ivrCallNum": 0, "voiceCallNum": 1, "webCallNum": 4294967295, "historyMaxAgentNum": 4294967295, "historyMaxVideoAgentNum": 4294967295, "historyMaxIvrCallNum": 4294967295, "historyMaxVoiceCallNum": 4294967295, "historyMaxWebCallNum": 4294967295, "licenseStartDate": 0, "licenseEndDate": 0 } }

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

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

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sw_id string False 敏感词的唯一标识 1.2 sw_name string False 敏感词名称 1.3 score number False 敏感词分数 1.4 exception object False 敏感词例外状况 1.4.1 customer array[object] False 客户说的句子 1.4.1.1 category_id string False 句子分类的唯一标识 1.4.1.2 sentence_id string False 句子的唯一标识 1.4.1.3 sentence_name string False 句子名称 1.4.2 staff array[object] False 坐席说的句子 1.4.2.1 category_id string False 句子分类的唯一标识 1.4.2.2 sentence_id string False 句子的唯一标识 1.4.2.3 sentence_name string False 句子名称 1.5 category_id string False 敏感词分类的唯一标识 1.6 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.7 resultDesc string False 返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：根据敏感词的唯一标识获取敏感词详细资讯的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sw_id": "894378241547046912" } 响应参数: { "exception": { "customer": [{ "category_id": "894378237264662528", "sentence_id": "14171", "sentence_name": "意图名称demo3" }], "staff": [{ "category_id": "894378237264662529", "sentence_id": "14161", "sentence_name": "意图名称demo1" }, { "category_id": "894378237264662529", "sentence_id": "14166", "sentence_name": "意图名称demo2" }] }, "score": "-10", "category_id": "894378241379274752", "resultCode": "0401000", "sw_id": "894378241547046912", "resultDesc": "操作成功", "sw_name": "啦啦啦" }

请求说明 表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 sw_id string True 敏感词唯一标识

报文样例 场景描述：查询静默规则列表 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "page": 1, "limit": 10 } 响应参数: { "data": [{ "score": "-5", "seconds": "3", "times": "1", "silence_id": "894378242029391872", "name": "静默规则名称1" }, { "score": "-3", "seconds": "4", "times": "4", "silence_id": "922671254081638400", "name": "test3" }, { "score": "-5", "seconds": "5", "times": "5", "silence_id": "922671488287379456", "name": "tes4" }, { "score": "-4", "seconds": "5", "times": "4", "silence_id": "922987647176019968", "name": "test34" }, { "score": "-4", "seconds": "5", "times": "4", "silence_id": "922988537635147776", "name": "test35444" }], "resultCode": "0405000", "paging": { "total": 5 }, "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 返回信息 1.1.1 score string False 规则分数 1.1.2 seconds string False 连续静默秒数 1.1.3 times string False 静默次数 1.1.4 silence_id string False 静默规则标识 1.1.5 name string False 规则名称 1.2 resultCode string False 返回码，0405000表示成功，其他表示失败 1.3 paging object False 分页信息 1.3.1 total number False 总数 1.4 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 page number False 当前页数 1.2 limit number True 每页展示的数量 1.3 keyword string(64) False 搜索的关键词

报文样例 请求消息样例 { "tenantId":"202104237142", "language":"zh_CN", "pageNum":1, "pageSize":20, "authToken": "t*********************", "domainInfo":{ "domainName":"机器人", "domainId": "10149" } } 响应消息样例 { "errorMsg": "", "errorCode": 0, "intentions": [ { "intentName": "移车地址", "intentDesc": " ", "intentCmd": "移车地址" }, { "intentName": "社保业务", "intentDesc": " ", "intentCmd": "社保业务" }, { "intentName": "移车业务", "intentDesc": "移车业务", "intentCmd": "移车" }, { "intentName": "公积金问题", "intentDesc": " ", "intentCmd": "公积金问题" }, { "intentName": "是否", "intentDesc": " ", "intentCmd": "是否" }, { "intentName": "公积金业务", "intentDesc": " ", "intentCmd": "公积金" } ], "total": 6 }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID language String body True 语言 en_US：英文 zh_CN：中文 pt_BR：葡萄牙语 th_TH：泰语 fr_FR：法语 ar：阿拉伯语 pageNum int body True 页码 分页查询,查询第几页,首页为1 pageSize int body True 每页多少条 支持每页 5、10、20、50、100条 domainInfo DomainInfo body 配置项oifde.slient.use = ipcc 时True,反之False 领域信息 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 表2 DomainInfo 参数名称 数据类型 参数位置 必选/可选 描述 domainName String body False 领 域名 称 domainId int body True 领域ID language String body False 语言 tenantId String body False 租户ID

报文样例 该接口的请求消息体举例如下： { "limit":10, "offset":0, "importTaskIds":["164698362894300182038011895728"] } 该接口的响应消息体举例如下： { "result": [ { "succNum": 0, "failNum": 0, "errMsg": "", "id": "164698362894300182038011895728", "beginTime": "2022-03-11T07:27:09.000+00:00", "endTime": "2022-03-11T07:27:09.000+00:00", "repeatNum": 0, "status": "2" } ], "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackfile/queryDataImportTask 其中，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 offset int True offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。 取值范围：1～100

错误结果码 表6 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 1 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 skillId int 技能队列编号 2.2 maxCallNum int 最大排队呼叫数目 2.3 maxHoldCallNum int 最大保持数目 2.4 maxWaitTime long 最大等待时长(s) 2.5 maxAnswerWaitTime long 最大不应答时长(s) 2.6 maxTalkTime long 最大通话时长(s) 2.7 maxRestAgentNum int 最大允许休息人数 2.8 maxAgentWrapupTime int 最大座席整理态时长（s）

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "skillIds":[1,2] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 }, { "skillId": 2, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 } ], "resultDesc": [ { "skillId": 1, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 }, { "skillId": 2, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 } ] }

请求说明 表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。

响应说明 该接口的响应说明如下： 下载失败时： 消息头Content-Type: application/json;charset=UTF-8 消息体示例请参见报文样例 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 预留字段 下载成功时： 消息头 Content-Type: application/octet-stream;charset=utf-8 消息体 文件流