华为云用户手册

响应说明 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码。取值范围： 0为成功 1为失败 2 description String 请求结果描述。 3 datas List 请求结果对象，参数说明详见表4 表4 datas对象参数说明 序号 名称 参数类型 说明 1 coluKngId String 栏目知识id。 2 coluKngName String 栏目知识名称。 3 coluKngType String 栏目知识类型。 4 beyondColuId Number 所属栏目ID。首层栏目的所属栏目ID为0 5 beyondColuPath Number 所属栏目路径。首层栏目所属路径为/ 6 coluType Number 栏目类型。 7 code Number 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 8 superCode Number 栏目上级编码。 9 id String AppCube id。

报文样例 请求头 Content-Type: application/json;charset=UTF-8 X-TenantSpaceID：******** Authorization: ****************** 请求参数 { "beyondColuId": "0" } 响应参数 { "returnCode": "0", "description": "success", "datas": [ { "coluKngName": "lzd0916父栏目", "code": "001", "coluType": 1, "coluKngType": 1, "superCode": "-1", "id": "caBE000000wqY7oYeYPA", "beyondColuId": "0", "beyondColuPath": "/", "coluKngId": "63e3e4b42c94482b95e04e911f497fbb" } ] }

请求说明 表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 beyondColuId String True 无 所属栏目ID。首层栏目的所属栏目ID为0 2 ccId Number False 无 呼叫中心id。AKSK鉴权必填。 3 vdn Number False 无 vdnId。AKSK鉴权必填。

音视频切换 标示符 AgentEvent_MediaSwith 作用 音频呼叫切换视频呼叫场景中，座席调用音视频切换接口，选择媒体类型为视频，调用成功后呼叫从音频切换到视频时，座席会收到该事件，reason为0时表示从IVR返回成功。 附带信息 reason表示切换原因码，0代表成功，其余为失败。 caller表示主叫号码。 called表示被叫号码。 callId表示呼叫唯一标记。 mediaType表示媒体类型。 示例： {"eventType":"AgentEvent_MediaSwith","workNo":"111","content":{"callid":"1603286369-16773","reason":0,"caller":"","mediaType":3,"called":"88022","jsonKey":["callid","reason","caller","mediaType","called"]},"jsonKey":["eventType","workNo","content"]} 父主题： 音视频通话事件

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：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/recordplay/{agentid}/netplay 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

报文样例 场景描述：客户接收座席发送的多媒体库文件 请求参数: { "fileType": "jpg", "channel": "WEB", "fileId": "XXXXXXXXXXXXXXXX", "multiMedia":"multiMedia" } 响应参数: { "resultCode": "0", "fileUrl": "https://IP:PORT/ccmessaging/202307260369/agent/202307260369134944/1111111111114/e43f69a2-01ee-48ec-82cd-bdf8447492e0.png?AccessKeyId=5BKCLVUJC700HY9M51AT&Expires=1716445961&Signature=LDYl%2FfEpaLbpvlxfEnYxW8QdevY%3D", "fileStream": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCAA9ADwDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcI" } 场景描述：客户接收座席发送的本地文件 请求参数: { "fileType": "png", "channel": "WEB", "fileId": "local/XXXXXXXXXXXXXXXX" } 响应参数: { "resultCode": "0", "fileUrl": "https://IP:PORT/ccmessaging/202307260369/agent/202307260369134944/1111111111114/e43f69a2-01ee-48ec-82cd-bdf8447492e0.png?AccessKeyId=5BKCLVUJC700HY9M51AT&Expires=1716445961&Signature=LDYl%2FfEpaLbpvlxfEnYxW8QdevY%3D", "fileStream": "iVBORw0KGgoAAAANSUhEUgAAACEAAAAnCAYAAACBvSFyAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAA7SURBVFhH7c6hEQAgDAAx1uj+gxbB/QyYiPicmdnfJCIRiUhEIhKRiEQkIhGJSEQiEpGIRCQiEYln9gJ7uXthjovHaAAAAABJRU5ErkJggg==" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string True appKey字段，用户标识，在API Fabric工具上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 fileId string True 文件下载的fileId，在poll接口中携带 fileId取值 "local/" + content（poll接口响应）时，判定为发送本地文件。若不携带，则判定发送多媒体库文件。 1.2 channel string True 下载渠道类型，当前固定为WEB。 1.3 fileType string True 下载的文件类型，支持jpg，png，bpm，mp3，aac，mp4，txt，csv，richtext，doc，docx，pdf，zip。 发送本地文件场景下，该参数为多媒体文件下行消息中mediaFileType字段。 1.4 multiMedia string False 如果文件为多媒体库文件时，该参数必填，并且需要配置为“multiMedia”。

响应说明 响应状态码: 200 表4 RspBody参数结构 序号 名称 参数类型 说明 1.1 fileStream string Base64编码后的文件流。 1.2 resultCode string 响应返回码，0表示成功，非0表示失败 0：成功，不反悔提示信息 401：objectKey is null! 13：param filetype Out of range!或empty file!或fsservice downloadFile is failed或downloadFileStream IOException或downloadFileStream exception 2：param channelId or userId or tenantId is null 1.3 resultDesc string 响应返回描述，0表示成功，非0表示失败。 1.4 fileUrl string 接收文件临时查看链接。默认保留24小时。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

转出结果通知 标示符 AgentEvent_linkagePhoneTransferOut_Result 作用 表示话机联动转出的结果。 附带信息 result：0表示转出成功，其他表示失败。 callId：表示联动转出的呼叫唯一标记。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneTransferOut_Result","workNo":"130","content":{"result":1138,"callId":"1481881644-21"}}} 父主题： 话机联动事件

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "isCallin":"true", "callId":"1000000000-0001" } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "vdn": 1, "callId": "1000000000-0001", "callerNo": "10000", "calleeNo": "10001", "callType": 0, "agentId ": 100, "skillId": 1, "anonyCall": 0, "queueWaitTime": 10, "ivrCallTime": 0, "ackTime": 5, "callTime": 30, "releaseCause": 0 }, "resultDesc": { "vdn": 1, "callId": "1000000000-0001", "callerNo": "10000", "calleeNo": "10001", "callType": 0, "agentId ": 100, "skillId": 1, "anonyCall": 0, "queueWaitTime": 10, "ivrCallTime": 0, "ackTime": 5, "callTime": 30, "releaseCause": 0 } }

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

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 vdn int 虚拟呼叫中心编号。 2.2 callId string 呼叫ID。 2.3 callerNo string 呼叫的主叫号码。 2.4 calleeNo string 呼叫的被叫号码。 2.5 callType int 呼叫类型，请参见表1 2.6 agentId int 座席工号。 2.7 skillId int 技能队列编号。 2.8 anonyCall int 匿名呼叫标识。(只有呼入时才有值) 2.9 queueWaitTime int 队列等待时长（秒）。 2.10 ivrCallTime int IVR通话时长(秒)。 2.11 ackTime int 应答时长(秒)。 2.12 callTime int 通话时长(秒)。 2.13 releaseCause int 呼叫释放原因码，请参见呼叫释放原因码 2.14 beginTime string 呼叫开始时间(预测外呼，预占用外呼时才有值) 格式：yyyy-MM-dd HH:mm:ss 2.15 endTime string 呼叫结束时间(预测外呼，预占用外呼时才有值) 格式：yyyy-MM-dd HH:mm:ss 2.16 result string 呼叫结果(预测外呼，预占用外呼时才有值) "0000"：OBS转自动前呼出成功 "0900"：OBS转人工前呼出成功 "0101"：呼出失败 "-1"：标识当前的任务没有号码可呼 "0601"：退回 2.17 resultCode string 呼叫结果码(预测外呼，预占用外呼时才有值) 失败的原因码对应的外显结果码。外显结果码可以自定义，失败原因码与外显结果码相互关联 2.18 busiResult string 外呼业务结果编码(预测外呼，预占用外呼时才有值) isales前台页面配置，如何配置请参见操作指南 2.19 busiSubStatus string 外呼业务结果子状态编码(预测外呼，预占用外呼时才有值) isales前台页面配置，如何配置请参见操作指南

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

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/failcategorystatistics?campaignId={campaignId}&startDate={startDate}&endDate={endDate} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId String True 外呼数据ID 3 startDate String False，该字段有值，则endDate必传。 查询开始时间 格式： yyyy-MM-dd 4 endDate String False，该字段有值，则startDate必传。 查询结束时间 格式： yyyy-MM-dd 结束时间-开始时间小于等于30天，

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "statDate": "2022-10-14", "failData": { "01119": 1, "01153": 4, "01169": 2 } }, { "statDate": "2022-10-18", "failData": { "00701": 1 } } ], "resultCode": "0200000", "resultDesc": "query success", "returnDesc": "query success" }

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "name": "defaultMediaSkill", "id": 1, "mediatype": 53 }, { "name": "defaultAudioSkill", "id": 3, "mediatype": 5 } ], "message": "success", "retcode": "0" }

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 name string 技能名称 。 3.2 id int 技能ID。 3.3 mediatype int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workno string True 待查询的座席工号，取值范围为101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

基本信息 给第三方接入方调用,实现文本分类、实体识别能力,可应用于智能座席助手的智能工单分类场景。智能座席助手,通过调用文本分类接口进行完整的工单分类；通过调用实体识别接口,提取工单信息中的工单实体,完善工单；进一步增强智能座席助手的能力。 对接Customer Service Platform系统时,采取Headers头部的userName+token组合鉴权方式,其中userName为ipcc,token获取方式参见C3 智能助手平台接口鉴权方式。 对接其他第三方系统,采取请求体的authToken鉴权方式。

报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId": "1647265024-xxxx", "beginTime": 1647265028000, "endTime": 1647265029000 } 响应参数: { "returnCode": "0", "satisfactionEvaluations": { "channel": "audio", "evaluationValue": "5", "evaluationTime": 1647265028000 }, "description": " query Success" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 结果返回码，0表示查询成功，-1表示查询失败，description表示失败具体原因 1.2 description string True 结果返回描述 1.3 satisfactionEvaluations object True 满意度评价 1.3.1 evaluationValue string False 满意度评价，为满意度等级配置的字典key值。 “1”表示“很不满意”， “2”表示“不满意”， “3”表示“一般”， “4”表示“满意”， “5”表示“很满意” “-1”表示“超时未回复”，指用户收到满意度评价后，评价超时， “-2”表示“评价错误”指用户回复的满意度，不在满意度配置的按键值中。 1.3.2 channel string False 渠道： audio表示音频渠道，MSG表示短信，WEB表示网页文字交谈渠道 1.3.3 evaluationTime number False 评价时间，毫秒级别Timestamp时间戳类型 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestBody object True 请求入参 1.1 callId string True 通话标识callId 1.2 beginTime number True 评价开始时间，毫秒级别Timestamp时间戳类型 1.3 endTime number True 评价结束时间，毫秒级别Timestamp时间戳类型

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "EID": "8888*", "limit":"100", "offset":"0" } 响应参数： { "resultCode": "0100000", "resultDesc": { "data": { "10.xx.xx.xx#1": [ { "socketStatus": "uninstall", "terminationType": "sip", "ipAndPort": "0.0.0.0:0", "ccuModuleNumber": "56", "registerStatus": "not register", "monitorFlag": "unstarted", "protocolType": "invalid protocol", "equipmentId": "88881757", "roamIpAndPort": "0.0.0.0:0", "tlsStatus": "uninstall", "ipType": "IPv4" } ], "10.xx.xx.xx#2": [ { "socketStatus": "uninstall", "terminationType": "sip", "ipAndPort": "0.0.0.0:0", "ccuModuleNumber": "56", "registerStatus": "not register", "monitorFlag": "unstarted", "protocolType": "invalid protocol", "equipmentId": "88881757", "roamIpAndPort": "0.0.0.0:0", "tlsStatus": "uninstall", "ipType": "IPv4" } ] }, "count": 1 } }

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 10.xx.xx.xx#1 String 10.xx.xx.xx：UAP IP “#”：固定分隔符 “1”：UAP编号 表4 resultDesc对象参数说明 参数名 数据类型 说明 data list 数据结果集 count int 总记录数 表5 data对象参数说明 参数名 数据类型 说明 ccuModuleNumber string CCU模块号 terminationType string 终端类型 equipmentId string 设备标识 registerStatus string 注册状态：registered 已注册 not register 未注册 socketStatus string SOCKET状态： fault 故障 normal 正常 connecting 连接中 uninstall 未配置 ipAndPort string ip和Port monitorFlag string 座席状态监控标志： unstarted 未启动 started已启动 protocolType string 协议类型 roamIpAndPort string 漫游ip地址和端口 tlsStatus string TSL状态：unconnect 未连接 connect 连接 uninstall 未配置 ipType string ip类型

响应消息 表3 响应消息参数体说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 表4 resultDesc对象参数说明 参数名 数据类型 说明 ccId int 呼叫中心编号。 tenantId string 租间ID。 tenantSpaceName string 租间名称 vdnId int 虚拟呼叫中心编号 accessCodes array 接入号列表。 该数组中对象的参数说明请参见“表4 accessCodes 对象参数说明”。 agents array 座席列表。参见“表5 agents对象参数说明” 表5 accessCodes 对象参数说明 参数名 数据类型 说明 accessCode string 接入号。 isDefault boolean 默认接入码标识，true:默认接入码，false或者空:非默认接入码。 表6 agents对象参数说明 参数名 数据类型 说明 workNo int 座席工号。 sipAccount string 软电话号码。 accountCode string 座席账号。 agentType int 座席类别。 4：音频座席；5：多媒体座席；11：视频座席。只在集成部署时返回此字段。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId": 1, "tenantId": "202306131208", "limit": 10000, "offset": 0 } 响应参数： { "resultCode": "0100000", "resultDesc": { "ccId": 3, "vdnId": 47, "tenantId": "202008142460", "accessCodes": [ { "accessCode": "202008191", "isDefault": true } ], "tenantSpaceName": "fjw081401", "agents": [{ "workNo": 111, "sipAccount": "88880001", "accountCode": "123", "agentType": 4 }] } }

报文样例 场景描述：创建业务场景 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "group_name": "业务场景1", "description": "业务场景", "ignore_sensitive": 0, "other": { "type": 0, "connected_call_type": 0, "call_from": 1622536490000, "call_end": 1625042093000 } } 响应参数: { "group_id": "groupid_48450728-6b9d-4942-9884-2c5405e974d0", "resultCode": "0406000", "resultDesc": "创建业务场景成功" }