选择性录制文件接口说明

下载pdf
更新时间:2019-09-27 10:09

请注意:该功能需要联系 ZEGO 技术支持开通。

CDN默认完全录制,当有指定时间录制需求时,使用该接口。

1 接口调用说明

http请求方式: POST/FORM,需使用https
正式环境地址
https://webapi.zego.im/cgi/record-start?access_token=ACCESS_TOKEN
测试环境地址
https://testwebapi.zego.im/cgi/record-start?access_token=ACCESS_TOKEN

2 开始录制参数说明

参数名 是否必须 说明
streams 流名。多个流名,用英文逗号(,)隔开

3 开始录制示例

curl -X POST 'http://webapi.zego.im/cgi/record-start?access_token=ACCESS_TOKEN' -d streams=STREAM

4 开始录制返回说明

参数名 说明
code 返回码
message 操作结果描述
ws CDN调用返回说明

正常情况下,会返回下述JSON数据包给调用方:

{
    "code": 0,//返回码
    "message": "success",//操作结果描述
    "data": {
        "ws": {
            "msg": "success",//提示语
            "http_code": 200,//业务状态
            "trace_id": "2e4c35e0-a434-421c-ab9f-0111e4c20f37",//交易流水
            "call_time": "2017-11-14 11:19:30",//请求时间
            "list": [//任务明细
                {
                    "task": "mp4",//文件格式
                    "id": "stream1",//流名
                    "http_code": 200,//处理成功
                    "msg": null,//提示语
                    "persistentId": "2020ed38be2cea104d4aac082ee1b5bb872f"//文件标识
                },
                {
                    "task": "mp4",
                    "id": "stream2",
                    "http_code": 200,
                    "msg": null,
                    "persistentId": "20205820865249994f109d94d1b1e05e09a8"
                }
            ]
        }
    }
}

5 停止录制接口调用说明

http请求方式: POST/FORM,需使用https
正式环境地址
https://webapi.zego.im/cgi/record-stop?access_token=ACCESS_TOKEN
测试环境地址
https://testwebapi.zego.im/cgi/record-stop?access_token=ACCESS_TOKEN

6 停止录制参数说明

参数名 是否必须 说明
streams 流名。多个流名,用英文逗号(,)隔开

7 停止录制示例

curl -X POST 'http://webapi.zego.im/cgi/record-stop?access_token=ACCESS_TOKEN' -d streams=STREAM

8 停止录制返回说明

参数名 说明
code 返回码
message 操作结果描述
ws CDN调用返回说明

正常情况下,会返回下述JSON数据包给调用方:

{
    "code": 0,//返回码
    "message": "success",//操作结果描述
    "data": {
        "ws": {
            "msg": "success",//提示语
            "http_code": 200,//业务状态
            "trace_id": "2e4c35e0-a434-421c-ab9f-0111e4c20f37",//交易流水
            "call_time": "2017-11-14 11:20:30",//请求时间
            "list": [//任务明细
                {
                    "task": "mp4",//文件格式
                    "id": "stream1",//流名
                    "http_code": 200,//处理成功
                    "msg": null,//提示语
                    "persistentId": "2020ed38be2cea104d4aac082ee1b5bb872f"//文件标识
                },
                {
                    "task": "mp4",
                    "id": "stream2",
                    "http_code": 200,
                    "msg": null,
                    "persistentId": "20205820865249994f109d94d1b1e05e09a8"
                }
            ]
        }
    }
}

录制回调格式

返回参数

参数名 说明 数据类型
replay_url 回看地址 string
begin_time 录制开始时间 string
end_time 录制结束时间 string
stream_alias 流名 string
extra_params 扩展字段 string

extra_params 参数

参数名 说明 数据类型
PersistentId 任务标识id string
Duration 录制时长 float

数据示例

{
        "replay_url": replay_url,
        "begin_time": 1481597358,
        "end_time": 1481597358,
        "stream_alias": aaa,
        "extra_params": extra_params
}