华为云用户手册

场景描述 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

报文样例 该接口的请求消息体举例如下： { "id": 1318795089, "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "" }

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

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 id int True 特殊日期的id。 2 name String True 特殊日期名称。 名称不能重复，最大长度为30个字符。 3 type int True 特殊日期的类型。 取值范围： 1：按周设置 2：按日期设置 3：按日期重复 4 week String False 星期，特殊日期的类型为按周设置时为True。 取值范围： 1：星期一 2：星期二 3：星期三 4：星期四 5：星期五 6：星期六 7：星期天 同时选择多天时以逗号分隔，例如“6,7”表示星期六、星期天 5 beginTime String False 开始时间，特殊日期的类型为按日期设置或按日期重复时为True。 特殊日期的类型为2时，数据格式：yyyy-MM-dd 特殊日期的类型为3时，数据格式：MM-dd 6 endTime String False 结束时间，特殊日期的类型为按日期设置或按日期重复时为True。 特殊日期的类型为2时，数据格式：yyyy-MM-dd 特殊日期的类型为3时，数据格式：MM-dd

概述 本文档是AICC智能客服软件对外提供的网页客户端接口参考，专为第三方开发者设计，使他们能够将AICC的多媒体交谈功能集成到PC端的Web应用中。通过本文档，开发者可以全面了解到如何在云客服系统中实现座席与用户的在线交流。 文档详细介绍了接入智能客服系统所需的各种接口，涵盖了功能描述、调用顺序以及如何优化用户交互体验。对于每一个由AICC提供的接口，本文档都提供了详尽的请求参数、响应数据说明以及示例报文，旨在帮助开发者快速理解和实现接口调用。本参考文档不仅是一个技术指南，更是第三方开发者与AICC智能客服软件对接的桥梁，确保开发者能够高效、准确地实现所需功能，进而提升最终用户的服务体验。通过本文档，开发者将能够： 理解云客服系统中座席与用户进行在线聊天的基本流程。 掌握各接口功能及其在业务流程中的作用。 遵循最佳实践，有效地调用和管理接口。 父主题： 网页客户端接入

报文样例 请求头: { "Content-Type": application/json "x-app-key": ******************** "Authorization": Bearer ************************ } 请求参数: { "offset":0, "limit":10, "type":2 } 响应参数: { "returnCode": "0", "description": "query success", "voiceInfo": [ { "tenant_id": "20******234", "uploaddate": 163*****4000, "voice_id": "113379*********9999", "name": "welcome", "voicecontent": "{\"0\":{\"languageId\":\"0\"，\"textcontent\":\"欢迎光临\"}}", "type": 2, "tenantSpaceName": "************" } ] }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 返回码，0：成功，其他失败（1：请求参数type不正确） 1.2 description string False 返回描述 1.3 voiceInfo object False 录音信息 1.3.1 tenant_id string True 租户id 1.3.2 uploaddate number True 上传时间，格式为timestamp 1.3.3 voice_id string True 录音id 1.3.4 name string True 录音名称 1.3.5 voicecontent string False 语音内容 1.3.6 type number True 类型 0：音频，2：text文本 1.3.7 tenantSpaceName string False 租户名称 1.3.8 auditaccount string False 审核者账号 1.3.9 noReference boolean False 提示音和故障音是否被引用 1.3.10 auditcomments string False 审核意见 1.3.11 auditdate number False 审核时间，格式为timestamp 1.3.12 scene number False 使用场景 1.3.13 uploadaccount string False 上传账号 1.3.14 isUpdateRec number False 是否是更新记录 1.3.15 status number False 回调状态 1.3.16 callbackTimes number False 回调次数 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。 生成方式参见C1 系统配置类接口鉴权方式。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody object True - 1.1 offset integer False 起始游标，即分页查询时的起始记录行号。 首次查询传入“0”。 后续查询其他分页时传入该分页的第一条记录的序号。返回记录中第一条记录序号为“0”，后续依次排序。例如每页为50条录，查询第二页时应传入“50”。 不传时默认0，无最大值限制 1.2 limit integer False 分页查询时的每页记录数，正整数，不传时默认100，最大值100，传入超过100的值也会转换为100 1.3 type integer False 录音文件类型 0：音频，2：text文本

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表21 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表21 4 returnDesc String 描述。 5 returnObject Object 参见表4

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 无请求消息体。

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

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 146, "name": "lizhan_test", "description": null, "status": 2, "strBeginTime": "2018-12-01", "strEndTime": "2018-12-02", "deviceType": 2, "callerNo": "10086", "maxAlertingTime": 20, "scheduleParam": { "workdayBeginTime1": "08:00", "workdayEndTime1": "12:00", "workdayBeginTime2": "13:30", "workdayEndTime2": "17:30", "workdayBeginTime3": null, "workdayEndTime3": null, "holidayBeginTime1": "09:00", "holidayEndTime1": "12:00", "holidayBeginTime2": "14:00", "holidayEndTime2": "17:00", "holidayBeginTime3": null, "holidayEndTime3": null }, "ivrParam": null, "skillParam": { "skillId": 1, "skillName": "Voice Skill Queue", "outBoundType": 2, "predictParam": { "predictMethod": 5, "expPredictParam": null, "agentPredictParam": null, "connectPredictParam": null, "offhookPredictParam": { "offHookRate": 100 } }, "previewParam": null }, "callBackUrl": "http://www.baidu.com" } }

请求消息样例 { "userid": "1528780879-9581", "inaction": 7, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbG*******************UzNSwian" } }

错误结果码 表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 参数个数不能大于规定个数

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callNoType/add 其中，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 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 callNoTypes List True 号码类型集合，最多20条。 最大长度为20个字符。 只能输入数字、英文、-。

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

报文样例 该接口的请求消息体举例如下： { "limit":10, "offset":0 } 该接口的响应消息体举例如下： { "returnCode": "0200000", "server": [ { "port": null, "ip": null, "filePath": null, "userName": "10", "serverId": "164681924997097701747271557174" }, { "port": "22", "ip": "10.21.124.175", "filePath": "/home/sftp", "userName": "isales", "serverId": "164690088271159234793429225848" }, { "port": "22", "ip": "192.168.0.1", "filePath": "/home/sftp", "userName": "huawei", "serverId": "164697340198671566909690908237" }, { "port": "8888", "ip": "1.1.1.1", "filePath": "/sftp/file", "userName": "isales", "serverId": "164765479785832713595318363505" }, { "port": "22", "ip": "10.1.1.1", "filePath": "/home/sftp", "userName": "zhangsan", "serverId": "164765490069279981932006087306" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/queryServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

响应说明 响应状态码: 200 收到消息后返回200 OK， 务必保证响应Content-Type为 application/json; charset=UTF-8 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求消息样例: POST /twopartiescall/statusnotify HTTP/1.1 Request: AppKey: CMCCGX_0001 X-Sdk-Date: 20210512T115430Z Content-Type: application/json;charset=UTF-8 Host: 10.10.10.10:9003 Authorization: SDK-HMAC-SHA256 Access=1******2F4J8Q5T, SignedHeaders=appkey;content-type;host;x-sdk-date, Signature=77c4******62f48bcb4873e1d9ad9c1acc34b9b { "appKey": "CMCCGX_0001", "remark": "2022091800", "telA": "1580****001", "telX": "184****0497", "telB": "158****0002", "calleeDisplay": "158****0001", "startTime": "20210512115422", "callerAnswerTime": "20210512115422", "calledAnswerTime": "20210512115422", "finishTime": "20210512115430", "callID": "cmccgx20210512195422", "releaseCause": "1", "callDuration": 8 } 响应消息样例: HTTP/1.1 200 OK Date: Mon, 12 Nov 2007 15:55:01 GMT Content-Length: xxx Content-Type: application/json; charset=UTF-8 { }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 AppKey string False ITA侧的appKey字段，用户标识 2 Host string True 指定请求资源的Internet主机和端口号。 hostname：axb服务IP或域名 port：端口号。 3 Content-Type string True 用于指明发送给接收者(即服务器端)的实体正文的媒体类型。 4 X-Sdk-Date string True 发起请求的时间 5 Authorization string True 鉴权字段，具体鉴权说明请参见ITA文档 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callID string True 呼叫唯一标识，下载录音文件使用 2 remark string True 来自发起呼叫时的标注。预留字段（当前信息为租间ID） 3 startTime string False 发起呼叫时间，精确到秒 格式YYYYMMDDHHmmss 4 finishTime string False 通话结束时间 5 callDuration string False 通话时长，单位秒，供参考。 以双方通话建立开始计算 6 callerAnswerTime string False 主叫应答时间 7 calledAnswerTime string False 被叫应答时间 8 releaseCause string False 呼叫结束事件携带，原因值 9 appKey string False 客户分配资源标识 10 telA string False 原主叫号码 11 telX string False 落地业务号码 12 telB string False 原被叫号码 13 calledDisplay string False 被叫号显号码

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "data": [ { "id": 11, "name": "周末", "type": 1, "week": "5,7", "beginTime": null, "endTime": null }, { "id": 14, "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24" } ] }

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

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 data List 查询成功后，返回的特殊日期信息列表数据。 参见表4。 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 5 returnDesc String 描述。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 无请求消息体。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json;charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 caller string False 主叫号码。内容可为空，为空时为平台默认主叫号码，0-24位数字 2 called string True 被叫号码。内容不可为空，1-24位数字或*或# 3 skillid int False 技能ID。数字类型，内容可为空，为空时为平台配置默认的技能队列ID。 4 callappdata string False 随路数据信息。可为空，最大长度为16k。 5 mediaability int False 媒体能力，默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。 说明： 视频呼音频，接听后会导致通话直接挂断，原因是媒体协商失败，推荐视频外呼时，mediaability配置为2，以最大能力呼叫。 6 userVideoDirection int False 用户视频方向。取值范围： 1：用户只接收视频不发送视频 2：用户只发送视频不接收视频 3：用户既发送也接收视频 4：不设置接收发送方向 缺省值：4。 说明： 仅在mediaability配置为1时，可使用该参数。