通知 API 简介
优质
小牛编辑
134浏览
2023-12-01
简介
为了及时将重要信息告知用户,无论是通过API还是目睹控制台,我们提供了主动推送消息的服务。
使用通知服务前需要先设置通知URL,设置方法详见设置通知URL。
主动推送消息的API有:
1、创建频道
2、修改频道信息
3、修改观看页信息
4、删除频道
5、视频转码通知
6、直播文档
在目睹控制台操作,主动推送消息的有:
1、创建频道
2、修改频道信息
3、关闭频道
4、打开频道
5、删除频道
- 推流状态改变
主动推送消息内容示例
假设设置的通知URL是http://www.foo.com/
,那么每次调用上述API时候,会通过POST方式向该地址主动发送json Data, 发送内容如下所示。
返回结构解释
功能 | namespace | action | source | status | id |
---|---|---|---|---|---|
API创建频道 | activity | create | api | - | 频道ID |
API修改频道信息 | activity | update_name | api | - | 频道ID |
API修改观看页信息 | activity | update_page | api | - | 频道ID |
API删除频道 | activity | delete | api | - | 频道ID |
API新增视频,转码成功后 | video | transcode | - | - | 视频ID |
API上传文档 | doc | create | api | 1:成功;0:失败 | 文档ID |
目睹控制台创建频道 | activity | create | console | - | 频道ID |
目睹控制台修改观看页信息 | activity | update_page | console | - | 频道ID |
目睹控制台关闭频道 | activity | close | console | - | 频道ID |
目睹控制台打开频道 | activity | open | console | - | 频道ID |
目睹控制台删除频道 | activity | delete | console | - | 频道ID |
频道推流状态改变 | activity | stream | system | 1:开始推流;0:推流结束 | 频道ID |
示例
{
"namespace": 对应功能namespace,
"action": 对应功能action,
"source": 对应功能source,
"id": 对应功能的id信息
}