华为云用户手册

请求说明 表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） True 无 录音文件相对路径名称，从调用“下载话单和录音索引”时返回的录音索引文件中的 file_name 字段获取。 参数格式：/{nodeId}/{ccId}/record/{vdnId}/{yyyymmdd}/{agentid}/{原始文件主名}.wav 说明：{nodeId}节点ID，{ccId}为呼叫中心ID，{vdnId}为平台VDN的ID，{yyyymmdd}为生成录音文件的日期，{agentid}为产生该录音文件的座席ID，{原始文件主名}为录音文件的名称。例如：/10/1/record/appId/100/15362/autoTest.wav

请求说明 表1 请求Headers参数说明 参数名称 选取原则 参数类型 默认值 说明 Content-Type 必选 String 无 固定填 application/json; charset=UTF-8。 Authorization 必选 String 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body参数说明 参数名称 选取原则 参数类型 默认值 说明 callId 必选 String（1-25） 无 呼叫标识Id。 beginTime 必选 String 无 录音记录的起始时间。格式为：yyyy-MM-dd HH:mm:ss。 endTime 必选 String 无 录音记录的截止时间。格式为：yyyy-MM-dd HH:mm:ss。 录音记录的截止时间与起始时间跨度不能超过3天。 version 可选 String 无 当前接口版本，此版本为2.0。 须知： 东八区以外的其他时区：“录音记录的起始时间”和“录音记录的截止时间”两个参数需填入当前租间所在时区时间，且当前参数（version）必填。 东八区时区： “录音记录的起始时间”和“录音记录的截止时间”两个参数填写0时区时间，当前参数（version）可不填。 例如，您现在位于中国（东八区），您希望查询的开始时间为2022-01-02 10:00:00，那么“录音记录的起始时间”参数应该填入的值为2022-01-02 02:00:00。 “录音记录的起始时间”和“录音记录的截止时间”两个参数填写租间所在时区时间，当前参数（version）必填。

报文样例 请求头 POST /CCFS/resource/ccfs/getRecordFileUrlFromObs HTTP/1.1Authorization: ************Accept: */*Host: 10.154.198.164Content-Type: application/json;charset=UTF-8Content-Length: 185 请求参数 { "callId": "1637742300-27", "beginTime": "2021-11-24 06:25:03", "endTime": "2021-11-25 06:25:11", "version": "2.0"} 响应头 HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "resultData": { "url": "https://south-aicc-develop.obs.cn-south-1.myhuaweicloud.com:443/ccfs/record/developId/13ddcde6-2072-40d2-b96f-58cac16e18f5?AccessKeyId=************&Expires=1637936620&Signature=************" }, "resultCode": "0", "resultDesc": "success"}

响应说明 表3 响应消息参数说明 参数名称 参数类型 说明 resultCode String 请求返回的结果码。 0：表示成功 其他：失败 resultDesc String 请求结果描述，详见错误码参考。 resultData Object 请求响应数据。 url String 调用本接口成功后，从OBS/LSS返回的录音播放和下载路径，失效时间默认8小时。 如果一个callid有多个录音文件，将会返回多个录音文件的播放和下载路径，url按开始时间和结束时间顺序排序。

场景描述 调用该接口，将CC-FS侧的录音文件上传到OBS/LSS，再从OBS/LSS获取录音下载和播放的路径。 前提条件：录音文件已经通过定时任务同步到CCFS侧的数据库。 使用限制 开发者只能下载自己帐号下的录音，开发者帐号（ak）和录音记录（callId）必须对应。 开发者账号（ak）包含在鉴权认证字符串中，详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 callId、beginTime、endTime必须唯一确定一条录音。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 voicepath string True 文件路径。最大长度100个字符。 2 startpostion long False 播放文件起始位置，单位 s。 3 volumechange string False 放音音量，默认"50"。0-5位数字。 4 speedchange string False 放音音速，默认"50"。0-5位数字。 5 times int False 播放次数，默认为1。 说明： 当输入其他值时，均默认为1。 6 codeformat int False 文件编码格式，目前暂时只支持0：默认为0。 7 locationId int False 分布式节呼叫中心点ID。 通过轮询接口获取的录音开始事件，会返回locationId的值

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "voicepath": "Y:/1/0/20180621/105/1406470.V3", "startpostion": 0, "volumechange": 20, "speedchange": 20, "times": 1, "codeformat": 0, "locationId": -1} 响应参数 { "result": {}, "message": "success", "retcode": "0"}

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

报文样例 该接口的请求消息体举例如下： {"defId":"1645244637", "displayResult":"就是不接电话8", "obsCodes":["00605","00604"]} 该接口的响应消息体举例如下： { "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "updateObResult Success!", "returnDesc": "updateObResult Success!"}

错误结果码 表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/recordplay/{agentid}/startrecordscreen 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

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

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 defId String 创建的外显结果ID。 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 5 returnDesc String 描述。

报文样例 该接口的请求消息体举例如下： {"resultCode":"007", "displayResult":"就是不接电话7", "obsCodes":["00602","00606"]} 该接口的响应消息体举例如下： { "defId": "1645244637", "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "createObResult Success!", "returnDesc": "createObResult Success!"}

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

录音记录索引文件(yyyymmddhhmmssSSS+3位随机数_record_文件序号.csv)定义 导出的录音记录csv文件中每一行表示一条数据，在该条数据下每行数据按列排序，每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String（1-64） 开发者ID。 2 account_id String（1-64） 企业帐号。 3 cc_id String（1-64） 呼叫中心ID。 4 agent_id String（1-32） 座席ID。 5 call_id String（1-25） 呼叫标识。 6 caller_no String（1-25） 主叫号码。 7 callee_no String（1-25） 被叫号码。 8 call_begin DATE 开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 9 call_end DATE 结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 10 file_name String（1-255） 录音文件名。例如：/10/1/record/100/13533/0903379.wav 11 task_status String（1-20） 是否有将录音文件转为文字文件（1：是，0：否）。 12 task_result String（1-20） 录音文件转为文字文件是否成功的状态信息（success：成功，failed：失败）。 13 original_file_name String（1-129） 原始录音文件路径。例如：X:\17\0\20180903\15470\2043295.V3 14 vdn_id String（1-64） 指处理呼叫的虚拟呼叫中心编号。 15 call_type String（1-64） 呼叫类型： 呼入 呼出 16 media_type String（1-64） 媒体类型。详见媒体类型。 17 user_wanted_skill_id String（1-64） 引导技能。 18 current_skill_id String（1-64） 当前处理呼叫的技能队列的编号。

话单记录文件（yyyymmddhhmmssSSS+3位随机数_call_文件序号.csv）定义 导出的话单记录csv文件中每一行表示一条数据，在该条数据下每行数据按列排序，每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String（1-64） 开发者ID。 2 account_id String（1-64） 企业帐号。 3 cc_id String（1-64） 呼叫中心ID。 4 agent_id String（1-32） 座席ID。 5 call_id String（1-25） 呼叫标识。 6 caller_no String（1-26） 主叫号码。 7 callee_no String（1-26） 被叫号码。 8 wait_begin DATE 等待开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 9 wait_end DATE 等待结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 10 ack_begin DATE 应答开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 11 ack_end DATE 应答结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 12 call_begin DATE 呼叫开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 13 call_end DATE 呼叫截止时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 14 device_type Int（1-4） 设备类型。 1:技能队列，2:座席，3:IVR流程 15 device_no Int（1-5） 设备号。 如果设备类型为技能队列，设备号为技能队列ID; 如果设备类型为座席，设备号为座席ID； 如果设备类型为IVR，设备号为IVR流程ID。 16 call_type Int（1-4） 呼叫类型。详见呼叫类型说明（话单索引）。 17 release_cause Int（1-5） 呼叫释放原因。详见呼叫释放原因码 对CallIDNUM = -1的话单（参考本表第18项），表示呼叫的释放原因，其他情况下无意义。 18 call_id_num Int（1-4） 呼叫标识的序列。其中： 若相同呼叫标识只有一条，即该呼叫标识是唯一的，则该序列为-1。 若相同呼叫标识为多条，则最后一条是-1，其他的按顺序排列。如：相同呼叫标识有4条，callidnum为1、2、3以及-1。 19 vdn_id String（1-32） 指处理呼叫的虚拟呼叫中心编号。 20 pre_device_type String（1-32） 呼叫经历的上一个设备的设备类型。取值范围：1：队列 2：座席 3：IVR 21 pre_device_no String（1-32） 呼叫经历的上一个设备的设备编号。 22 skill_id String（1-32） 呼叫所属技能队列的ID。当溢出转和无人上班转时，为呼入的第一个技能队列的ID 23 current_skill_id String（1-32） 当前处理呼叫的技能队列的编号。 24 device_in String（1-32） 当前服务设备描述。 技能队列取值为DEVICE_QUEUE。 业务代表取值为DEVICE_AGENT。 当DeviceType = IVR业务流程（3）时，该字段取值为对应的IVR流程接入码。 呼叫取值为对应的电话号码。 路由临时设备取值为DEVICE_ROUTE。 虚设备取值为DEVICE_VNR。 当DeviceType = CDN设备（10）时，该字段取值为CDN的号码。 当DeviceType = PGR（14）时，该字段取值为PGR接入码。 25 pre_device_in String（1-32） 上一个服务设备描述。 取值范围如下： 技能队列取值为DEVICE_QUEUE。 业务代表取值为DEVICE_AGENT。 当DeviceType = IVR业务流程（3）时，该字段取值为对应的IVR流程接入码。 呼叫取值为对应的电话号码。 路由临时设备取值为DEVICE_ROUTE。 虚设备取值为DEVICE_VNR。 当DeviceType = CDN设备（10）时，该字段取值为CDN的号码。 当DeviceType = PGR（14）时，该字段取值为PGR接入码。 26 service_no String（1-32） 业务类型。当前服务设备的业务类型。 27 leave_reason String（1-32） 呼叫离开设备原因，具体请参考呼叫离开设备原因。 28 media_type String（1-32） 呼叫的媒体类型，具体请参考呼叫媒体类型说明。 29 sub_media_type String（1-32） 子媒体类型，具体请参考表1 呼叫子媒体类型。 当media_type（呼叫媒体类型）为MEDIA_TYPE_WEB_LEAVE_MESSAGE(20)时，该字段有效。

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

报文样例 该接口的请求消息体举例如下： { "busiResult": "1621474513", "subStatus": "1048856206", "busiResultDesc": "1", "workNo": "2033"} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "The business result is written back successfully."}

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 busiResult String True 业务结果编码，最大长度为50个字符。 2 subStatus String False 子业务状态编码，最大长度为50个字符。 3 busiResultDesc String False 业务结果描述。 4 workNo String False 执行呼叫的座席的平台工号。 如果需要同一个外呼数据，始终呼叫到同一个座席，该参数必填，如不填，则会路由至其他座席。

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表 响应消息response参数说明，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据

报文样例 请求头 POST /CCFS/resource/ccfs/ivr/downloadFile HTTP/1.1Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed0******************94941bdd106Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "filePath": "Y:/3rdfile/53/thirdvoicebotfile", "mode":"1" }}

报文样例 请求头 POST /CCFS/resource/ccfs/downloadBillFile HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host/ae066c2f5d******************13a0afc161cb7e66f5dAccept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "billFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" }}

请求说明 表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 billFileName String（1-49） True 无 话单和录音索引文件名称，已调用“生成话单和录音索引”获取。 格式：yyyyMMdd_{responseId}.zip。 例如：已调用“生成话单和录音索引”接口，调用“生成话单和录音索引”接口的日期为2018-07-02，获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成话单文件，文件后缀名为.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 请求结果描述。

接口URI https://ip:port/agentgateway/resource/recordfile/{agentid}/videofiledownload?conferenceId=xxx&recordId=xxx&fileType=xxx 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 conferenceId string True 会议id。 例如：7a008307-34ad-435b-bccd-222be5ac5385。 3 recordId string False 视频录像id。 例如：0a08082d-df1e-4c06-9a97-c7c6f7a4724e。 说明： 如果recordId不传，默认下载第一条录播地址对应的视频文件。 4 fileType string True 文件类型，取值范围： 0：高清 1：标清 2：文件辅流

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "retcode": "000-003", "message": "no right to invite resource", "result": ""}

响应说明 该接口的响应说明体举例如下： 下载失败时： 消息头Content-Type: application/json;charset=UTF-8 消息体示例请参见报文样例 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 预留字段 下载成功时： 消息头 Content-Type: application/octet-stream;charset=utf-8 消息体 文件流

座席操作详单索引文件(yyyymmddhhmmssSSS+3位随机数_agentOprInfo_文件序号.csv)定义 导出的csv文件中每一行表示一条数据，在该条数据下每行数据按列排序，每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 id String（1-32） 唯一标识。 2 developer_id String（1-64） 开发者ID。 3 account_id String（1-64） 企业帐号。 4 agent_id String（1-32） 座席ID。 5 service_no String（1-25） 业务类型ID。 6 skill_id String（1-25） 技能队列ID。 7 call_id String（1-25） 呼叫标识。 8 begin_time DATE 统计操作开始时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 9 end_time DATE 统计操作结束时间。 时间格式为：YYYY-MM-DD hh:mm:ss，例如：2015-02-08 20:23:30 10 op_type String（1-20） 操作类型，请参考表1。 11 op_object String（1-20） 操作对象 12 op_cause String（1-20） 操作原因。 13 media_type String（1-20） 媒体类型 14 vdn_id String（1-20） VDN ID 15 cc_id String（1-20） 呼叫中心编码 16 agent_type String（1-20） 座席类型/客户级别 17 phone_no String（1-32） 座席IP/座席电话号码/被叫号码/会议的ID 18 callIn_out String（1-20） 呼入呼出标志，包括： 呼入 呼出 IVR呼出 outbound呼出 19 location_id String（1-20） 分布式节点编号 20 logon_sn String（1-25） 签入序列号 21 skillInfo_sn String（1-25） 执行当前操作时座席拥有技能列表的索引。 当取值为空时，表示座席不拥有任务技能。例如：座席签入时，此字段则为空。