华为云用户手册

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

请求说明 表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 offset int True offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。取值范围：1～100 3 url String False 调用url 该参数有值，查询当前url的调用记录。 该参数为空时，查询所有接口调用记录。 4 beginTime String True 开始时间 格式：yyyy-MM-dd HH:mm:ss 5 endTime String True 结束时间 格式：yyyy-MM-dd HH:mm:ss 结束时间和开始时间间隔不大于7天

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

呼叫到达通知事件 标示符 AgentEvent_Incoming_CallInfo 作用 用户呼入场景，提醒座席有会话进入。 附带信息 callId表示呼叫唯一标记。 skillName表示技能队列名称 skillId表示技能队列ID caller表示主叫号码 called表示被叫号码 lastReleaseAgentId表示最后一次释放该呼叫的座席ID mediaType表示媒体类型，其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat releaseAndReQueueCount表示被座席释放并重路由次数 releaseAndReQueueCallFlag表示当前呼叫是否为被座席释放后重路由呼叫。0：不是，1：是。 示例： {"eventType": "AgentEvent_Incoming_CallInfo","workNo": "56020","content": {"callId": "1669951418-12166","skillName": "defaultVideoSkill","skillId": 1, "caller": "88880165","called": "310300","lastReleaseAgentId": 65535,"mediaType": 19,"releaseAndReQueueCount": 0,"releaseAndReQueueCallFlag": 0}} 父主题： 音视频通话事件

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

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body False 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body False 用户标识。（语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id） 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码； 2、语音外呼问卷场景时为流程接入码； 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码,当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid,其他场景此值为空 不超过32位 auth_token String body True 授权信息,取接入控制系统返回的token值。

报文样例 请求头: { "ccmessaging-token": "eyJjcmVhdGV*************2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D", "x-app-key": "ea5c29a3*************a3dbeb4c32c", "Authorization": "Bearer 57042f*************968c4e0", "Content-Type": "application/json" } 请求参数: { "callId": "111111222111", "caller": "138****7777", "leaveMessage": "请回复电话", "channel": "WEB" } 响应参数: { "resultCode": "0", "resultDesc": "Save leaveMessage success!" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口生成的ccmessagign-token 2 x-app-key string True appKey字段，用户标识，在API Fabric工具上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 callId string True 用户ID，取值范围：1到24位字符串。 1.2 caller string True 留言号码 1.3 leaveMessage string True 留言信息 1.4 channel string True 渠道名称，WEB

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 响应返回码 1.2 resultDesc string 响应返回描述。 如果resultCode返回0：无返回或Save leaveMessage success! 如果resultCode返回3：the leaveMessageParams is error. 如果resultCode返回13：Exception appeared!或Save leaveMessage failed! 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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。 无请求消息体。

接口URL 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。

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

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

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

接口URL 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天，

错误结果码 表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/agentgateway/resource/voicecall/{agentid}/transfer 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表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 devicetype int True 转移设备类型，技能队列为1，业务代表为2，IVR设备为3，系统接入码为4，外呼号码为5。 2 address string True 转移地址，最大长度24。取值范围： 当devicetype为1时，配置技能队列的编号ID，只允许配置数字。 当devicetype为2时，配置待转移座席的座席工号，只允许配置数字。 当devicetype为3时，配置IVR流程接入码，只允许配置数字。 当devicetype为4时，配置系统接入码，只允许配置数字。 当devicetype为5时，配置外呼号码，允许配置范围：0~9、A~E、a~e、*、#。 3 mode int True 转移模式。 当devicetype值为1时取值： 0：释放转 2：成功转 当devicetype值为2时取值： 0：释放转 2：成功转 3：指定转（转移到座席的私有技能队列：暂时转移方式不对外开放） 当devicetype值为3时取值： 0：释放转 1：挂起转 说明： 挂起转可以转音视频IVR流程，不能转座席。 当devicetype值为4时取值： 0：释放转 2：成功转 当devicetype值为5时取值： 1：释放转（呼出时不支持向指定外呼号码释放转） 2：成功转 3：通话转 4：三方转 4 callappdata string False 需设置的随路数据。内容可为空，最大长度为16k。 5 caller string False 主叫号码。（内容可为空，为空时为平台默认主叫号码，0-24位数字）。在转外部号码时有效。并且当转出方式为“释放转”时，该参数值无效，即不能携带指定的主叫号码。 6 mediaability int False 媒体能力。（默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。在转外部号码时有效，其他方式的转移根据座席的类型来判断是否带媒体能力） 7 holdflag boolean False 三方转时是否保持呼叫，取值为false时不保持，true为保持，默认为true 8 skillId Integer 可选 技能ID。当devicetype为业务代表为2时，设置该字段才有效。

触发事件 对方振铃（AgentEvent_Customer_Alerting） 座席进入（AgentEvent_Talking） 连接失败（AgentEvent_Connect_Fail） 座席挂断呼叫（AgentEvent_Call_Release） 转移模式为成功转时： 成功转结果通知（AgentEvent_SuccTransResult） 停止录音成功（AgentMediaEvent_StopRecordDone） 转移模式为三方转时： 三方通话成功（AgentEvent_Conference） 转移模式为挂起转 从IVR返回（AgentEvent_ReturnFromIvr）

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "devicetype": 2, "mode": 3, "address": "49998", "callappdata": "", "caller": "40040", "mediaability": 0, "holdflag": "true" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

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

请求说明 表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 Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId": "1647265024-xxxx", "beginTime": 1647265028000, "endTime": 1647265029000 } 响应参数: { "returnCode": "0", "satisfactionEvaluations": { "channel": "audio", "evaluationValue": "5", "npsScore":"8", "evaluationTime": 1647265028000, "fcrValue":"1", "evaluateObject":"Agent" }, "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 npsScore String False NPS分值。 NPS为推荐类的评分，即愿意推荐我们的产品/服务给朋友或同事吗？ 取值范围1~9 1.3.4 evaluationTime number False 评价时间，毫秒级别Timestamp时间戳类型 1.3.5 fcrValue String False 客户对于首次解决率（First Call Resolution）的满意程度，即询问客户此次服务是否解决了问题。 1：是 2：否 1.3.6 evaluateObject String False 被评价的对象 Agent：座席 Bot：机器人 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求消息样例 { "userId": "1649209493813571405", "sentence": "查询话费", "tenantId": "202205125916", "language": "zh_CN", "targetIntentCount": "2", "confidence2Top": "0.5", "authToken": "Xun4*******************yAmResnf", "context":"查询话费", "domainList":[10039], "faqGroupList":[10952,10950] } 响应消息样例 { "intentsResponses": [ { "scenarioStatus": "finish", "confidence": 1.0, "responses": "尊敬的用户,您当前话费账户余额为56元。", "scenarioName": "话费查询", "commands": "查询话费" } ], "errorCode": 0 } 请求消息样例(包含FAQ问答) { "userId": "1649209493813571405", "sentence": "优惠套餐推荐", "tenantId": "202205125916", "language": "zh_CN", "targetIntentCount": "2", "confidence2Top": "0.5", "authToken": "Xun4vb*******************mResnf", "context":"", "domainList":[10039], "faqGroupList":[10952,10950] } 响应消息样例 { "intentsResponses": [ { "simQuestions": [ "有实惠一点的流量套餐可以办理" ], "scenarioStatus": "SUC CES S", "confidence": 23.0, "responses": "本月特惠,10元3G流量。", "scenarioName": "1721756338", "commands": "systemQA" } ], "errorCode": 0 }

接口调用流程 在本部分中，我们将介绍用户与座席进行文字交谈时的接口调用过程。通过详细的步骤描述和接口说明，开发人员可以了解如何利用 AICC 提供的接口，实现用户与座席之间的无缝文字交流。下面是多媒体交谈的整个过程。 图1 多媒体信息交谈 图2 多媒体交谈结束 1. 调用第三方请求鉴权接口applyToken，生成客户端访问的Token信息。该token对应其他接口请求头中ccmessaging-token字段。 2. 获取接口请求鉴权token后，可以选择是否展示该用户对应的历史消息。若需要展示，则调用queryHistoryChatMessage接口查询历史消息。 3. 与AICC的座席进行多媒体交谈时，首选需要与座席建立连接，调用send接口或者sendAsync接口，发送消息类型为CONNECT的消息（即消息请求体中controlType字段为CONNECT），请求与座席或机器人建连。 send接口是同步接口，sendAsync为异步接口，两者实现的功能完全相同，使用异步消息处理可以降低请求耗时。 4. 若建立连接失败，用户可以给座席留言，通过doLeaveMessage接口将留言内容发送给AICC进行处理。提交留言后，本次会话流程结束。 5. 若建立连接成功，需要主动轮询poll接口获取座席侧发送过来的消息。在会话期间，若不调用该接口，超过CCU CS 配置的默认会话时间，会话会被自动释放。 6. 轮询poll接口获取座席侧发送的消息，如果是多媒体类型的消息（图片、音频、视频等消息），则需要调用downloadFileStream接口获取多媒体资源。 7. 与座席建连成功后，需要调用queryQueueInfo检查当前用户是否处于排队状态，若处于排队状态则用户需要进行等待。并持续调用queryQueueInfo接口检查当前是否处于排队状态。 8. 若处于非排队状态，用户可以与座席或者机器人进行交谈。 9. 发送消息时可以调用queryPhraseByKeyword接口，根据客户输入的内容查询联想常用语。该步骤非必选。 10.若用户发送的消息是多媒体类型的消息，则需要调用uploadFileStream接口将对应的多媒体文件上传到文件服务器上。 11.无论是多媒体消息还是文字消息，均需要调用send/sendAsync接口，将消息发送给座席。 12.用户与座席交谈结束后，调用getSatisfactionSurveyMode接口查询配置的满意度调查信息。 13.若当前渠道未配置满意度调查，则调用send/sendAsync接口发送断连消息（请求体中controlType字段为IDSCONNECT），本次会话结束。 14.若配置了渠道满意度调查，且当前接入为座席，则调用saveSatisfaction接口提交对座席的满意度，并发送断连消息。 15.若配置了渠道满意度调查，且当前接入为机器人，则调用feedbacksatisfaction提交对机器人满意度评价，并发送断连消息。 父主题： 场景1 多媒体消息交谈

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body False 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body False 用户标识。（语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id） 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码； 2、语音外呼问卷场景时为流程接入码； 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码,当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid,其他场景此值为空 不超过32位 auth_token String body True 授权信息,取接入控制系统返回的token值。

请求消息样例 { "userid": "1528780879-9581", "inaction": 13, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian" } } ODFS接收到inaction为13的请求后,检索该呼叫从宇高上报识别结果队列是否有数据,如果有数据,就给IVR返回1,否则返回0：

消息样例 场景描述：获取机机接口access-token 请求方法：POST URL：https:// 域名 /baas/auth/v1.0/oauth2/token 请求头： { "Content-Type":"application/x-www-form-urlencoded" } 请求体： grant_type=client_credentials&client_id=******78ae8513******&client_secret=*******fb64********* 响应： { "access_token": "ACCESS_TOKEN", "expires_in": 7200, "token_type": "Bearer" } 根据请求响应中获取的access-token访问机机接口。

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