华为云用户手册

  • 接口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。
  • 接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/startrecordscreen 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/stoprecordscreen 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "fileName": "Y:/15/0/20201119/186/142702.V3", "mediaType": 5, "recordMode": 0, "recordFormat": 0} 响应参数 { "result": { "taskId": "5086" }, "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/stoprecord 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/record 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 fileName string False 录音文件存储路径(最大长度为100,可为空)。 不传或为空时,系统自动生成,格式如下: 盘符:\VDN号\媒体类型编号\年月日\工号\文件名+后缀 其中盘符可以由basic.properties中MAPPINGDISK配置项配置,不配置时默认为“Y” 2 mediaType int True 被录制的媒体类型,目前只能填写5,普通语音 3 recordMode int False 录制的方式 0:覆盖方式 1:追加方式 当不传参或传入参数为其他值时,默认为0 4 recordFormat int False 录制的文件格式 0: 按资源侧缺省配置格式播放,语音缺省文件格式,在录音资源侧配置 1: 24KVOX语音文件 2: 32KVOX语音文件 3: 64KALAW语音文件 不传参时,默认为0 说明: 一套环境中,只能使用一种录音格式,不能在不同的呼叫中设置不同的录音格式。 下发的录音格式,需要与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留言录音或者第三方留言录音文件 说明: 1.IVR录音留言录音文件路径格式为:盘符:/vdn编号/record/**** 例:y:/1/record/20190412/playvoice1551276018824.wav 2.第三方留言录音文件路径格式为:盘符:/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}/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": ""}
  • 接口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": ""}
  • 响应说明 该接口的响应说明体举例如下: 下载失败时: 消息头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 消息体 文件流
  • 前置条件 Gateway已经打开了视频文件下载开关(VIDEO_DOWNLOAD_FLAG 配置为ON)和视频事件开关(IF_SUPPORT_VIDEO配置为ON),配置文件路径:/home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties。 Gateway已经挂载文件服务器。 座席已签入。 配置文件中已配置挂载目录。
  • 报文样例 消息头 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}/videofiledownloadEx?recordId=xxx&locationId=xxx 例 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 recordId string True 视频文件路径。 说明: 如果recordId不传,默认下载第一条录播地址对应的视频文件。 3 locationId int False 节点Id(CTI POOL模式下为必选)
  • 响应说明 该接口的响应说明体举例如下: 下载失败时: 消息头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 消息体 文件流
  • 场景描述 调用该接口,将CC-FS侧的录音文件上传到OBS/LSS,再从OBS/LSS获取录音下载和播放的路径。 前提条件:录音文件已经通过定时任务同步到CCFS侧的数据库。 使用限制 开发者只能下载自己帐号下的录音,开发者帐号(ak)和录音记录(callId)必须对应。 开发者账号(ak)包含在鉴权认证字符串中,详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 callId、beginTime、endTime必须唯一确定一条录音。
  • 报文样例 请求头 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"} 响应头 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按开始时间和结束时间顺序排序。
  • 请求说明 表1 请求Headers参数说明 参数名称 选取原则 参数类型 默认值 说明 Content-Type 必选 String 无 固定填 application/json; charset=UTF-8。 Authorization 必选 String 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body参数说明 参数名称 选取原则 参数类型 默认值 说明 callId 必选 String(1-25) 无 呼叫标识Id。 beginTime 必选 String 无 录音记录的起始时间(0时区)。格式为:yyyy-MM-dd HH:mm:ss。 endTime 必选 String 无 录音记录的截止时间(0时区)。格式为:yyyy-MM-dd HH:mm:ss。 录音记录的截止时间与起始时间跨度不能超过3天。 须知: “录音记录的起始时间”和“录音记录的截止时间”两个参数应该填入0时区的时间,您需要用您所在时区的时间换算为0时区的时间。 例如,您现在位于中国(东八区),您希望查询的开始时间为2022-01-02 10:00:00,那么“录音记录的起始时间”参数应该填入的值为2022-01-02 02:00:00。
  • 报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": -1, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "en_US" }} 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }
  • 报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": 10000, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "" }} 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }
  • 报文样例 请求消息样例 { "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, "amout": 1 }, { "id": 10005, "tenantId": "00030010", "name": "Social Security Related FAQ", "description": "", "language": "en_US", "updateTime": 1556260257000, "on": false, "amout": 1 }, { "id": 10002, "tenantId": "00030010", "name": "Service Provisioning", "description": "", "language": "en_US", "updateTime": 1554285568000, "on": false, "amout": 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 智能助手平台接口鉴权方式
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 faqGroupId int body True 要变更状态的问答组ID。 on boolean body False 是否激活,默认为false。 true:激活 false:去激活 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。
共100000条