直播服务
优质
小牛编辑
133浏览
2023-12-01
刷新频道下所有画面的推流地址【控制台】
基本信息
Path： /live/api/refresh_publish
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道Hash ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 |
单个画面文档打点【控制台】
基本信息
Path： /live/api/add_webvtt_info
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| time_stamp | number | 非必须 | |||
| type | number | 非必须 | |||
| data | string | 非必须 | |||
| view_page | number | 非必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 |
禁止/允许频道下所有画面的直播【控制台】
基本信息
Path： /live/api/forbidden_or_allow_live
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| actid | string | 必须 | 频道Hash ID | ||
| allow | boolean | 非必须 | true为开启，false为关闭 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 |
获取单个画面历史监控数据【控制台】
基本信息
Path： /live/api/list_streaming_records
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道Hash ID | |
| start | 是 | 直播开始时间，时间戳 | |
| end | 是 | 直播结束时间，时间戳 | |
| view_page | 否 | 画面ID，默认为当前默认画面 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| result | object | 非必须 | 查询结果 | ||
| ├─ count | number | 非必须 | 总数 | ||
| ├─ data | object [] | 非必须 | 监控数据列表 | item 类型: object | |
| ├─ empty | number | 必须 | 取空的次数 | ||
| ├─ sum | number | 必须 | 取帧的次数 | ||
| ├─ fps | number | 必须 | 视频帧率 | ||
| ├─ kbpsv | number | 必须 | 视频比特率 | ||
| ├─ kbpsa | number | 必须 | 音频比特率 | ||
| ├─ time | string | 必须 | 记录时间 |
获取单个画面历史直播日志【控制台】
基本信息
Path： /live/api/get_live_records
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道HashID | |
| view_page | 否 | 画面ID，默认为当前默认画面 | |
| page | 否 | 页码，默认为第一页 | |
| size | 否 | 页面大小，默认为15条/页 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| result | object | 非必须 | 查询结果 | ||
| ├─ total_num | number | 非必须 | 总数 | ||
| ├─ total_page | number | 非必须 | 总页码 | ||
| ├─ page_num | number | 非必须 | 当前页码 | ||
| ├─ page_size | number | 非必须 | 页面大小 | ||
| ├─ results | object [] | 非必须 | 日志数组 | item 类型: object | |
| ├─ start_at | string | 非必须 | 直播开始时间 | ||
| ├─ start_at_timestamp | number | 非必须 | 直播开始时间，时间戳 | ||
| ├─ end_at | string | 非必须 | 直播结束时间 | ||
| ├─ end_at_timestamp | number | 非必须 | 直播结束时间，时间戳 |
获取单个画面实时监控数据【控制台】
基本信息
Path： /live/api/get_monitor_data
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道HashID | |
| view_page | 否 | 画面ID，默认为当前默认画面 | |
| after | 否 | 监控数据的开始时间点，默认为十分钟前 | |
| before | 否 | 监控数据的结束时间点，默认为当前时间 | |
| page | 否 | 页码，默认为1 | |
| size | 否 | 页面大小，默认为15 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| result | object | 非必须 | 查询结果 | ||
| ├─ count | number | 非必须 | 查询总数 | ||
| ├─ data | object [] | 非必须 | 监控数据列表 | item 类型: object | |
| ├─ empty | number | 非必须 | 取空的次数 | ||
| ├─ sum | number | 非必须 | 取帧的次数 | ||
| ├─ fps | number | 非必须 | 视频帧率 | ||
| ├─ kbpsv | number | 非必须 | 视频比特率 | ||
| ├─ kbpsa | number | 非必须 | 音频比特率 | ||
| ├─ time | string | 非必须 | 记录时间 |
获取单个画面的ECDN【控制台】
基本信息
Path： /live/api/get_ecdn
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道Hash ID | |
| view_page | 是 | 画面ID， |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| distributions | object [] | 非必须 | 频道分发区域列表 | item 类型: object | |
| ├─ id | string | 非必须 | 分发 ID | ||
| ├─ status | number | 非必须 | 状态(0-关闭，1-开启，2-申请中，3-未申请) | ||
| ├─ region | string | 非必须 | 海外节点名称英文简写（如 SG JP 等） | ||
| ├─ region_name | string | 非必须 | 海外节点名称中文描述 | ||
| ├─ region_name_englishu | string | 非必须 | 海外节点名称英文描述 | ||
| ├─ server_ip | string | 非必须 | 企业内网地址 | ||
| ├─ cdn_type | string | 非必须 | 该海外节点所使用的 CDN | ||
| ├─ cdn_push_domain | string | 非必须 | 该海外节点的推流域名 | ||
| ├─ cdn_play_domain | string | 非必须 | 该海外节点的播放域名 | ||
| ├─ push_url | string | 非必须 | 该海外节点的推流地址 |
获取单个画面直播信息【控制台】
基本信息
Path： /live/api/admin_info
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道HashID | |
| view_page | 否 | 画面ID，默认为当前默认画面 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| result | object | 非必须 | 查询结果 | ||
| ├─ live | boolean | 非必须 | 是否正在直播 | ||
| ├─ publish | string | 非必须 | 推流地址 | ||
| ├─ live_type | number | 非必须 | 直播类型 | ||
| ├─ apply_ecdn | boolean | 非必须 | 是否启用ecdn | ||
| ├─ is_open | boolean | 非必须 | 是否允许直播 |
获取单个画面直播信息【观看页】
基本信息
Path： /live/api/info
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道Hash ID | |
| view_page | 否 | 画面ID，默认为当前默认画面 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| result | object | 非必须 | |||
| ├─ live | boolean | 非必须 | 是否正在直播 | ||
| ├─ live_type | number | 非必须 | 直播类型 |
获取单个画面直播地址【观看页】
基本信息
Path： /live/api/address
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| actid | 是 | 频道Hash ID | |
| view_page | 否 | 画面ID，默认为当前默认画面 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| abroad | boolean | 必须 | 是否为海外IP | ||
| result | object | 非必须 | |||
| ├─ mobile | object [] | 非必须 | 手机端播放地址 | item 类型: object | |
| ├─ protocol | string | 非必须 | 协议 | ||
| ├─ region | string | 非必须 | 地区 | ||
| ├─ resolution | string | 非必须 | 分辨率 | ||
| ├─ address | string | 非必须 | 播放地址 | ||
| ├─ pc | object [] | 非必须 | PC端播放地址 | item 类型: object | |
| ├─ protocol | string | 必须 | 协议 | ||
| ├─ region | string | 必须 | 地区 | ||
| ├─ resolution | string | 必须 | 分辨率 | ||
| ├─ address | string | 必须 | 播放地址 |