华为云用户手册

消息样例 场景描述：创建任务 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/task 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "taskInfo":{ "title": "test002", "description": "test001", "type": "Case", "ownerId": "10gg00000148QvgpaLAm", "relateId": "c6m80000014iXKHqDw3c", "dueDate": "2023-07-08 00:00:00", "contactId": "ciIy0000013y7cC8T2rA", "priority": "Low", "creatorId": "10gg00000148QvgpaLAm" } } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： { "resCode": "0", "resMsg": "成功", "result": {"taskId":"ccqG0000014iXvGKONQO"} }

报文样例 请求消息样例 { "tenantId":"00030010", "language":"en_US", "name":"", "pageNum":1, "pageSize":10, "authToken": "0*******************************" } 响应消息样例 { "data": [ { "id": 10003, "tenantId": "00030010", "name": "FAQ", "description": "", "language": "en_US", "updateTime": 1556260264000, "on": false, "amount": 1 }, { "id": 10005, "tenantId": "00030010", "name": "Social Security Related FAQ", "description": "", "language": "en_US", "updateTime": 1556260257000, "on": false, "amount": 1 }, { "id": 10002, "tenantId": "00030010", "name": "Service Provisioning", "description": "", "language": "en_US", "updateTime": 1554285568000, "on": false, "amount": 1 } ], "totalSize": 3 }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID language String body False 语言 英文：en_US、 中文：zh_CN、 西班牙语：es_ES、 阿拉伯语：ar、 泰语：th_TH、 葡萄牙语：pt_BR name String body False 名称 pageNum int body True 页码 分页查询,查询第几页,首页为1 pageSize int body True 每页多少条 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式

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

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

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

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

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回座席正在处理的呼叫callId数组。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回座席正在处理的呼叫callId数组。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "agentId":1099 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ "1605492949-1447" ], "resultDesc": [ "1605492949-1447" ] }

请求说明 表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 agentId int True 座席工号。 取值范围：101-59999

响应消息 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 返回消息 2 retcode string 操作的结果原因码。 取值类型为整数。 0：成功 非0：失败，具体见“错误码定义”章节 3 result object 返回结果。该对象参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 3.1 serverId string 业务客户端向CTI平台发起订阅注册请求且成功注册后，CTI平台返回的订阅任务编号。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "serviceCallBackUri": "https://10.10.10.1:8080/rest/cc-ai/nlrresult", "nlpFlag": "true", "flowAccessCode": "801166010768953344" } 响应参数 { "message": "success", "retcode": "0" }

接口URI https://IP:Port/agentgateway/resource/config/subscribe/modify?serverId=xxx 表1 URI携带的参数说明 序号 名称 参数类型 是否必选 说明 1 serverId string True CTI平台已存在的订阅任务的编号，也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

请求消息 消息头 表2 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 serviceCallBackUri string True 事件通知回调地址。 最大长度200。 2 nlpFlag boolean 必填 是否语义智能分析 3 flowAccessCode string 选填 流程接入码

错误结果码 表15 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200002 外呼活动的开始时间早于今天凌晨。 3 0200003 设备类型为技能队列的外呼活动已达到上限。如果需要继续新增，则先删除其他设备类型为技能队列的外呼活动。 4 0200004 设备类型为IVR的外呼活动已达到上限。如果需要继续新增，则先删除其他设备类型为IVR的外呼活动。 5 0200005 外呼活动名称不能重复。 6 0200017 技能队列ID不存在。 7 02000001 参数值为空 8 02000002 参数包含非法字符 9 02000003 参数长度不能大于规定长度 10 02000006 参数值类型不正确 11 02000007 参数值大小不正确 12 02000009 参数组合不正确，请检查请求参数

报文样例 该接口的请求消息体举例如下： { "name": "十一流量包推荐", "description": "十一流量包推荐", "strBeginTime": "2020-09-10 00:00:00", "strEndTime": "2020-10-07 23:59:59", "deviceType": 2, "callerNo": "10085", "maxAlertingTime": 20, "scheduleParam": { "workdayBeginTime1": "08:00", "workdayEndTime1": "11:30", "workdayBeginTime2": "13:00", "workdayEndTime2": "17:30", "workdayBeginTime3": "", "workdayEndTime3": "", "holidayBeginTime1": "10:00", "holidayEndTime1": "11:00", "holidayBeginTime2": "13:00", "holidayEndTime2": "17:30", "holidayBeginTime3": "", "holidayEndTime3": "" }, "skillParam": { "skillId": 5, "skillName": "Voice Skill Queue", "outBoundType": 2, "predictParam": { "predictMethod": 5, "offhookPredictParam": { "offHookRate": 100 } } }, "initStatus": 0, "callBackUrl": "https://10.10.10.10/xxx/xxx/xxx" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 46 } }

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":113, "groupName":"ceshipostman", "groupType":3, "remark":"此为质检组", "workNos":[50041,50042] } 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": "新增成功", "resultDesc": "新增成功" }

响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述

请求说明 表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 regularQualityTaskId number True 抽检任务ID，最大长度20位

报文样例 场景描述：暂停定时抽检计划 请求头: Content-Type:application/json x-app-key:xxxx-xxxx-xxxx-xxxx-xxxx x-UserId:xxxx Authorization:Bearer ******************************** 请求参数: { "regularQualityTaskId": 954637368599307266 } 响应头: Content-Type: application/json;charset=UTF-8 响应参数: { "resultCode": "0408000", "resultDesc": "操作成功" }

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

请求消息样例 如果呼叫转移成功,接入方先发起如下请求。 { "userid": "1528780879-9581", "inaction": 11, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "begin_trans": "2018090407:16:24", "end_trans": "2018090407:20:24", "trans_result":"0", "input": "", "inter_idx": "1" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } } 在收到ODFS的响应后,则再次发起如下请求。 { "userid": "1528780879-9581", "inaction": 11, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "begin_trans": "2018090407:16:24", "end_trans": "2018090407:20:24", "trans_result":"0", "input": "hangup", "inter_idx": "1" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } } 收到请求后,ODFS侧则再次返回拆线响应,接入方侧不需再调用ODFS侧接口,整个呼叫转移动作完成。 如果呼叫转移失败 传入上述参数后, 可能收到ODFS返回 outaction=9/10/11 类型的返回（由业务逻辑决定）

响应消息样例 { "outaction": 12, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "inter_idx": "1", "moduleName":"查询", "xxx":"xxx" //扩展 } }

响应消息样例3 { "userid": "1528780879-9581", "outaction": 10, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "start_time": "2018090407:16:24", "end_time": "2018090407:30:24", "release_reason": "0", "region_id": "025", "entrance_id": "03", "exit_id": "05", "user_type_id": "01", "suilu_region_id":"025" } }

响应消息样例1 { "userid": "1528780879-9581", "outaction": 9, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "prompt_wav": "welcome", "prompt_text": "查询话费", "language": "0", "inter_idx": "1", "model_type":"1011201" "timeout": "10", "tone": "", "grammar": "", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

响应消息样例2 { "userid": "1528780879-9581", "outaction": 11, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "calling_num":"1234567890", "trans_type": "1", "route_value": "123456789", "inter_idx": "1", "trans_idx": "1", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码； 2、语音外呼问卷场景时为流程接入码；3、其他交互场景时传入接入标识。 不超过20位 begin_trans String body True 转移开始时间。 end_trans String body True 转移结束时间。 trans_result String body True 转移结果。 0：成功 其他值：失败 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 record_result String body False 录音结果（仅当转接第三方号码成功时生效） 0：成功 其他值：失败 input String body False 交互结果,（此参数请参考以下场景） 当转移成功后,接入方的请求参数需要传入trans_result=0的参数,不需要input；此后接入方收到ODFS的拆线(outaction=10)的响应,需接入方再次发送此请求,且请求参数需要包含input参数,取值为hangup。 hangup：挂机 不超过1024位 inter_idx String body False(语音导航场景特有字段) 交互次数,直接取上一次ODFS返回的inter_idx值即可。 mediaType String body False 媒体类型（文本,音频,视频... 例如：audio,video...） call_media_type String body False 呼入ivr的呼叫类型,文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。 说明： 括号里为界面字段,区别于接口传参字段。

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

报文样例 请求头 POST /CCFS/resource/ccfs/downloadRecord HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:44:42Z/content-length;content-type;host /f18f6dd19******************6b8ff99f6c5884 Accept: */* Host: 10.154.198.164 Content-Type: application/json;charset=UTF-8 Content-Length: 185 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/autoTest.V3", "callId": "autoTest-1", "ccId": "1" } }