华为云用户手册

报文样例 请求头 POST /CCFS/resource/ccfs/requestPlayVoice HTTP/1.1Authorization: auth-v2/taikang/2018-07-02T02:42:49Z/content-length;content-type;host /7a8fb9d6******************5df0cce3c6a253Accept: */*Host: 10.154.198.164:18084Content-Type: application/json;charset=UTF-8 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/1/0/20180309/108/2022318.V3" }} 响应头 HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "response": { "version": "2.0", "resultCode": "0", "resultMsg": "success" }, "resultData": { "token": "DC45F******************6D46F90" }, "resultCode": "0", "resultDesc": "success"}

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

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

接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/forefast/{time} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 time string True 快进的时长，单位为秒（s），取值范围：0~2147483647。

报文样例 请求头 POST /CCFS/resource/ccfs/queryAgentOprInfoData HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:42:49Z/content-length;content-type;host/7a8fb9d620e******************5c5df0cce3c6a253Accept: */*Host: 10.154.198.164Content-Type: application/json;charset=UTF-8Content-Length: 297 请求参数 { "request": { "version": "2.0" }, "msgBody": { "beginTime": "2018-06-29 10:42:49", "endTime": "2018-07-02 10:42:49", "accountId": "", "agentId": "", "callBackURL": "https://10.57.118.171:8000" }} 响应头 HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "response": { "version": "2.0", "resultCode": "0", "resultMsg": "success" }, "resultData": { "responseId": "9239cb50a8384bb0ab503441bf089446" }, "resultCode": "0", "resultDesc": "success"} 呼叫中心向回调地址返回的消息示例 消息头 POST / HTTP/1.1Accept: */*Content-Type: application/json;charset=UTF-8Authorization: auth-v2/ak/2018-07-02T02:43:03Z/content-length;content-type;host/c5bd683******************ef5747bd572c28Host: 10.57.118.171Content-Length: 208 消息参数 { "request": { "version": "2.0" }, "msgBody": { "responseId": "9239cb50a8384bb0ab503441bf089446", "agentOprInfoFileName": "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 beginTime String True 无 座席相关操作的起始时间，为租间所在时区的时间，起始时间和截止时间需要做范围限制，最大为3天内。格式为：yyyy-MM-dd HH:mm:ss。 2 endTime String True 无 座席相关操作的截止时间，为租间所在时区的时间，起始时间和截止时间需要做范围限制，最大为3天内。格式为：yyyy-MM-dd HH:mm:ss。 3 accountId String（1-20） False 无 企业帐号（租间ID）。 4 agentId String（1-20） False 无 座席ID（座席工号）。 5 callBackURL String True 无 回调地址。平台生成数据记录文件后将fileName返回到该地址。

使用说明 前提条件 开发者环境已经构建，座席正常签入并进行相关操作，开发者有独立服务器并且已经绑定回调地址（callBackURL）。 企业帐号（accountId：租间ID）、座席ID（agentId），可自由组合生成座席操作详单索引文件。如果均没有传入，则生成指定时间段内该appId下相应的数据记录。 已通过鉴权（Authorization）、获取接入地址。 请检查CC-FS配置文件“/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties”的“aicc.ssl.trustAll”是否配置为false，请配置为false，然后参考下面步骤放置证书。 以运维用户登录CC-FS的服务器，切换到root用户下。 su - root 将CC-FS生成索引文件通知回调地址加载的第三方证书上传至AICC的truststore.jks证书的同一目录中，目录为：“$HOME/conf”，具体目录请以实际环境为准。 修改上传的第三放证书的属组。 chown ccfsapp:ccfsapp XXX.jks 执行下面的命令将第三方证书导入到truststore.jks中。 keytool -import -alias xxx -file XXX.jks -keystore truststore.jks 请依据界面提示输入truststore.jks证书密码。 在环境上删除XXX.jks证书。 重启CC-FS。 进入“/home/ccfsapp/bin”目录，执行如下命令。 ./shutdown.sh;./startup.sh 使用限制 开发者只能访问该帐号下的数据信息，开发者帐号（appId）和企业帐号（accountId）必须对应。 开发者账号包含在认证字符串中，详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。

响应说明 调用本接口获得响应分为两部分： （1）调用本接口立即得到响应 该响应消息参数说明详见表4。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码， 0：成功 非0：详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据,resultData参数说明详见表6-响应消息resultData参数说明。 4 response Object 请求结果对象，参数说明详见表6 不推荐使用，为兼容老版本保留字段。 表5 响应消息resultData参数说明 序号 名称 参数类型 说明 3.1 responseId String 调用本接口成功后，生成的唯一标识，是文件名称的组成部分。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。 （2）平台生成数据记录文件后回调第三方的响应。 该响应由request，msgBody两部分组成。msgBody参数说明详见表7-回调返回消息请求Body中msgBody参数说明。 request包含响应版本号version（默认2.0）。 msgBody由responseId（座席操作详单文件名组成部分），fileName（待下载座席操作详单zip名称），accountId（租间ID）组成。 表7 回调返回消息请求Body中msgBody参数说明 序号 名称 参数类型 说明 1 responseId String 调用本接口成功后，生成的唯一标识，是文件名称的组成部分。 2 fileName String 话单和录音索引文件名称。格式：yyyyMMdd_{responseId}.zip。 例如：调用本接口的日期为2018-07-02，获取到的responseId为9239cb50a8384bb0ab503441bf089446，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。 3 accountId String 企业帐号（租间ID），请求参数中带的企业账号，用来将文件名和企业进行关联，如果请求参数中未填accountId，则不会返回该值。 若回调没有成功（ccfs没有收到回调地址的成功响应，或没有响应体），ccfs会重试，间隔10分钟重试一次，直到成功或者超过重试次数。

接口URI https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId={locationId} 其中，ip为CC-FS安装的服务器IP地址，port为CC-FS的HTTPS端口号。 如果经过NSLB路由，ip为NSLB的服务器IP地址，port为CC-FS服务在NSLB映射的HTTPS端口号。 表1 URL中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 locationId int False 节点Id，通过调用会话记录查询接口（https://IP:PORT/oifde/rest/api/queryRecordHistory）查询locationId。

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

报文样例 请求头 POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/eb453f68e858******************196c509c4913Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/39/record/20201015/10233946082696733.wav" }}

报文样例 请求头 POST /CCFS/resource/ccfs/downloadAgentOprInfoFile HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host/ae066c2f5de******************afc161cb7e66f5dAccept: */*Host: 10.154.198.164Content-Type: application/json;charset=UTF-8Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "agentOprInfoFileName": "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 True String（1-32） 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 agentOprInfoFileName True String（1-49） 无 座席操作详单索引文件名称，已调用“生成座席操作详单索引”获取。 格式：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 请求结果描述。

状态码说明 系统返回信息中的状态码为200，为正常业务信息返回。其他状态码，为异常信息返回。 表1 状态码参数说明 状态码 中文描述 说明 200 正常业务信息返回。 具体信息请查看上述接口。 401 越权或未授权访问接口。 请参考接口的鉴权算法和表2，检查鉴权字符串和请求参数是否有误。如果有疑问，联系管理员。 403 Ip被锁定。在一段时间内，请求携带的鉴权字符串信息错误次数超过允许错误的最大次数。 请参考接口的鉴权算法和表2，检查鉴权字符串和请求参数是否有误。如果有疑问，联系管理员。 表2 异常状态码参数说明 参数名称 是否必选 参数类型 说明 timestamp 是 Long 时间戳。如：1532142010247 status 是 int 状态码。如：401，403 error 是 String 错误类型。如：Forbidden表示禁止，Unauthorized表示越权/未授权 message 是 String 提示信息。如：No message available path 是 String 请求路径。如：/CCFS/resource/ccfs/queryBillData 异常状态码返回信息示例 {"timestamp":1532142010247,"status":403,"error":"Forbidden","message":"Nomessageavailable","path":"/CCFS/resource/ccfs/queryBillData"} 父主题： 参考说明

错误码参考 响应码 结果码 英文描述 中文描述 处理方法 200 0 success 成功。 无需处理。 200 0300001 The value of {param} cannot be null. 参数{param}不能为空。 请检查请求字符串中参数值是否为空字符串。 200 0300002 The value of {param} cannot be an empty string. 参数{param}不能为空字符串。 请检查请求字符串中参数的值是否为空字符串。 200 0300003 The length of {param} is too long. 参数{param}长度太长。 查看参数是否大于文档限制的长度。 200 0300004 The format of {param} is incorrect. 参数{param}格式错误。 查看参数是否符合文档描述的格式。 200 0300005 The length of {param} is too short. 参数{param}长度太短。 查看参数是否小于文档限制的长度。 200 0300006 The value of version is error, current version is {param} . 版本号错误，当前版本号为{param} 查看参数中的版本号是否匹配 200 0300007 The params of requestBody is null. 参数长度不匹配 参看参数长度是否匹配 200 0300008 Reached the download flow control threshold. 达到最大下载流控点。 到达系统下载最大处理流控点，请稍后重试。 200 0300009 Reached the query flow control threshold. 达到最大查询流控点。 到达系统查询最大处理流控点，请稍后重试。 200 0300010 The date in the value of fileName is in an incorrect format. 请求参数fileName的路径中日期格式错误。 查看请求字符串的文件名称是否有效。文件名称格式：/{nodeId}/{ccId}/record/{appId}/{accountId}/{yyyymmdd}/{agentId}/{原始文件主名}.文件扩展名。请检查{yyyymmdd}部分是否正确。 200 0300011 The file does not exist. 该文件不存在。 请求的文件不存在，请检查请求的文件是否有误。 200 0300012 No data found. 没有数据被找到。 查看参数fileName参数是否有误。文件名称格式： 盘符:/ vdn号/0是呼入,1是呼出/日期/座席号/当天时间毫秒值.V3 200 0300013 The beginTime cannot be later than the endTime. 开始时间不能小于结束时间。 请检查请求参数beginTime和endTime。 200 0300014 The maximum duration between the beginTime and endTime is {param} days. 开始时间到结束时间之间最多跨{param}天。 查看请求字符串的beginTime和endTime是否在有效范围内。默认最大是3天内。 200 0300015 The local storage or voice path does not exist. 本地存储路径或录音路径未配置 配置文件中以下配置项配置合理路径 ccfs.common.local.store.path ccfs.common.local.voice.path 200 0300016 The value of {param} is greater than current time. 查询时间不能大于当前系统时间 请检查查询时间。 200 0300017 Specify ccId. 请传入ccId参数值。 查询到多条数据，需要多传入ccId进行更精确的查询。 200 0300018 This record belongs to another developer. 该条记录属于其他开发者。 查询的录音记录的开发者和请求开发者信息对应不上，请检查appId传入是否正确。 200 0300019 Specify at least one of fileName and callId. fileName或者callId参数值至少传入一个。 请检查是否传入了fileName或者callId参数值。 200 0300020 Only one record is required but multiple records are obtained. 只需要一条记录，实际得到多条记录。 根据条件查询到多条记录，而实际只需要一条录音，请联 系管理员。 200 0300021 The {param} in fileName does not match the {param} in the directory. 请求参数中fileName的路径中{param} 和请求参数{param}不匹配。 查看请求字符串的文件名称是否有效。文件名称格式：/{nodeId}/{ccId}/record/{appId}/{accountId}/{yyyymmdd}/{agentId}/{原始文件主名}.文件扩展名。请检查{appId}，record，{nodeId}是否正确。 200 0300022 The parameter {param} value contains illegal characters. 请求参数{param}包含非法字符。 请求参数包含了非法特殊字符。如： 下载话单和录音索引接口中参数billFileName只能由“a-zA-Z0-9.-_”组成。 下载录音文件接口中参数fileName只能由“a-zA-Z0-9/.”组成。 下载录音变成文字的文件接口中参数fileName只能由“a-zA-Z0-9/.”组成。 查询并下载录音文件接口中参数fileName只能由“a-zA-Z0-9:/.”组成。 200 0300023 The file name does not match the path configured in the configuration file. 文件名与配置文件中配置的路径不匹配。 下载IVR留言录音时，请求参数中fileName的路径中vdnId后的文件夹和配置项中配置的路径不匹配，修改系统级参数：IVR留言录音文件中vdnId后的目录为合理文件路径。 200 0300024 The file path is not canonical path. 文件路径不是一个标准路径 请检查路径是否是标准路径。 200 0300025 Internal system error. 系统内部错误。 请联系管理员处理。 200 0300026 Authentication failed. 开发者accountId或vdnId鉴权失败 请检查accountId或vdnId是否有误。 200 0300027 Parameter {param} is empty. 参数为空。 请检查参数是否为空或空字符串。 200 0300028 Parameter {param} is error. 参数错误。 请检查参数是否符合文档描述的要求。 200 0300029 File does not exist. 获取的文件不存在。 请检查fileName参数是否有误，请求回放录音文件接口和回放录音文件接口请求播放的文件不存在。 200 0300030 Failure of system processing. 下载失败。 请联系管理员处理。 200 0300031 Invalid oiap fileName, fileName Length is not legal. fileName长度不合法。 请检查参数fileName的长度。 200 0300032 file path is invalid. 文件路径不合法。 请检查文件路径是否合法。 200 0300033 locationId is empty CTI的pool模式下，locationId不能为空 请检查参数是否为空或空字符串。 200 0300034 tenantId is empty tenantId为空 请检查参数是否为空或空字符串。 200 0300035 audio file type should be wav. 文件格式不匹配，仅支持 wav 格式的音频文件。 检查文件格式，仅支持 wav 格式的音频文件。 200 0300036 audio file channel should be mono. 第三方上传录音文件，音频文件声道不匹配，仅支持单声道。 检查文件声道。 200 0300037 audio file fileSampleSizeInBits should be 8000Hz. 第三方上传录音文件，音频文件帧数不匹配，仅支持 8 bit。 检查文件帧数。 200 0300038 audio file fileSampleRate should be 8000Hz. 第三方上传录音文件，音频文件采样速率不匹配，仅支持 8000Hz 检查文件采样速率。 200 0300039 Failed to read the audio file format. 第三方上传录音文件，读取音频文件格式失败 校验上传的音频文件格式是否符合要求。 200 0300040 An exception occurred during file deletion. 第三方删除录音文件，部分文件删除失败 检查文件权限是否正确。 200 0300041 The file size exceeds the limit. 第三方上传录音文件，文件大小超过限制 检查文件大小 200 0300042 file path config miss parameter %VDNNO% 配置项中路径规则缺少 VDNNO 变量 配置项中路径规则补充VDNNO 变量 200 0300043 file path configuration should refer to the example. 配置项中路径规则不符合规则 检查配置项中路径内容。 200 0300044 The directory contains multiple files. 该目录包含多个文件 判断文件夹下是否只包含一个 wav 文件。 200 0300045 Failed to compress the recording files. 录音文件压缩成 zip 包错误 检查录音文件是否存在。 200 0300046 The mount path corresponding to the drive letter does not exist. 盘符对应挂载路径不存在 检查文件路径。 200 0300047 Upload file to OBS/LSS failed 上传 OBS/LSS失败 请OBS/LSS服务是否正常。 200 0300048 In CTI pool mode,the value of ccfs.uap.id cannot be empty CTI的pool模式下，CCFS后台配置文件的配置项ccfs.uap.id的值不能为空 请检查/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties配置文件的配置项ccfs.uap.id的值是否为空。 200 0300049 In CTI pool mode,the value format of ccfs.uap.id is incorrect CTI的pool模式下，CCFS后台配置文件的配置项ccfs.uap.id的值格式不正确 请检查/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties配置文件的配置项ccfs.uap.id的值格式是否正确。 配置规则：{挂载目录},{uap节点标识} 父主题： 参考说明

响应说明 该接口的响应说明如下： 下载失败时： 消息头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 消息体 文件流

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

接口URI https://ip:port/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1 例：https://ip:port/agentgateway/resource/recordfile/102?recordId=y:/1/0/20181217/120/1524488.V3 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 签入的座席id。 2 recordId string True 录音文件的路径和名称。 录音文件的路径和名称是在触发了AgentMediaEvent_Record时生成的，在fileName中返回。 录音文件路径格式详见下方说明。 3 filetype string False 录音文件类型： 1：座席通话录音 2：IVR留言录音或者第三方留言录音文件 说明： 座席通话录音文件路径格式为：盘符:/vdn编号/目录号/****。例：y:/1/0/20181217/120/1524488.V3 IVR录音留言录音文件路径格式为：盘符:/vdn编号/record/****。例：y:/1/record/20190412/playvoice1551276018824.wav 第三方留言录音文件路径格式为：盘符:/3rdfile/vdn编号/record/***。例：y:/3rdfile/1/record/20190408/515/1633022.V3 默认为座席通话录音 4 locationId number False 节点Id（CTI POOL模式下为必选），在触发了AgentMediaEvent_Record时生成。

响应说明 该接口的响应说明体举例如下： 下载失败时： 消息头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 消息体 文件流

接口URI https://ip:port/agentgateway/resource/recordfile/{agentid}/recordfiledownloadEx?callId= xxx&hwFileName=1 例：https://10.244.154.23:8043/agentgateway/resource/recordfile/4977/recordfiledownloadEx?callId=1621413752-2011&hwFileName=Y:/90/0/20210519/4977/1642329.mp4 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 签入的座席id。 2 callId string True 呼叫ID 3 hwFileName string False 文件路径。 如果不传hwFileName，下载的是音频文件； 如果传hwFileName，下载的是视频文件，例：Y:/90/0/20210519/4977/1642329.mp4。 4 workNo string False 被质检座席工号。 签入座席为质检员且hwFileName为空时需要传入。

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

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

报文样例 请求头 POST /CCFS/resource/ccfs/queryBillData HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:42:49Z/content-length;content-type;host/7a8fb9d620ee488******************85c5df0cce3c6a253Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 297 请求参数 { "request": { "version": "2.0" }, "msgBody": { "beginTime": "2018-06-29 10:42:49", "endTime": "2018-07-02 10:42:49", "accountId": "", "agentId": "", "callId": "", "dataType": "call_record", "callBackURL": "https://10.57.118.171:8000" }} 响应头 HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8Date: Mon, 02 Jul 2018 02:43:03 GMT 响应示例 { "response": { "version": "2.0", "resultCode": "0", "resultMsg": "success" }, "resultData": { "responseId": "9239cb50a8384bb0ab503441bf089446" }, "resultCode": "0", "resultDesc": "success"} 呼叫中心向回调地址返回的消息示例 消息头： POST / HTTP/1.1Accept: */*Content-Type: application/json;charset=UTF-8Authorization: auth-v2/ak/2018-07-02T02:43:03Z/content-length;content-type;host/c5bd683******************9def5747bd572c28Host: 10.57.118.171Content-Length: 208 消息参数： { "request": { "version": "2.0" }, "msgBody": { "responseId": "9239cb50a8384bb0ab503441bf089446", "billFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip", "accountId": "" }}

响应说明 调用本接口获得响应分为两部分： （1）调用本接口立即得到响应 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码， 0：成功 非0：失败。 2 resultDesc String 请求结果描述，详见错误码参考。 3 resultData Object 请求响应数据，参数说明详见表6-响应消息resultData参数说明。 4 response Object 请求结果对象，参数说明详见表6 不推荐使用，为兼容老版本保留字段。 表5 响应消息resultData参数说明 序号 名称 参数类型 说明 3.1 responseId String 调用本接口成功后，生成的唯一标识，是文件名称的组成部分。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。 （2）平台生成数据记录文件后回调第三方的响应。 该响应由request，msgBody两部分组成。 request包含响应版本号version（默认2.0）。 msgBody由responseId（话单文件名组成部分），billName（待下载话单zip名称），accountId（租间ID）组成。 表7 回调返回消息请求Body中msgBody参数说明 序号 名称 参数类型 说明 1 responseId String 调用本接口成功后，生成的唯一标识，是文件名称的组成部分。 2 billFileName String 话单和录音索引文件名称。格式：yyyyMMdd_{responseId}.zip。 例如：调用本接口的日期为2018-07-02，获取到的responseId为9239cb50-a838-4bb0-ab50-3441bf089446，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。 3 accountId String 企业帐号（租间ID），请求参数中带的企业账号，用来将文件名和企业进行关联，如果请求参数中未填accountId，则不会返回该值。 若回调没有成功（ccfs没有收到回调地址的成功响应，或没有响应体），ccfs会重试，间隔10分钟重试一次，直到成功或者超过重试次数。

请求说明 表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 beginTime String True 无 话单和录音记录的起始时间，为租间所在时区的时间，起始时间和截止时间需要做范围限制，最大为3天内。格式为：yyyy-MM-dd HH:mm:ss。 2 endTime String True 无 话单和录音记录的截止时间，为租间所在时区的时间，起始时间和截止时间需要做范围限制，最大为3天内。格式为：yyyy-MM-dd HH:mm:ss。 3 accountId String（1-20） False 无 企业帐号（租间ID） 4 agentId String（1-20） False 无 座席ID 5 callId String（1-25） False 无 呼叫标识，可从已调用的“下载话单和录音索引”返回的文件中获取。 6 callerNo String（1-25） False 无 主叫号码 7 calleeNo String（1-25） False 无 被叫号码，当calleeNo2不存在时为被叫号码，当calleeNo2存在时为主叫号码。 8 calleeNo2 String（1-25） False 无 被叫号码2 9 dataType String（1-11） True 无 需生成的数据记录文件类型。 call：话单记录 record：录音记录索引 call_record：话单记录和录音记录索引 10 callBackURL String True 无 回调地址。平台生成数据记录文件后将billFileName返回到该地址。

使用说明 前提条件 开发者环境已经构建，能够正常进行呼叫，开发者有独立服务器并且已经绑定回调地址（callBackURL）。 企业帐号（租间ID：accountId）、座席ID（agentId）以及话单ID（callId）为可选组合参数，可自由组合生成话单和录音索引文件。如果三者均没有传入，则生成指定时间段内该开发者下相应的数据记录。 已通过鉴权（Authorization）、获得接入地址。 请检查CC-FS配置文件“/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties”的“aicc.ssl.trustAll”是否配置为false，请配置为false，然后参考下面步骤放置证书。 以运维用户登录CC-FS的服务器，切换到root用户下。 su - root 将CC-FS生成索引文件通知回调地址加载的第三方证书上传至AICC的truststore.jks证书的同一目录中，目录为：“$HOME/conf”，具体目录请以实际环境为准。 修改上传的第三放证书的属组。 chown ccfsapp:ccfsapp XXX.jks 执行下面的命令将第三方证书导入到truststore.jks中。 keytool -import -alias xxx -file XXX.jks -keystore truststore.jks 请依据界面提示输入truststore.jks证书密码。 在环境上删除XXX.jks证书。 重启CC-FS。 进入“/home/ccfsapp/bin”目录，执行如下命令。 ./shutdown.sh;./startup.sh 使用限制 开发者只能访问该帐号下的数据信息，开发者帐号（appId）和企业帐号（租间ID：accountId）必须对应。 开发者账号（appId）包含在鉴权认证字符串中，详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。

响应说明 当调用本接口响应成功，则返回0和operate success。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据，参数说明详见表5。 表5 响应 resultData 说明 序号 名称 参数类型 说明 3.1 hashValue String 放音文件 SHA256 编码后的字符串

报文样例 请求头 POST /CCFS/resource/ccfs/ivr/getFileHash HTTP/1.1Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed0******************494941bdd106Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/3rdfile/2/thirdvoicebotfile/5dckNDei_1647502396161.wav" }} 响应参数 { "resultData": { "hashValue": "2b67748fe335617******************cf19f28bb8" }, "resultCode": "0", "resultDesc": "success"}

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