2.3. 录制 REST API¶
2.3.1. 版本信息¶
v1.0.0, 2017/06/29
2.3.2. 创建录制¶
请求说明: http://xx.yy.zz:8050/avd/api/record/createUserRecord HTTP/1.1
接口描述: 创建房间的一个用户录制，仅为方便对某一用户的录制
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| accessToken | String | 是 | 认证成功后根据规则生成的串 |
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| name | String | 是 | 记录名称 |
| tag | String | 是 | 记录标记 |
| roomId | String | 是 | 所属房间号 |
| userId | String | 是 | 用户ID，唯一 |
| audioType | String | 是 | 音频类型 [1] |
| videoType | String | 是 | 视频类型 [2] |
| fileType | String | 是 | 文件类型 [3] |
返回说明:
http 响应:json
{
result: "0"
data: {
"id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
"status" : 1
}
}
主要返回码: 0,
返回值说明:
id：记录号，录制创建的时候产生，唯一标识一个录制的记录
status: 录制记录状态 [4]
2.3.3. 停止录制¶
请求说明: http://xx.yy.zz:8050/avd/api/record/stop HTTP/1.1
接口描述: 停止一个录制
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| accessToken | String | 是 | 认证成功后根据规则生成的串 |
| id | String | 是 | 记录ID |
返回说明:
http 响应:json
{
"ret": 0,
data: {
"id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
"roomId" : "room-3811-4726-b508",
"name" : "Foo",
"createTime" : "2015-07-23 20:05:52"
"duration" : 5049,
"audioType" : 1,
"videoType" : 1,
"size" : 247748791,
"status" : 2,
"url" : "http://record.3tee.cn/b40ef09b-3811-4726-b508-e41a0f96c68f.mp4"
}
}
主要返回码: 0,
返回值说明:
2.3.4. 获取录制记录信息¶
请求说明: http://xx.yy.zz:8050/avd/api/record/getRecord HTTP/1.1
接口描述: 获取一个录制记录信息
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| accessToken | String | 是 | 认证成功后根据规则生成的串 |
| id | String | 是 | 记录ID |
返回说明:
http 响应:json
{
"ret": 0,
data: {
"id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
"roomId" : "room-3811-4726-b508",
"name" : "Foo",
"createTime" : "2015-07-23 20:05:52"
"duration" : 5049,
"audioType" : 1,
"videoType" : 1,
"size" : 247748791,
"status" : 2,
"url" : "http://record.3tee.cn/b40ef09b-3811-4726-b508-e41a0f96c68f.mp4"
}
}
主要返回码: 0,
返回值说明:
2.3.5. 删除记录¶
请求说明: http://xx.yy.zz:8050/avd/api/record/delete HTTP/1.1
接口描述: 删除一个记录
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| accessToken | String | 是 | 认证成功后根据规则生成的串 |
| id | String | 是 | 记录ID |
返回说明:
http 响应:json
{
"ret": 0,
data: {
"id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
"status" : 2
}
}
主要返回码: 0,
返回值说明:
id：记录号，录制创建的时候产生，唯一标识一个录制的记录
status: 录制记录状态 [4]
2.3.6. 查询录制记录¶
请求说明: http://xx.yy.zz:8050/avd/api/record/findRecords HTTP/1.1
接口描述: 查询录制记录
接口实例: http://127.0.0.1:8050/avd/api/record/findRecords?accessToken=YmE4ZDg4YTY5NGMzZWMwZWMzNjQ1MWRiZGQwMDlmOTZiNWQxMDVkNg==&begin=1&count=4&filter={“fromTime”:”2017-06-03”,”endTime”:”2017-06-29”,”roomId”:”r5”,”userId”:”testRecord”}
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| accessToken | String | 是 | 认证成功后根据规则生成的串 |
| begin | int | 否 | 从第几条记录开始 |
| count | int | 否 | 取几条记录 |
| filter | JSON | 否 | JSON对象，过滤参数信息 |
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| fromTime | date | 否 | 筛选录制起始时间（这个时间之后），格式是yyyy-mm-dd |
| endTime | date | 否 | 筛选录制停止时间（这个时间之前），格式是yyyy-mm-dd |
| roomId | String | 否 | 筛选录制的房间id |
| userId | String | 否 | 筛选录制的用户id |
返回说明:
http 响应:json
{
"ret": 0,
data: {
"total" : 21,
"begin" : 5,
"count" : 6,
"items" : [
{
"id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
"roomId" : "room-3811-4726-b508",
"name" : "Foo",
"audioType " : 1,
"videoType " : 1,
"createTime" : "2015-07-23 20:05:52",
"duration" : 5049,
"size" : 247748791,
"status" : 2,
"url" : "http://record.3tee.cn/b40ef09b-3811-4726-b508-e41a0f96c68f.mp4"
}
... ...
]
}
}
主要返回码: 0,
返回值说明:
2.3.7. 变量定义¶
| [1] | (1, 2, 3, 4) 音频类型定义/audioType 0 ：无音频 1 ：同视频用户的单用户音频 2 ：整个房间中的所有音频混音 |
| [2] | (1, 2, 3, 4) 视频类型定义/videoType 0 ：无视频 1 ：视频主流 2 ：视频辅流1 3 ：视频辅流2 |
| [3] | 文件类型定义/fileType 0 ：Mp4文件类型，只能录制H264码流 1 ：WebM文件类型，只能录制VP8/VP9视频码流 |
| [4] | (1, 2, 3, 4, 5) 录制记录状态定义/status 0 ：创建录制 1 ：正在录制（如果相应视频和音频流上传服务器，就会保持到录制中；如没数据也无录制） 2 ：录制完成可查看 3 ：录制被删除 4 ：录制异常（如不完整等） |
2.3.8. 错误码表¶
| ret | 详细描述 |
|---|---|
| 0 | 成功 |
| 301 | 授权不通过 |
| 306 | 创建失败，多是后台服务未启动 |
| 307 | 停止失败，多是后台服务未启动 |
| 308 | 录制Id无效，已删除或没创建成功 |
| 310 | 返回超时，多是后台服务未启动 |
| 401 | 参数不对 |