华为云用户手册

  • 报文样例 请求示例 POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/eb453f68e85******************80196c509c4913Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "fileName": "/10/1/record/appId/100/autoTest.wav" }}
  • 请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表4 请求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
  • 响应说明 当调用本接口响应成功,则从httpresponse消息中获取文件的二进制数据生成录音文件,文件后缀名为.wav,响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看表5,resultData为保留字段,默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象,参数说明详见表6 不推荐使用,为兼容老版本保留字段。 表6 响应消息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.1Authorization: auth-v2/ak/2018-07-02T02:44:42Z/content-length;content-type;host/f18f6dd19******************6b8ff99f6c5884Accept: */*Host: 10.154.198.164Content-Type: application/json;charset=UTF-8Content-Length: 185{ "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/autoTest.V3", "callId": "autoTest-1", "ccId": "1" }}
  • 响应说明 当调用本接口响应成功,则从httpresonse消息中获取文件的二进制数据生成录音文件,文件后缀名为.wav,通过callid下载多个录音文件后缀名为.zip,响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看表5,resultData为保留字段,默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象,参数说明详见表6 不推荐使用,为兼容老版本保留字段。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String(1-32) 协议版本,如2.0。 4.2 resultCode String(1-32) 请求返回的结果码,详见错误码参考。 4.3 resultMsg String 请求结果描述。
  • 请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表4 请求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”。
  • 响应说明 调用本接口获得响应分为两部分: (1)被调用方响应 (2)调用方响应,即回调第三方的响应; 被调用方响应: response响应消息参数说明详见表5-响应消息参数说明。 调用方响应(回调第三方响应):该响应由request,msgBody两部分组成。 request包含响应版本号version(默认2.0)。 msgBody由responseId(话单文件名组成部分),billName(待下载话单zip名称),accountId(租间ID)组成。响应消息resultData参数说明见表6。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码, 0:成功 非0:失败。 2 resultDesc String 请求结果描述,详见错误码参考。 3 resultData Object 请求响应数据,参数说明详见表6-响应消息resultData参数说明。 4 response Object 请求结果对象,参数说明详见表7 不推荐使用,为兼容老版本保留字段。 表6 响应消息resultData参数说明 序号 名称 参数类型 说明 3.1 responseId String 调用本接口成功后,生成的唯一标识,是文件名称的组成部分。 表7 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String(1-32) 协议版本,如2.0。 4.2 resultCode String(1-32) 请求返回的结果码,详见错误码参考。 4.3 resultMsg String 请求结果描述。 表8 回调返回消息请求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,则不会返回该值。
  • 报文样例 请求示例 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{ "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": "" }}
  • 请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表4 请求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 将待替换的CCFS生成索引文件通知回调地址加载的第三方证书上传至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 监控/系统外呼/话单/知识库类接口鉴权方式。
  • 响应说明 当调用本接口响应成功,则从httpresponse消息中获取文件的二进制数据生成话单文件,文件后缀名为.zip,文件中各参数定义参考话单录音索引文件定义,响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看表5,resultData为保留字段,默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象,参数说明详见表6 不推荐使用,为兼容老版本保留字段。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String(1-32) 协议版本,如2.0。 4.2 resultCode String(1-32) 请求返回的结果码,详见错误码参考。 4.3 resultMsg String 请求结果描述。
  • 报文样例 请求示例 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"}}}}
  • 请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 version True String(1-32) 2.0 协议版本。当前固定值为2.0。 表4 请求Body中msgBody参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 agentOprInfoFileName True String(1-49) 无 座席操作详单索引文件名称,已调用“生成座席操作详单索引”获取。 格式:yyyyMMdd_{responseId}.zip。 例如:已调用“生成座席操作详单索引”接口,调用“生成座席操作详单索引”接口的日期为2018-07-02,获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944,则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。
  • 报文样例 请求示例 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{"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)被调用方响应 (2)调用方响应,即回调第三方的响应; 被调用方响应: 该响应消息参数说明详见表5-响应消息response参数说明。 调用方响应(回调第三方响应): 该响应由request,msgBody两部分组成。msgBody参数说明详见表7-回调返回消息请求Body中msgBody参数说明。 request包含响应版本号version(默认2.0)。 msgBody由responseId(座席操作详单文件名组成部分),fileName(待下载座席操作详单zip名称),accountId(租间ID)组成。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码, 0:成功 非0:详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据,resultData参数说明详见表6-响应消息resultData参数说明。 4 response Object 请求结果对象,参数说明详见表7 不推荐使用,为兼容老版本保留字段。 表6 响应消息resultData参数说明 序号 名称 参数类型 说明 3.1 responseId String 调用本接口成功后,生成的唯一标识,是文件名称的组成部分。 表7 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String(1-32) 协议版本,如2.0。 4.2 resultCode String(1-32) 请求返回的结果码,详见错误码参考。 4.3 resultMsg String 请求结果描述。 表8 回调返回消息请求Body中msgBody参数说明 序号 名称 参数类型 说明 1 responseId String 调用本接口成功后,生成的唯一标识,是文件名称的组成部分。 2 fileName String 话单和录音索引文件名称。格式:yyyyMMdd_{responseId}.zip。 例如:调用本接口的日期为2018-07-02,获取到的responseId为9239cb50a8384bb0ab503441bf089446,则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。 3 accountId String 企业帐号(租间ID),请求参数中带的企业账号,用来将文件名和企业进行关联,如果请求参数中未填accountId,则不会返回该值。
  • 使用说明 前提条件 开发者环境已经构建,座席正常签入并进行相关操作,开发者有独立服务器并且已经绑定回调地址(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 将待替换的CCFS生成索引文件通知回调地址加载的第三方证书上传至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 监控/系统外呼/话单/知识库类接口鉴权方式。
  • 请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表4 请求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返回到该地址。
  • 请求说明 表2 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表4 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 fileName String True 无 录音文件相对路径名称,从调用“下载话单和录音索引”时返回的录音索引文件字段“original_file_name”中获取。 注意:fileName中“\”需改为“/”。
  • 报文样例 请求示例 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{ "resultData": { "token": "DC45F******************6D46F90" }, "resultCode": "0", "resultDesc": "success"}
  • 报文样例 请求示例 POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/eb45*********************c509c4913Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/39/record/20201015/10233946082696733.wav" }}
  • 响应说明 当调用本接口响应成功,则从httpresponse消息中获取文件的二进制数据生成录音文件,文件后缀名为.wav,响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看表 响应消息response参数说明,resultData为保留字段,默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据
  • 报文样例 请求示例 GET https://ip:port/CCFS/resource/ccfs/playVoice?t=1596677685425&version=2.0&st=7D41CF5DE98948979AAE063114C8AFCF3 响应示例 HTTP/1.1 200 OKContent-Type: application/octet-stream;charset=UTF-8Date: Mon, 02 Jul 2018 02:43:03 GMT{ "resultData": null, "resultCode": "010106", "resultDesc": "Parameter token is empty."}
  • 响应说明 当调用本接口响应成功,则返回对应录音文件的二进制数据流,可供windows media player直接播放。 当调用本接口响应失败,则返回相应的错误码信息,响应中content-type字段为application/octet-stream;charset=UTF-8,错误码响应数据结构请查看表3,resultData为保留字段,默认为null。 表3 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象,参数说明详见表4 不推荐使用,为兼容老版本保留字段。 表4 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String(1-32) 协议版本,如2.0。 4.2 resultCode String(1-32) 请求返回的结果码,详见错误码参考。 4.3 resultMsg String 请求结果描述。
  • 报文样例 请求示例 POST /CCFS/resource/ccfs/downloadOiapRecordHTTP/1.1Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/eb453*********************c4913Accept: */*Content-Type: application/json;charset=UTF-8Content-Length: 193{ "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/39/odfsrecord/20201019/1603089033-1205143033.wav" }}
  • 请求说明 表2 请求Request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表4 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 fileName String(1-127) True 无 智能IVR录音文件名称。 可通过https://IP:PORT/oifde/rest/api/queryRecordHistory会话查询接口获取fileName。 参数格式: 一:{录音盘符}:/{record}/{vdnId}/{odfsrecord}/{yyyymmdd}/{文件主名}.wav; 例如:Y:/record/39/odfsrecord/20201015/10233946082696733.wav 二:{录音盘符}:/{vdnId}/{odfsrecord}/{yyyymmdd}/{文件主名}.wav; 例如:Y:/39/odfsrecord/20201015/10233946082696733.wav 三: {录音盘符}:/{record}/{vdnId}/{yyyymmdd}/{文件主名}.wav ; 例如:Y:/record/39/20201015/10233946082696733.wav 四:{录音盘符}:/{vdnId}/{transferrecord}/{yyyymmdd}/{文件主名}.wav 例如:Y:/39/transferrecord/20201015/10233946082696733.wav 说明:{vdnId}为vdn编号,{yyyymmdd}为生成智能IVR录音文件的日期,{文件主名}为录音文件的名称。
  • 响应说明 当调用本接口响应成功,则从httpresponse消息中获取文件的二进制数据生成录音文件,文件后缀名为.wav,响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看表 响应消息response参数说明,resultData为保留字段,默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述,详见错误码参考。 3 resultData Object 请求响应数据 4 response Object 请求结果对象,参数说明详见表6 不推荐使用,为兼容老版本保留字段。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String(1-32) 协议版本,如2.0。 4.2 resultCode String(1-32) 请求返回的结果码,详见错误码参考。 4.3 resultMsg String 请求结果描述,详见错误码参考。
  • 接口URI 表1 接口URI说明 请求URI https://ip:port/CCFS/resource/ccfs/downloadOiapRecord?locationId=xx 其中,ip、port为话单数据服务器接入地址。 locationId:节点Id,可选,通过调用会话记录查询接口(https://IP:PORT/oifde/rest/api/queryRecordHistory)查询locationId。
  • 响应说明 当调用本接口响应成功,则返回0和operate success。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看表5,resultData为保留字段,默认为空字符串。 表3 响应消息参数说明 序号 名称 参数类型 说明 1 returnCode String 请求返回的结果码, 0:成功 非0:详见错误码参考。 2 description String 请求结果描述。
  • 报文样例 请求示例 DELETE /CCFS/resource/ccfs/deleteTenantData?tenantId=202101194034 HTTP/1.1X-Access-Token: IAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABIG9eyJpc3N1ZWRfYXQiOiIyMDIxLTAzLTA4VDEyOjAxOjIwLjI1MyswMDAwIiwiZXhwaXJlc19hdCI6IjIwMjAccept: */*Host: 10.154.198.164Content-Type: application/json;charset=UTF-8 响应示例 { "returnCode": "0", "description": "operate success"}
  • 座席操作详单索引文件(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) 执行当前操作时座席拥有技能列表的索引。 当取值为空时,表示座席不拥有任务技能。例如:座席签入时,此字段则为空。
共100000条