实时音视频回调

更新时间:
复制 MD 格式

实时音视频提供频道与用户的回调事件 、旁路与混流回调事件,本文为您介绍如何通过控制台配置对应的回调事件。

回调介绍

通过回调事件,您的业务服务器将可以实时接收实时音视频中频道、用户、旁路混流相关的状态变化:

  • 频道回调:频道被创建、频道被解散等事件。

  • 用户回调:用户入会、离会、角色切换、推流、拉流等事件。

  • 旁路与混流回调:旁路转推事件。

更多频道与用户回调相关内容请参见创建订阅房间消息回调,更多旁路与混流回调相关内容请参见创建混流转推事件订阅。

创建回调任务

频道与用户回调

  1. 登录视频直播控制台。

  2. 在左侧导航栏单击直播+ > 实时音视频 > 应用管理。

  3. 找到需要创建回调任务的应用,单击管理,进入应用管理页面。

  4. 选择左侧导航栏事件回调>频道与用户回调,单击创建任务。

  5. 设置回调参数。参数详细说明如下:

    参数

    说明

    回调地址

    用于接收回调信息的业务服务器地址,支持HTTP和HTTPS协议。建议优先使用HTTPS协议。

    回调事件范围

    回调事件包含用户事件和频道事件。

    • 用户事件含有以下事件:

      • 入会

      • 开始推屏幕共享流

      • 离开

      • 结束推视频流

      • 角色切换

      • 结束推音频流

      • 开始推视频流

      • 结束推屏幕共享流

      • 开始推音频流

    • 频道事件含有以下事件:

      • 频道开始

      • 频道结束

    指定频道

    非必选,当不指定频道时,默认所有频道的相关事件均会产生回调。当您指定频道时,则仅该频道的相关事件会产生回调事件。

    指定用户

    非必选,仅针对用户事件生效,若您指定了用户ID,则必须同时指定频道ID,可以允许输入最多20个用户ID,多个ID使用英文逗号隔开。

  6. 单击确定,完成创建。

旁路与混流回调

  1. 登录视频直播控制台。

  2. 在左侧导航栏单击直播+ > 实时音视频 > 应用管理。

  3. 找到需要创建回调任务的应用,单击管理,进入应用管理页面。

  4. 选择左侧导航栏事件回调>旁路与混流回调,单击配置。

  5. 设置回调参数。参数详细说明如下:

    参数

    说明

    回调地址

    用于接收回调信息的业务服务器地址,支持HTTP和HTTPS协议。建议优先使用HTTPS协议。

    频道范围

    非必选,指定仅接收部分频道(ChannelID)的回调,最多同时指定20个。多个ID用英文逗号“,”隔开;每个频道ID由大小写字母、数字、下划线、短划线(-)组成,最大64字符。如果不填,默认接受全部频道的回调。

编辑和删除回调记录

频道与用户回调

创建完频道与用户回调任务后,您可以继续对该任务进行更新,或将该任务删除。

  1. 进入频道与用户回调页面,找到需要更新(或删除)的任务。

  2. 单击操作列编辑(或删除)对任务进行修改(或删除)。

旁路与混流回调

创建完旁路与混流回调配置后,您可以继续对配置任务进行修改,或将该任务删除。

旁路与混流回调任务配置完成后,状态显示为已配置,可通过修改配置、删除、回调示例操作管理回调任务。页面同时展示已配置的回调地址和频道范围(如全部频道)等信息。

查看回调记录

当您创建完回调任务并生效后,若有回调事件发生,您可以在回调记录中查询该回调的详细信息。

回调记录保留最近 7 天的回调成功或失败数据,支持按时间范围(今天、近 3 天、近 7 天、自定义)和回调 ID筛选。记录包含以下字段:

  • 回调 ID

  • 回调时间

  • 回调内容

  • 回调地址

  • 请求结果

单击回调记录页签,可按时间范围(今天、近 3 天、近 7 天或自定义)筛选记录,查看回调时间、回调内容、回调地址和请求结果。