更新时间:2023-09-27 GMT+08:00

视频文件下载接口

前置条件

  • Gateway已经打开了视频文件下载开关(VIDEO_DOWNLOAD_FLAG 配置为ON)和视频事件开关(IF_SUPPORT_VIDEO配置为ON),配置文件路径:/home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties。
  • 座席已签入

场景描述

MCU录制模式下,下载视频通话产生的视频文件(不建议通过该接口下载超过200MB视频文件)。

接口方法

设置成“GET”。该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。

接口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:文件辅流

日志中的方法名

downloadVideoFile

请求说明

  • 消息头
    表2 请求头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式,缺省值:application/json; charset=UTF-8

    2

    Guid

    string

    True

    静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。

  • 消息体

响应说明

该接口的响应说明体举例如下:

  • 下载失败时:

    消息头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

    消息体 文件流

触发事件

  • 座席签入,调用视频文件下载接口。

错误结果码

  • 108-001
  • 108-002
  • 108-003
  • 108-004
  • 108-005
  • 108-006
  • 108-007
  • 108-008
  • 108-009

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
    Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

  • 响应参数
    {
        "retcode": "000-003",
        "message": "no right to invite resource",
        "result": ""
    }