消息通知服务支持的事件有：

• 音频流相关：

  • 音频流开始推送: UserAudioStreamStart
  • 音频流结束推送: UserAudioStreamStop

• 视频流相关：

  • 视频流开始推送：UserVideoStreamStart
  • 视频流结束推送: UserVideoStreamStop

• 屏幕音频流相关：

  • 屏幕音频流开始推送: UserScreenAudioStreamStart
  • 屏幕音频流结束推送: UserScreenAudioStreamStop

• 屏幕视频流相关：

  • 屏幕视频流开始推送: UserScreenVideoStreamStart
  • 屏幕视频流结束推送: UserScreenVideoStreamStop

• 录制相关：

  • 录制任务开始：RecordStarted
  • 录制任务结束：RecordStopped(2020-12-01)
  • 录制任务结束：RecordStopped(2022-06-01)
  • 录制任务结束：RecordStopped(2023-06-01)
  • 上传任务启动：RecordUploadStarted
  • 上传进度：RecordUploadProcessing
  • 已完成上传至存储：RecordUploadDone
  • 上传失败转存备份：RecordUploadBackuped
  • 录制音频流状态变化：RecordAudioStreamStateChanged
  • 录制视频流状态变化：RecordVideoStreamStateChanged

• 房间相关：

  • 可见用户进房：UserJoinRoom
  • 可见用户退房：UserLeaveRoom
  • 不可见用户进房：InvisibleUserJoinRoom
  • 不可见用户退房：InvisibleUserLeaveRoom
  • 用户身份切换（不可见 -> 可见）：RoleChangeInvisible2Visible
  • 用户身份切换（可见 -> 不可见）：RoleChangeVisible2Invisible
  • 房间创建：RoomCreate
  • 房间销毁：RoomDestroy

• 音频切片相关：

  • 切片结果：SegmentRealTimeData(2020-12-01)
  • 切片结果：SegmentRealTimeData(2022-06-01)

• 抽帧截图相关：

  • 截图结果：SnapshotRealTimeData(2020-12-01)
  • 截图结果：SnapshotRealTimeData(2022-06-01)

• 在线媒体流相关：

  • 在线媒体流任务状态变化：RelayStreamStateChanged

• 云录屏相关：

  • 云录屏任务状态变化：Webcast

• 转推直播相关：

  • 转推直播任务开始：TranscodeStarted
  • 转推直播任务结束：TranscodeStopped
  • 转推直播任务更新：TranscodeUpdated
  • 转推直播任务状态变化：TranscodeStateChanged

• 公共流相关：

  • 公共流任务状态变化：PushPublicStream

• 歌曲查询相关

  • 曲库下架歌曲列表：MusicRemoved

UserAudioStreamStart

音频流开始推送。

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}
json

UserAudioStreamStop

音频流结束推送。

Reason

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}
json

UserVideoStreamStart

视频流开始推送。

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}
json

UserVideoStreamStop

视频流结束推送。

Reason

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}
json

UserScreenAudioStreamStart

屏幕音频流开始推送。

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}
json

UserScreenAudioStreamStop

屏幕音频流结束推送。

Reason

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}
json

UserScreenVideoStreamStart

屏幕视频流开始推送。

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}
json

UserScreenVideoStreamStop

屏幕视频流结束推送。

注：在 Electron 1.4.0 版本中结束屏幕视频流推送时，不会触发此回调。

Reason

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}
json

RecordStarted

录制任务开始。

不同版本录制功能在任务开始时均触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务开始时，你都会收到录制任务开始的消息通知。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": ""
}
json

RecordStopped

录制任务结束。

2020-12-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}
json

RecordStopped

录制任务结束。
2023-06-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "ObjectKey": "TestObjectKey",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}
json

RecordStopped

录制任务结束。

2023-06-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "ObjectKey": "TestObjectKey",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}
json

RecordUploadStarted

上传任务启动。

不同版本录制功能在上传任务启动时均触发此回调。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": ""
}
json

RecordUploadProcessing

上传任务进度。

上传进程持续一分钟及以上，才会有此回调。每隔一分钟上传一次。

不同版本录制功能在上传任务进度发生变化时均触发此回调。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": "",
    "Progress" : 100
}
json

RecordUploadDone

录制文件已上传至存储平台。

不同版本录制功能在录制文件已上传至存储平台时均触发此回调。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": ""
}
json

RecordUploadBackuped

录制文件上传失败转存备份

不同版本录制功能在录制文件上传失败转存备份时均触发此回调。

备份使用的 TOS Bucket 需要开启版本控制，防止文件名重复导致文件被覆盖。

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": ""
}
json

RecordAudioStreamStateChanged

录制音频流状态变化

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "UserId": "Your_UserId,
    "StreamType": 0,
    "State": 0,  
    "Timestamp": "1611736812853"     
}
json

RecordVideoStreamStateChanged

录制视频流状态变化

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "UserId": "Your_UserId,
    "StreamType": 0,
    "State": 0,  
    "Timestamp": "1611736812853"     
}
json

UserJoinRoom

可见用户进入房间。

相同 UserId 用户重复进房时，每一次进房都会触发该回调，建议进行去重操作。

注：关于可见用户和不可见用户，参看 setUserVisibility。

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Timestamp": "1611736812853",
    "UserExtraInfo":"Your_UserExtraInfo"
}
json

UserLeaveRoom

可见用户退出房间。

相同 UserId 用户反复登录造成被踢，被踢掉用户不会触发此回调。只有在最后一次退房时会触发该回调。

Reason:

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Reason": "userLeave",
    "Timestamp": "1611736812853",
    "UserExtraInfo":"Your_UserExtraInfo"
}
json

InvisibleUserJoinRoom

不可见用户进入房间。

相同 UserId 用户重复进房时，每一次进房都会触发该回调，建议进行去重操作。

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}
json

InvisibleUserLeaveRoom

不可见用户退出房间。

相同 UserId 用户反复登录造成被踢，被踢掉用户不会触发此回调。只有在最后一次退房时会触发该回调。

Reason:

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Reason": "userLeave",
    "Timestamp": "1611736812853"
}
json

RoleChangeInvisible2Visible

可见用户调用 setUserVisibility ，不可见 -> 可见。

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "Timestamp": "1611736812853"
}
json

RoleChangeVisible2Invisible

可见用户调用 setUserVisibility ，可见 -> 不可见。

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "Timestamp": "1611736812853"
}
json

RoomCreate

RTC 房间创建。

{
    "RoomId": "6992870232038591758",
    "Timestamp": "1611736812853"
}
json

RoomDestroy

RTC 房间销毁，房间中所有可见用户全部离开房间。

{
    "RoomId": "6992870232038591758",
    "Timestamp": "1611736812853"
}
json

SegmentRealTimeData

指定音频流切片结果。

AudioData

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TosBucket": "Your_TosBucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "SampleRate": "44100",
            "BitsPerSample": "16",
            "Channels": "2",
            "Size": 256044,
            "TimeStamp": 1647317680214,
            "Duration": 8000
        }
    ], 
    "Identifier": "Your_Identifier" }
json

SegmentRealTimeData

指定音频流切片结果。

AudioData

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Bucket": "Your_Bucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "SampleRate": "44100",
            "BitsPerSample": "16",
            "Channels": "2",
            "Size": 256044,
            "TimeStamp": 1647317680214,
            "Duration": 8000
        }
    ], 
    "Identifier": "Your_Identifier" 
    }
json

SnapshotRealTimeData

指定视频流截图结果。

ImageData

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TosBucket": "Your_TosBucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "Format": 0,
            "Width": 640,
            "Height": 360,
            "Size": 28802,
            "TimeStamp": 1647316896085
        }
    ]
}
json

SnapshotRealTimeData

指定视频流截图结果。

ImageData

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Bucket": "Your_Bucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "Format": 0,
            "Width": 640,
            "Height": 360,
            "Size": 28802,
            "TimeStamp": 1647316896085
        }
    ]
}
json

RelayStreamStateChanged

输入在线媒体流状态发生变化。

   {
        "AppId": "Your_AppId",
        "EventId": "Your_eventId",
        "EventTime": "2021-08-17T19:22:02+08:00",
        "EventType": "RelayStreamStateChanged",
        "EventData": {
                "RoomId": "Your_RoomId",
                "TaskId": "Your_TaskId",  
                "UserId": "Your_UserId",    
                "StreamUrl": "rtmp://xxx",        
                "Status": 1,
                "StartTimeStamp": 0,       
                "Msg": "",
                "Vid": "xxxxvvv"，
                "Reason": 4
        },
}
json

Webcast

云录屏任务状态发生变化

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Status": 1
}
json

TranscodeStarted

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 发起的转推直播任务开始。

不同版本转推直播功能在转推直播任务开始时均触发此回调。

{
 	"AppId": "Your_AppID",  
    "RoomId": "Your_RoomID",
    "TaskId": "Your_TaskID",
    "Timestamp": 1661150097044,
    "PushURL": "rtmp://xxxx",    
    "Code": 0,
    "ErrorMessage": ""
}
json

TranscodeStopped

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 终止了转推直播任务。
不同版本转推直播功能在转推直播任务结束时均触发此回调。

{
 	"AppId":"Your_AppID",
    "RoomId":"Your_RoomID",
    "TaskId":"Your_TaskID",
    "Timestamp":1661150097044,
    "PushURL": "rtmp://xxxx",    
    "Code":0,
    "ErrorMessage":""
}
json

TranscodeUpdated

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 更新了合流转推任务。

不同版本转推直播功能在转推直播任务更新时均触发此回调。

{
    "AppId": "Your_AppID",
    "RoomId": "Your_RoomID", 
    "TaskId": "Your_TaskID",  
    "Timestamp": 1661150055041,   
    "PushURL": "rtmp://xxxx", 
    "Code": 0,
    "ErrorMessage": ""
}
json

TranscodeStateChanged

转推直播任务状态变化通知。

不同版本转推直播功能在转推直播任务状态变化时均触发此回调。

状态变化包括用户主动调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 更新了合流转推任务参数。也包括任务执行过程中出现的状态流转。

{
    "AppId": "Your_AppID",
    "RoomId": "Your_RoomID", 
    "TaskId": "Your_TaskID",  
    "Timestamp": 1661150097044, 
    "StartTime": 1661150054990,
    "FinishTime": 0,   
    "PushURL": "rtmp://xxxx", 
    "TaskState": 3,    
    "Code": 0,
    "ErrorMessage": ""
}
json

PushPublicStream

公共流推送异常或推送结束

{
    "AppId":"Your_AppID", 
    "BusinessId":"Your_BusinessId",    
    "PublicStreamId":"Your_PublicStreamId", 
    "Timestamp":1661150097044, 
    "Status":2, 
    "Msg":"call api stop",     
    "Code":2
}
json

MusicRemoved

曲库下架歌曲列表

SongList

{
    "AppId": "Your_AppId",
    "Timestamp": 1611736812853,
    "SongUpdate": [
        {
            "SongId": "Your_SongId",
            "VendorId": 2,
            "UpdateAt": 1611736812853
        }
    ]
}
json