华为云用户手册

报文样例 该接口的请求消息体举例如下： { "serverId":"164690088271159234793429225848", "filePath":"/isales/upload", "fileName":"demoBlack.xlsx", "hour":"11", "minute":"00" } 该接口的响应消息体举例如下： { "returnCode": "0200000", "importTaskId": "164757251098048478018607266946", "resultCode": "0200000", "resultDesc": "数据导入中，请通过“导入结果”查看详细信息。", "returnDesc": "数据导入中，请通过“导入结果”查看详细信息。" }

响应说明 表6 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 importTaskId String 文件导入任务ID 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表7 5 returnDesc String 描述。

响应消息样例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 （短信）。 说明： 括号里为界面字段,区别于接口传参字段。

响应消息样例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" } }

请求消息样例 如果呼叫转移成功,接入方先发起如下请求。 { "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 呼叫媒体类型 编号 媒体类型 描述 1 MEDIA_TYPE_CHAT 文字交谈 2 MEDIA_TYPE_WEBPHONE 点击通话 3 MEDIA_TYPE_ESCORT 护航浏览、表单共享 4 MEDIA_TYPE_CALLBACK 回呼请求呼叫 5 MEDIA_TYPE_PHONE 普通语音电话 6 MEDIA_TYPE_EMAIL 电子邮件呼叫 7 MEDIA_TYPE_FAX 传真呼叫 8 MEDIA_TYPE_VIDEO IP视频呼叫(H.323) 9 MEDIA_TYPE_WB 电子白板 10 MEDIA_TYPE_APP_SHARE 应用程序共享 11 MEDIA_TYPE_FILE_TRANSFER 文件传输 12 MEDIA_TYPE_VIDEO_2B1D 2B+D ISDN视频呼叫 13 MEDIA_TYPE_VIDEO_6B1D 6B+D ISDN视频呼叫 14 MEDIA_TYPE_OPS OPS呼叫 15 MEDIA_TYPE_PREDICT_OUTBOUND 预测呼出 16 MEDIA_TYPE_PREVIEW_OUTBOUND 预浏览呼出 17 MEDIA_TYPE_MSG 消息媒体 18 MEDIA_TYPE_WEBPHONE_VIDEO 视频点击通话 19 MEDIA_TYPE_PHONE_VIDEO 视频普通呼叫 20 MEDIA_TYPE_WEB_LEAVE_MESSAGE 非实时呼叫 21 MEDIA_TYPE_DESKTOP_SHARE 桌面共享媒体类型 22 MEDIA_TYPE_VC_CALL 技能队列呼入主叫号码功能 23 CLASSIC_MEDIA_TYPE_NUM 接触媒体类型总数 50 MEDIA_TYPE_MULTI_MEDIA_EMAILCHAT 邮件交谈 51 MEDIA_TYPE_MULTI_MEDIA_WEBCHAT 网络交谈 52 MEDIA_TYPE_MULTI_MEDIA_SMSCHAT 短信交谈 53 MEDIA_TYPE_MULTI_MEDIA_SOCIALCHAT 文字交谈 54 MEDIA_TYPE_MULTI_MEDIA_FAXCHAT 传真交谈 55 MEDIA_TYPE_MULTI_MEDIA_H5CHAT H5视频 父主题： 附录

报文样例 该接口的请求消息体举例如下： { "name": "呼叫失败", "code": "123456", "description": "呼叫失败", "children": [ { "name": "客户直接挂断", "code": "100001", "description": "客户直接挂断" }, { "name": "客户关机", "code": "100002", "description": "客户关机" } ] } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "addBusinessResult success", "returnCode": "0200000", "returnDesc": "addBusinessResult 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 参数个数不能大于规定个数

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/addBusinessResult 其中，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 name String True 业务结果名称。 取值范围：最大长度50，不包含特殊字符。 2 code String False 业务结果编码。 取值范围：最大长度50，有效字符为：数字、字母、-。 3 description Sring False 业务结果描述。 取值范围：最大长度200，不包含特殊字符。 4 children List False 子业务结果。 该对象的参数说明请参见表4。 表4 children参数说明 序号 参数名 参数类型 是否必选 说明 4.1 name String True 子业务结果名称。 取值范围：最大长度50，不包含特殊字符。 4.2 code String False 子业务结果编码。 取值范围：最大长度50，有效字符为：数字、字母、-。 4.3 description String False 子业务结果描述。 取值范围：最大长度200，不包含特殊字符。

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 fileName String（1-225） False 无 录音文件名，从调用“下载话单和录音索引”时返回的录音索引文件中的original_file_name 字段获取 比如:“X:/4/0/20180416/512/1629533.V3”。注：fileName和callId参数值必须至少选填一个。 2 callId String（1-25） False 无 呼叫标识Id。注：fileName和callId参数值必须至少选填一个，callid 对应多个录音文件会下载 zip 压缩包。 3 ccId String（1-64） False 无 呼叫中心Id。当前环境默认为“1”。

使用说明 前提条件 已调用“下载话单和录音索引”获取录音索引文件。 已通过鉴权（Authorization）、获取接入地址。 使用限制 开发者只能下载自己帐号下的文件，开发者帐号（appId）和录音原始文件名称（fileName）必须对应。 开发者账号（appId）包含在鉴权认证字符串中，详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 SaaS/OP集成组网下，下载的录音文件编码格式为G711.A-law，请使用合适的播放器播放。

响应说明 当调用本接口响应成功，则从httpresonse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，通过callid下载多个录音文件后缀名为.zip，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表5 不推荐使用，为兼容老版本保留字段。 表5 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。

报文样例 请求头 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" } }

报文样例 该接口的请求消息体举例如下： { "callDataList": [ { "sessionId": "00750", "called": "80021" }, { "sessionId": "00850", "called": "80022" }, { "sessionId": "00950", "called": "80023" }, { "sessionId": "01050", "called": "80024" } ] } 该接口的响应消息体举例如下： { "returnCode": "0200000", "returnObject": { "totalSize": 2, "dataIdList": [ { "called": "88880399", "dataId": "1803096731904991234" }, { "called": "88880399", "dataId": "1803096731997265922" } ] }, "resultCode": "0200000", "resultDesc": "create data succeeded", "returnDesc": "create data succeeded" }

使用说明 前提条件 已经申请了开发者账号。 外呼活动已经创建。 使用限制 外呼活动未完成的外呼记录数不超过20W。 同一个外呼任务，每次只能增加20条，且前后接口调用时间不能小于1秒。 每次追加的被叫号码不能有重复。 每次追加的被叫号码中不能与黑名单号码重复，或者被叫号码在黑名单号码中并为其配置了限制周期和限制次数（但外呼次数不能超过限制周期内的限制次数）。 已完成的任务不允许追加号码。 执行中的任务不允许新增外呼号码。

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

响应说明 表5 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 4 returnDesc String 描述。 5 returnObject Object 参见表6。 表6 returnObject参数说明 序号 参数名 参数类型 说明 5.1 totalSize int 当前系统需要外呼的数据总数。 5.1 datalist Object 参见表7。 表7 datalist参数说明 序号 参数名 参数类型 说明 5.1 called String 新增的外呼号码。 5.1 dataId String 新增外呼号码及其对应的dataId。

错误结果码 表8 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200018 存在重复的号码。 5 0200019 当前状态不允许追加号码。 6 0200020 号码数量超过了最大规格20w条。 7 0200022 接口调用太快。 8 0200024 添加的号码中存在黑名单号码。 9 0200029 超过了每次添加允许的最大值。 10 0200030 时间格式不正确。 11 02000001 参数值为空 12 02000002 参数包含非法字符 13 02000003 参数长度不能大于规定长度 14 02000004 参数长度不能小于规定长度 15 02000005 参数长度需要介于规定长度之间 16 02000006 参数值类型不正确 17 02000007 参数值大小不正确 18 02000008 参数转换异常，请检查请求参数 19 02000009 参数组合不正确，请检查请求参数 20 02000010 hour和minute必须同时存在 21 02000011 参数个数不能大于规定个数

响应说明 响应状态码: 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 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：客户接收座席发送的多媒体库文件 请求参数: { "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”。

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

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "callinfo": null, "agentStateInfo": { "callFeature": 0, "callData": "", "lastState": 255, "preBusy": false, "firsttalkingFlag": false, "workNo": "41001", "qcWorkNo": "", "callerNo": "", "beginHoldTime": null, "state": 1, "talkingCallfeature": 0, "releaseFlag": 0, "calledNo": "", "mainCallId": "", "secondTalkingTime": null, "preRest": false, "recordID": "", "currentTime": "1566636307992", "beginTalkingTime": null, "partner": "", "holdCallId": "", "agentStateBeginTime": 1566636286408, "curCommand": 0, "curCallId": "", "cmdBeginTime": "" } }, "message": "success", "retcode": "0" }

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