回调事件概览

更新时间

了解云端录制的核心能力、适用场景、接入路径和相关参考资源。

开通消息通知服务后,当你指定要接收通知的事件发生时,声网消息通知服务器会以 HTTP 请求形式向你发送回调。回调的具体内容在请求 Body 中以 JSON 对象形式返回,根据事件不同,请求 Body 中 JSON 对象所包含的字段也不一样。

下面以一个示例说明请求 Body 中的字段:

上图中红色框内字段为消息通知服务请求 Body 的公共字段,所有回调中都包含这些字段,公共字段的含义详见消息通知回调格式。其中 eventType 表示云端录制回调事件的类型。

蓝色框内字段为云端录制事件 payload 中的公共字段,所有的云端录制事件的回调中 payload 都包含这些字段。其中 serviceType 表示该事件与云端录制的哪个服务模块有关,details 则包含具体的事件信息。payload 中包含的字段及详细含义见下文。

payload 字段说明

payload 字段是一个 JSON Object,包含事件的具体内容。云端录制每种类型的事件通知中 payload 都会包含以下字段:

  • cname:String 类型,录制的频道名称。
  • uid:String 类型,录制使用的用户 ID。
  • sid:String 类型,录制 ID,一次云端录制的唯一标识。
  • sequence:Number 类型,消息序列号,从 0 开始计数。消息可能乱序到达或者丢失重发,可以通过该参数标识消息。
  • serviceScene:String 类型,当前运行的录制场景或录制阶段:
    • "rtsc/raw-recording":新单流录制(mode=raw)。录制服务、录制模块和上传模块的回调(包括截图事件 45)均使用该值。迁移时需要同步更新回调处理逻辑,按新值识别新单流录制的回调。
    • "rtc_record":实时录制,不包含新单流录制(mode=raw)。
    • "rtc_snapshot":旧版截图。新单流录制(mode=raw)的截图回调使用 "rtsc/raw-recording"。
    • "web_record":页面录制。
  • sendts:Number 类型, 事件发生的时间 (UTC 时间)。Unix 时间戳,精确到毫秒。
  • serviceType:Number 类型,回调事件服务的类型。
    • 0:云端录制服务
    • 1:录制模块
    • 2:上传模块
    • 6:页面录制
  • details:JSON Object,具体的消息内容,详见每个事件的描述。消息通知服务可能会在 details 中新增字段,但为保证兼容,不会改变现有字段的数据格式。

回调事件概览

本节详细介绍云端录制每种回调事件的相关字段。

eventTypeserviceType事件描述
10,表示云端录制服务云端录制服务发生错误
20,表示云端录制服务云端录制服务发生警告
30,表示云端录制服务云端录制服务状态发生变化
40,表示云端录制服务生成录制索引文件
110,表示云端录制服务云端录制服务结束任务并退出
120,表示云端录制服务云端录制启用高可用机制
302,表示上传模块上传服务已启动
312,表示上传模块所有录制文件已上传至指定的第三方云存储
322,表示上传模块录制文件上传到声网备份云;新单流录制的 stranded 上传状态处理见事件详情
332,表示上传模块录制文件上传到第三方云存储的进度;新单流录制(mode=raw)已移除此事件
401,表示录制模块录制服务已启动
411,表示录制模块录制服务已退出
421,表示录制模块同步录制文件信息
431,表示录制模块音频流状态变化
441,表示录制模块视频流状态变化
452,表示上传模块云端截图成功
706,表示页面录制页面录制已启动
716,表示页面录制页面录制已停止
726,表示页面录制待录制页面使用了不受支持的功能,录制即将停止
736,表示页面录制待录制页面重新加载
1006,表示页面录制页面录制 CDN 推流状态变化
表格内容超出当前宽度,可横向滚动查看更多列。

回调事件详情

你可以参考如下文档,按照业务需要查看云端录制各模块的回调事件: