ZLMediaKit/postman/ZLMediaKit.postman_collection.json

1754 lines
42 KiB
JSON
Raw Normal View History

2020-07-11 23:17:36 +08:00
{
"info": {
2022-08-12 18:09:44 +08:00
"_postman_id": "4626d766-16b5-4255-89ba-f7614de2398c",
2020-07-11 23:17:36 +08:00
"name": "ZLMediaKit",
"description": "媒体服务器",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "获取服务器api列表(getApiList)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getApiList?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getApiList"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
},
{
"name": "获取网络线程负载(getThreadsLoad)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getThreadsLoad?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getThreadsLoad"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
},
2021-01-23 09:44:37 +08:00
{
"name": "获取主要对象个数(getStatistic)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getStatistic?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getStatistic"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
},
2020-07-11 23:17:36 +08:00
{
"name": "获取后台线程负载(getWorkThreadsLoad)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getWorkThreadsLoad?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getWorkThreadsLoad"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
},
{
"name": "获取服务器配置(getServerConfig)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getServerConfig?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getServerConfig"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
},
{
"name": "设置服务器配置(setServerConfig)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/setServerConfig?secret={{ZLMediaKit_secret}}&api.apiDebug=0",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"setServerConfig"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "api.apiDebug",
"value": "0",
"description": "配置键与配置项值"
}
]
}
},
"response": []
},
{
"name": "重启服务器(restartServer)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/restartServer?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"restartServer"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
},
{
"name": "获取流列表(getMediaList)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getMediaList?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getMediaList"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "schema",
"value": "rtmp",
"description": "筛选协议,例如 rtsp或rtmp",
"disabled": true
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "筛选虚拟主机例如__defaultVhost__",
"disabled": true
},
{
"key": "app",
"value": null,
"description": "筛选应用名,例如 live",
"disabled": true
},
{
"key": "stream",
"value": null,
"description": "筛选流id例如 test",
"disabled": true
2020-07-11 23:17:36 +08:00
}
]
}
},
"response": []
},
{
"name": "关断单个流(close_stream)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/close_stream?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=live&stream=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"close_stream"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "schema",
"value": "rtsp",
"description": "协议,例如 rtsp或rtmp"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "test",
"description": "流id例如 test"
},
{
"key": "force",
"value": "1",
"description": "是否强制关闭(有人在观看是否还关闭)",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "批量关断流(close_streams)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/close_streams?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=live&stream=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"close_streams"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "schema",
"value": "rtsp",
"description": "协议,例如 rtsp或rtmp"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "test",
"description": "流id例如 test"
},
{
"key": "force",
"value": "1",
"description": "是否强制关闭(有人在观看是否还关闭)",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "获取TcpSession列表(getAllSession)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getAllSession?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getAllSession"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "local_port",
"value": "",
"description": "筛选本机端口例如筛选rtsp链接554",
"disabled": true
},
{
"key": "peer_ip",
"value": null,
"description": "筛选客户端ip",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "断开tcp连接(kick_session)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/kick_session?secret={{ZLMediaKit_secret}}&id=123456",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"kick_session"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "id",
"value": "123456",
"description": "客户端唯一id可以通过getAllSession接口获取"
}
]
}
},
"response": []
},
{
"name": "批量断开tcp连接(kick_sessions)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/kick_sessions?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"kick_sessions"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "local_port",
"value": "",
"description": "筛选本机端口例如筛选rtsp链接554",
"disabled": true
},
{
"key": "peer_ip",
"value": null,
"description": "筛选客户端ip",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "添加rtsp/rtmp/hls拉流代理(addStreamProxy)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/addStreamProxy?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=test&url=rtmp://live.hkstv.hk.lxdns.com/live/hks2",
2020-07-11 23:17:36 +08:00
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"addStreamProxy"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "添加的流的虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "添加的流的应用名例如live"
},
{
"key": "stream",
"value": "test",
"description": "添加的流的id名例如test"
},
{
"key": "url",
"value": "rtmp://live.hkstv.hk.lxdns.com/live/hks2",
"description": "拉流地址例如rtmp://live.hkstv.hk.lxdns.com/live/hks2"
},
{
"key": "rtp_type",
"value": null,
"description": "rtsp拉流时拉流方式0tcp1udp2组播",
"disabled": true
},
{
"key": "timeout_sec",
"value": "10",
"description": "拉流超时时间单位秒float类型",
"disabled": true
},
{
"key": "retry_count",
"value": "",
"description": "拉流重试次数,不传此参数或传值<=0时则无限重试",
"disabled": true
},
2020-07-11 23:17:36 +08:00
{
"key": "enable_hls",
"value": null,
"description": "是否转hls",
"disabled": true
},
{
"key": "enable_mp4",
"value": null,
"description": "是否mp4录制",
"disabled": true
},
{
"key": "enable_rtsp",
"value": "1",
"description": "是否转协议为rtsp/webrtc",
"disabled": true
},
{
"key": "enable_rtmp",
"value": "1",
"description": "是否转协议为rtmp/flv",
"disabled": true
},
{
"key": "enable_ts",
"value": "1",
"description": "是否转协议为http-ts/ws-ts",
"disabled": true
},
{
"key": "enable_fmp4",
"value": "1",
"description": "是否转协议为http-fmp4/ws-fmp4",
"disabled": true
},
{
"key": "enable_audio",
"value": "1",
"description": "转协议是否开启音频",
"disabled": true
},
{
"key": "add_mute_audio",
"value": "1",
"description": "转协议无音频时是否添加静音aac音频",
"disabled": true
},
{
"key": "mp4_save_path",
2020-07-11 23:17:36 +08:00
"value": null,
"description": "mp4录制保存根目录置空使用默认目录",
2020-07-11 23:17:36 +08:00
"disabled": true
2021-04-30 18:01:48 +08:00
},
{
"key": "mp4_max_second",
"value": "1800",
"description": "mp4录制切片大小单位秒",
2021-04-30 18:01:48 +08:00
"disabled": true
2021-06-17 11:03:11 +08:00
},
{
"key": "hls_save_path",
2021-06-17 11:03:11 +08:00
"value": null,
"description": "hls保存根目录置空使用默认目录",
2021-06-17 11:03:11 +08:00
"disabled": true
2020-07-11 23:17:36 +08:00
}
]
}
},
"response": []
},
{
"name": "关闭拉流代理(delStreamProxy)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/delStreamProxy?secret={{ZLMediaKit_secret}}&key=__defaultVhost__/live/1",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"delStreamProxy"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "key",
"value": "__defaultVhost__/live/1",
"description": "addStreamProxy接口返回的key"
}
]
}
},
"response": []
},
2021-06-17 11:03:11 +08:00
{
"name": "添加rtsp/rtmp推流(addStreamPusherProxy)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/addStreamPusherProxy?secret={{ZLMediaKit_secret}}&schema=rtmp&vhost={{defaultVhost}}&app=live&stream=test&dst_url=rtmp://127.0.0.1/live/push",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"addStreamPusherProxy"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "schema",
"value": "rtmp",
"description": "推流协议支持rtsp、rtmp大小写敏感"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "已注册流的虚拟主机一般为__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "已注册流的应用名例如live"
},
{
"key": "stream",
"value": "test",
"description": "已注册流的id名例如test"
},
{
"key": "dst_url",
"value": "rtmp://127.0.0.1/live/push",
"description": "推流地址需要与schema字段协议一致"
},
{
"key": "rtp_type",
"value": "0",
"description": "rtsp推流时推流方式0tcp1udp",
"disabled": true
},
{
"key": "timeout_sec",
"value": "10",
"description": "推流超时时间单位秒float类型",
"disabled": true
},
{
"key": "retry_count",
"value": null,
"description": "推流重试次数,不传此参数或传值<=0时则无限重试",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "关闭推流(delStreamPusherProxy)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/delStreamPusherProxy?secret={{ZLMediaKit_secret}}&key=__defaultVhost__/live/test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"delStreamPusherProxy"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "key",
"value": "__defaultVhost__/live/test",
"description": "addStreamPusherProxy接口返回的key"
}
]
}
},
"response": []
},
2020-07-11 23:17:36 +08:00
{
"name": "添加FFmpeg拉流代理(addFFmpegSource)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/addFFmpegSource?secret={{ZLMediaKit_secret}}&src_url=http://hefeng.live.tempsource.cjyun.org/videotmp/s10100-hftv.m3u8&dst_url=rtmp://127.0.0.1/live/hks2&timeout_ms=10000&enable_hls=0&enable_mp4=0",
2020-07-11 23:17:36 +08:00
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"addFFmpegSource"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "src_url",
"value": "http://hefeng.live.tempsource.cjyun.org/videotmp/s10100-hftv.m3u8",
2020-07-11 23:17:36 +08:00
"description": "FFmpeg拉流地址,支持任意协议或格式(只要FFmpeg支持即可)"
},
{
"key": "dst_url",
2020-10-01 14:45:43 +08:00
"value": "rtmp://127.0.0.1/live/hks2",
2020-07-11 23:17:36 +08:00
"description": "FFmpeg rtmp推流地址一般都是推给自己例如rtmp://127.0.0.1/live/stream_form_ffmpeg"
},
{
"key": "timeout_ms",
"value": "10000",
"description": "FFmpeg推流成功超时时间,单位毫秒"
},
{
"key": "enable_hls",
"value": "0",
"description": "是否开启hls录制"
},
{
"key": "enable_mp4",
"value": "0",
"description": "是否开启mp4录制"
2021-01-23 09:44:37 +08:00
},
{
"key": "ffmpeg_cmd_key",
"value": "ffmpeg.cmd_hd",
"description": "FFmpeg命名参数模板置空则采用配置项:ffmpeg.cmd",
"disabled": true
2020-07-11 23:17:36 +08:00
}
]
}
},
"response": []
},
{
"name": "关闭FFmpeg拉流代理(delFFmpegSource)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/delFFmpegSource?secret={{ZLMediaKit_secret}}&key=5f748d2ef9712e4b2f6f970c1d44d93a",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"delFFmpegSource"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "key",
"value": "5f748d2ef9712e4b2f6f970c1d44d93a"
}
]
}
},
"response": []
},
{
"name": "流是否在线(isMediaOnline)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/isMediaOnline?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=proxy&stream=1",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"isMediaOnline"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "schema",
"value": "rtsp",
"description": "协议,例如 rtsp或rtmp"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "proxy",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "1",
"description": "流id例如 test"
}
]
}
},
"response": []
},
{
"name": "获取流信息(getMediaInfo)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getMediaInfo?secret={{ZLMediaKit_secret}}&schema=rtsp&vhost={{defaultVhost}}&app=live&stream=mym9",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getMediaInfo"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "schema",
"value": "rtsp",
"description": "协议,例如 rtsp或rtmp"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "mym9",
"description": "流id例如 test"
}
]
}
},
"response": []
},
{
"name": "获取流信息(getMp4RecordFile)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getMp4RecordFile?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=proxy&stream=2&customized_path=/www&period=2020-05-26",
2020-07-11 23:17:36 +08:00
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getMp4RecordFile"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "proxy",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "2",
"description": "流id例如 test"
},
{
"key": "customized_path",
"value": "/www",
"description": "录像文件保存自定义根目录,为空则采用配置文件设置"
},
2020-07-11 23:17:36 +08:00
{
"key": "period",
"value": "2020-05-26",
"description": "流的录像日期格式为2020-02-01,如果不是完整的日期那么是搜索录像文件夹列表否则搜索对应日期下的mp4文件列表"
}
]
}
},
"response": []
},
{
"name": "删除录像文件夹(deleteRecordDirectory)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/deleteRecordDirectory?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=proxy&stream=2&period=2020-01-01",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"deleteRecordDirectory"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "proxy",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "2",
"description": "流id例如 test"
},
{
"key": "period",
"value": "2020-01-01",
"description": "流的录像日期格式为2020-01-01,如果不是完整的日期,那么会删除失败"
}
]
}
},
"response": []
},
2020-07-11 23:17:36 +08:00
{
"name": "开始录制(startRecord)",
"request": {
"method": "GET",
"header": [],
"url": {
2021-06-17 11:03:11 +08:00
"raw": "{{ZLMediaKit_URL}}/index/api/startRecord?secret={{ZLMediaKit_secret}}&type=1&vhost={{defaultVhost}}&app=live&stream=obs",
2020-07-11 23:17:36 +08:00
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"startRecord"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "type",
"value": "1",
"description": "0为hls1为mp4"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
},
{
"key": "customized_path",
"value": null,
2021-06-17 11:03:11 +08:00
"description": "录像文件保存自定义根目录,为空则采用配置文件设置",
"disabled": true
},
{
"key": "max_second",
"value": "1000",
2021-06-17 11:03:11 +08:00
"description": "MP4录制的切片时间大小单位秒",
"disabled": true
2020-07-11 23:17:36 +08:00
}
]
}
},
"response": []
},
2021-10-25 15:13:21 +08:00
{
"name": "设置录像速度(setRecordSpeed)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/setRecordSpeed?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs&speed=2.0",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"setRecordSpeed"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
},
{
"key": "speed",
2022-08-12 18:09:44 +08:00
"value": "2.0",
2021-11-23 22:50:43 +08:00
"description": "要设置的录像倍速"
2021-10-25 15:13:21 +08:00
}
]
}
},
"response": []
},
{
"name": "设置录像流播放位置(seekRecordStamp)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/seekRecordStamp?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs&stamp",
2021-10-25 15:13:21 +08:00
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"seekRecordStamp"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
},
{
"key": "stamp",
"value": 1000,
2021-11-23 22:50:43 +08:00
"description": "要设置的录像播放位置"
2021-10-25 15:13:21 +08:00
}
]
}
},
"response": []
},
2020-07-11 23:17:36 +08:00
{
"name": "停止录制(stopRecord)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/stopRecord?secret={{ZLMediaKit_secret}}&type=1&vhost={{defaultVhost}}&app=live&stream=obs",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"stopRecord"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "type",
"value": "1",
"description": "0为hls1为mp4"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
}
]
}
},
"response": []
},
{
"name": "是否正在录制(isRecording)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/isRecording?secret={{ZLMediaKit_secret}}&type=1&vhost={{defaultVhost}}&app=live&stream=obs",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"isRecording"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "type",
"value": "1",
"description": "0为hls1为mp4"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
}
]
}
},
"response": []
},
{
"name": "获取截图(getSnap)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getSnap?secret={{ZLMediaKit_secret}}&url=rtsp://www.mym9.com/101065?from=2019-06-28/01:12:13&timeout_sec=10&expire_sec=1",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getSnap"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "url",
"value": "rtsp://www.mym9.com/101065?from=2019-06-28/01:12:13",
"description": "需要截图的url可以是本机的也可以是远程主机的"
},
{
"key": "timeout_sec",
"value": "10",
"description": "截图失败超时时间防止FFmpeg一直等待截图"
},
{
"key": "expire_sec",
"value": "1",
"description": "截图的过期时间,该时间内产生的截图都会作为缓存返回"
}
]
}
},
"response": []
},
{
"name": "获取rtp推流信息(getRtpInfo)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/getRtpInfo?secret={{ZLMediaKit_secret}}&stream_id=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"getRtpInfo"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "stream_id",
"value": "test",
"description": "流id"
}
]
}
},
"response": []
},
{
"name": "创建RTP服务器(openRtpServer)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/openRtpServer?secret={{ZLMediaKit_secret}}&port=0&enable_tcp=1&stream_id=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"openRtpServer"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "port",
"value": "0",
"description": "绑定的端口0时为随机端口"
},
{
"key": "enable_tcp",
"value": "1",
"description": "创建 udp端口时是否同时监听tcp端口"
},
{
"key": "stream_id",
"value": "test",
"description": "该端口绑定的流id\n"
},
{
"key": "re_use_port",
"value": "0",
"description": "是否重用端口默认为0非必选参数",
"disabled": true
},
{
"key": "ssrc",
"value": "0",
"description": "是否指定收流的rtp ssrc, 十进制数字不指定或指定0时则不过滤rtp非必选参数",
"disabled": true
2020-07-11 23:17:36 +08:00
}
]
}
},
"response": []
},
{
"name": "关闭RTP服务器(closeRtpServer)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/closeRtpServer?secret={{ZLMediaKit_secret}}&stream_id=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"closeRtpServer"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "stream_id",
"value": "test",
"description": "该端口绑定的流id"
}
]
}
},
"response": []
},
{
"name": "暂停RTP超时检查(pauseRtpCheck)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/pauseRtpCheck?secret={{ZLMediaKit_secret}}&stream_id=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"pauseRtpCheck"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "stream_id",
"value": "test",
"description": "该端口绑定的流id"
}
]
}
},
"response": []
},
{
"name": "恢复RTP超时检查(resumeRtpCheck)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/resumeRtpCheck?secret={{ZLMediaKit_secret}}&stream_id=test",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"resumeRtpCheck"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
2020-07-11 23:17:36 +08:00
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "stream_id",
"value": "test",
"description": "该端口绑定的流id"
}
]
}
},
"response": []
},
{
"name": "获取RTP服务器列表(listRtpServer)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/listRtpServer?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"listRtpServer"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
}
]
}
},
"response": []
2020-09-06 17:56:05 +08:00
},
{
"name": "开始发送rtp(startSendRtp)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/startSendRtp?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs&ssrc=1&dst_url=127.0.0.1&dst_port=10000&is_udp=0",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"startSendRtp"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
},
{
"key": "ssrc",
"value": "1",
2020-12-27 21:32:56 +08:00
"description": "rtp推流的ssrcssrc不同时可以推流到多个上级服务器"
2020-09-06 17:56:05 +08:00
},
{
"key": "dst_url",
"value": "127.0.0.1",
"description": "目标ip或域名"
},
{
"key": "dst_port",
"value": "10000",
"description": "目标端口"
},
{
"key": "is_udp",
"value": "0",
"description": "是否为udp模式,否则为tcp模式"
2020-12-27 21:32:56 +08:00
},
{
"key": "src_port",
"value": "0",
"description": "指定tcp/udp客户端使用的本地端口0时为随机端口该参数非必选参数不传时为随机端口。",
"disabled": true
},
{
"key": "from_mp4",
"value": "0",
"description": "是否推送本地MP4录像该参数非必选参数",
"disabled": true
2022-04-03 18:25:36 +08:00
},
{
"key": "use_ps",
"value": "1",
"description": "rtp打包采用ps还是es模式默认采用ps模式该参数非必选参数",
"disabled": true
},
{
"key": "pt",
"value": "96",
"description": "rtp payload type默认96该参数非必选参数",
"disabled": true
},
{
"key": "only_audio",
"value": "1",
"description": "rtp es方式打包时是否只打包音频该参数非必选参数",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "开始tcp passive被动发送rtp(startSendRtpPassive)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/startSendRtpPassive?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=test&ssrc=1",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"startSendRtpPassive"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "test",
"description": "流id例如 obs"
},
{
"key": "ssrc",
"value": "1",
"description": "rtp推流的ssrcssrc不同时可以推流到多个上级服务器"
},
{
"key": "src_port",
"value": "0",
"description": "指定tcp/udp客户端使用的本地端口0时为随机端口该参数非必选参数不传时为随机端口。",
"disabled": true
},
{
"key": "from_mp4",
"value": "0",
"description": "是否推送本地MP4录像该参数非必选参数",
"disabled": true
},
{
"key": "use_ps",
"value": "1",
"description": "rtp打包采用ps还是es模式默认采用ps模式该参数非必选参数",
"disabled": true
2022-04-03 18:25:36 +08:00
},
{
"key": "pt",
"value": "96",
"description": "rtp payload type默认96该参数非必选参数",
"disabled": true
},
{
"key": "only_audio",
"value": "1",
"description": "rtp es方式打包时是否只打包音频该参数非必选参数",
"disabled": true
2020-09-06 17:56:05 +08:00
}
]
}
},
"response": []
},
{
"name": "停止 发送rtp(stopSendRtp)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/stopSendRtp?secret={{ZLMediaKit_secret}}&vhost={{defaultVhost}}&app=live&stream=obs",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"stopSendRtp"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}",
"description": "api操作密钥(配置文件配置)如果操作ip是127.0.0.1,则不需要此参数"
},
{
"key": "vhost",
"value": "{{defaultVhost}}",
"description": "虚拟主机例如__defaultVhost__"
},
{
"key": "app",
"value": "live",
"description": "应用名,例如 live"
},
{
"key": "stream",
"value": "obs",
"description": "流id例如 obs"
2020-12-27 21:32:56 +08:00
},
{
"key": "ssrc",
"value": "",
"description": "根据ssrc关停某路rtp推流不传时关闭所有推流",
"disabled": true
2020-09-06 17:56:05 +08:00
}
]
}
},
"response": []
2022-08-12 18:09:44 +08:00
},
{
"name": "获取版本信息(version)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{ZLMediaKit_URL}}/index/api/version?secret={{ZLMediaKit_secret}}",
"host": [
"{{ZLMediaKit_URL}}"
],
"path": [
"index",
"api",
"version"
],
"query": [
{
"key": "secret",
"value": "{{ZLMediaKit_secret}}"
}
]
}
},
"response": []
2020-07-11 23:17:36 +08:00
}
],
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
],
"variable": [
{
"key": "ZLMediaKit_URL",
"value": "zlmediakit.com:8880"
},
{
"key": "ZLMediaKit_secret",
"value": "035c73f7-bb6b-4889-a715-d9eb2d1925cc"
},
{
"key": "defaultVhost",
"value": "__defaultVhost__"
}
2021-06-17 11:03:11 +08:00
]
2020-07-11 23:17:36 +08:00
}