华为云用户手册

请求说明 表1 请求消息头参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 2 X-TenantSpaceID String True 无 租户id（SIA鉴权填写）。 3 X-Access-Token String True 无 生成方式参见SIA鉴权（SIA鉴权填写）。 4 Authorization String True 无 生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。 表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鉴权必填。

报文样例 请求头 Content-Type: application/json;charset=UTF-8X-TenantSpaceID：********Authorization: ****************** 请求参数 { "fileKey": "1286999405181796356", "kngId": "1286999404577816579"} 响应参数 { "returnCode": "0", "description": "success", "url": "https://aicc-develop-lab.obs.cn-north-1.myhuaweicloud.com:443/ccikbs/file/202209065604/9bda03e5-a538-404a-b719-869575b56edd?AccessKeyId=22QW**********B0GF&Expires=1665650432&Signature=tQMT**********pE%3D"}

响应说明 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码。取值范围： 0为成功 1为失败 2 description String 请求结果描述。 3 data Object 请求结果对象，参数说明详见表4 表4 data对象参数说明 序号 名称 参数类型 说明 1 url String 当前知识附件obs下载地址

请求说明 表1 请求消息头参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 2 X-TenantSpaceID String True 无 租户id（SIA鉴权填写）。 3 X-Access-Token String True 无 生成方式参见SIA鉴权（SIA鉴权填写）。 4 Authorization String True 无 生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 kngId String True 无 知识id。参数值为APPCube数据库的数据表中的AICC_kngId_CST字段值，具体数据表根据知识状态查询AICC__Ikbs_Kngadjedit__CST、AICC__Ikbs_Columnknghis__CST或者AICC__Ikbs_Kngadjpre__CST表。 2 fileKey String True 无 文件id。参数值为APPCube数据库的数据表中的AICC_adjKey_CST字段值，具体数据表根据知识状态查询AICC__Ikbs_Kngadjedit__CST、AICC__Ikbs_Columnknghis__CST或者AICC__Ikbs_Kngadjpre__CST表。 3 ccId Number False 无 呼叫中心id。AKSK鉴权必填。 4 vdn Number False 无 vdnId。AKSK鉴权必填。

报文样例 查询elasticsearch上的话单数据以及满意度信息。 请求头: Authorization:Bearer 3b5d****23c9 X-app-key:b7bd****cb8c 请求参数: { "subCcNo": "0"， "vdn": "0"， "callId": "0"， "callerNo": "0"， "calleeNo": ""， "beginDate": "1658102400000"， "endDate": "1658188800000"， "callType": "0"， "mediaType": "10"， "evaluationValue": "10"} 响应参数: { "total":2， "results":[ { "callId":"1669464198-17002955"， "vdn":1， "evaluationValue":"1"， "callBegin":"100010" }， { "callId":"1669463446-17002406"， "vdn":1， "evaluationValue":"5"， "callBegin":"100010" } ]}

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

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

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

AK/SK获取方式 AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名。 私有AK、SK获取方式 集成环境：请联系运营人员获取。 接口鉴权如果通过 ，则http响应码为200；如果不通过，则http的响应码为401。

响应说明 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码。取值范围： 0为成功。 1为失败。 2 description String 请求结果描述。 3 data Object 请求结果对象，参数说明详见表4 表4 data对象参数说明 序号 名称 参数类型 说明 4.1 relVersionNum String 发布版本号。 4.2 coluType String 栏目类型。取值范围： 1：正常栏目 2：历史栏目 (只有栏目知识类型为栏目时才有意义) 4.3 code String 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 4.4 coluKngType Number 栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识 4.5 creationTime Number 创建时间。 4.6 releaseTimes Number 知识发布次数。 4.7 orderId Number 排序编号。 4.8 kngStatus Number 知识状态。取值范围： 1：新建 2：审核 3：发布 4：更新 5：驳回 4.9 kngSize Number 知识内容的大小。单位为KB。 4.10 creatorId String 创建人工号。 4.11 modifierId String 修改人工号。 4.12 beyondColuPath String 所属栏目路径。首层栏目所属路径为/。 4.13 coluKngName String 栏目知识名称。 4.14 modifyTime Number 修改时间。 4.15 validEndTime Number 有效期结束时间。 4.16 summaryInfo String 概要信息。 4.17 serviceStatus Number 业务状态。取值范围： 1：普通 2：热点 3：新业务 4：更新业务 5：过期 4.18 clickNum Number 点击次数。 4.19 servicesEndTime Number 业务有效期结束时间。 4.20 keyword String 关键字。 4.21 coluKngId String 栏目知识id。 4.22 curVersionNum Number 当前版本号。 4.23 validStartTime Number 有效期开始时间。 4.24 displayFlag Number 栏目知识展示标志。取值范围： 0：不展示 1：展示 4.25 kngPath String 知识路径。 4.26 superCode String 栏目上级编码。 4.27 beyondColuId String 所属栏目ID。首层栏目的所属栏目ID为0 4.28 servicesStartTime Number 业务有效期开始时间。 4.29 partdbId String 分区id。 4.30 tenantId String 租户id。 4.31 creatorName String 创建人名称 4.32 pre Object 上一个知识。参数说明详见表5 4.33 next Object 下一个知识。参数说明详见表5 4.34 kngContent String 知识内容。 4.35 kngFiles List 附件列表。参数说明详见表6 4.36 relaKngs List 关联知识列表。参数说明详见表7 表5 pre/next对象参数说明 序号 名称 参数类型 说明 1 coluKngId String 栏目知识id。 2 coluKngName String 栏目知识名称。 3 coluKngType Number 栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识 表6 kngFiles对象参数说明 序号 名称 参数类型 说明 1 adjKey String 附件key。 2 creationTime String 创建时间戳。 3 orderId String 排序编号。 4 versionNum Number 版本号。 5 adjId String 附件id。 6 kngId String 知识id。 7 creatorId String 创建人工号 8 adjName String 附件名称。 9 adjClass Number 附件类别。取值范围： 1：内置（属于知识的一部分，比如插入到知识内容中的图片、FLASH文件） 2：外置（上传的知识附件） 10 adjSize Number 文件大小。 11 partdbId Number 分区id。 12 tenantId String 租户id。 13 adjType String 附件类型。 表7 relaKngs对象参数说明 序号 名称 参数类型 说明 1 coluKngId String 栏目知识id。 2 coluKngName String 栏目知识名称。 3 coluKngType Number 栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识 4 serviceStatus Number 业务状态。取值范围： 1：普通 2：热点 3：新业务 4：更新业务 5：过期

请求说明 表1 请求消息头参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 2 X-TenantSpaceID String True 无 租户id（SIA鉴权填写）。 3 X-Access-Token String True 无 生成方式参见SIA鉴权（SIA鉴权填写）。 4 Authorization String True 无 生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 coluKngId String True 无 栏目知识id。 2 openType String True 无 知识打开途径。取值范围： 1：快捷入口 2：搜索 3：栏目 4：收藏夹 5：关联知识 3 openKng String False 无 openType为5时必填。关联知识id。 4 searchRank String False 1 openType为2时必填。检索结果序号。 5 searchSortType String False 无 openType为2时必填。检索排序方式，取值范围： hit：命中率 modifyTime：更新时间 clickNum：点击量 bidRankId：竞价排行 6 searchWord String False 无 openType为2时必填。关键字。 7 ccId Number False 无 呼叫中心id。AKSK鉴权必填。 8 vdn Number False 无 vdnId。AKSK鉴权必填。

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/setcustomstate?customstate={customstate} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 customstate integer True 座席自定义状态，取值范围：0~65534。 说明： 由业务侧统一定义具体含义。

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

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

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

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/snatchpickup?destWorkNo={destWorkNo} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTP（或HTTPS）端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 destWorkNo int True 被代答座席工号。 取值的类型为整数，取值范围为101～59999。

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

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 callid string False 呼叫callid 2 mode int True 拒接模式，1：呼叫回原队列、座席示忙；2：呼叫释放、座席空闲 拒接模式是针对普通场景（用户呼入，座席拒接）进行说明的，对于复杂场景，例如内部求助、转移等场景，需要根据具体场景来判断拒接效果。

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

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "fileName": "Y:/12/0/20211019/155/1406470.V3", "position": "0", "playTime": "1", "fileFormat": "0", "ccId": "1", "locationId": "-1"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}

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

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

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

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/statisticsEx 其中，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 talktime long 本次签入后总通话时长，单位：s。 3.2 answernums int 本次签入后接听次数 3.3 calloutnums int 本次签入后外呼次数

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

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 mediaType string True 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 2 callnums string True 座席最大会话数，最大值：60，最小值：1。

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid": "1552524689-16797284", "caller": "88880021", "devicetype": 2, "mode": 2, "address": "205", "calldata": "help"} 响应参数 { "message": "success", "retcode": "0"}