文档反馈
文档反馈

实时音视频相关事件

事件类型

event_type 事件含义
1 房间启动
2 房间结束
3 录制文件下载信息抄送
4 用户进入房间
5 用户离开房间
6 用户加入房间失败
8 房间时长消息抄送
9 用户角色变更为观众
10 用户角色变更为主播

1 房间启动(创建房间)

创建房间、音视频通话正式开始时会触发该抄送。

注意:房间启动事件的消息抄送涉及资源计费,若有需要,请联系云信商务经理查看计费策略并协助开通此抄送。

字段说明

字段 类型 示例 说明
eventType Number 1 事件类型
channelId Number 123 房间 ID。
channelName String abc 房间名。
createtime Number 1606974852379 音视频通话开始的时间,可转为 13 位时间戳。
timestamp Number 1606974852479 该事件的发生时间,13 位时间戳,可转为Long值。

JSON 示例

{
  "eventType": 1,
  "data": {
    "channelId": 123,
    "channelName": "abc",
    "creaetime": 1606974852379,
    "timestamp": 1606974852479
  }
}

2 房间结束(销毁房间)

房间结束时、销毁房间时会触发该抄送。

注意:房间结束事件的消息抄送涉及资源计费,若有需要,请联系云信商务经理查看计费策略并协助开通此抄送。

字段说明

字段 类型 示例 说明
eventType Number 2 事件类型
channelId Number 123 房间 ID。
channelName String abc 房间名。
createtime Number 1606974852379 第一个用户加入音视频房间的时间,可转为 13 位时间戳。
timestamp Number 1606974852479 该事件的发生时间,13 位时间戳,可转为 Long 值。

JSON 示例

{
  "eventType": 2,
  "data": {
    "channelId": 123,
    "channelName": "abc",
    "creaetime": 1606974852379,
    "timestamp": 1606974952479
  }
}

3 录制文件下载信息

当录制文件生成完毕,并且上传到点播系统成功后触发本抄送。

字段说明

字段 类型 示例 说明
eventType Number 3 事件类型。
caller Boolean false 是否是此通通话的发起者,若是则为 true,若不是则不返回该字段。
channelId Number 123 房间 ID。
filename String 0-51657353189055-1606974909978-0-mix.mp4 文件名,直接存储,混合录制文件 filename 带有"-mix"标记。
md5 String e66ff965e0f43bd4e3897e84cb245dd0 文件的 MD5 值。
size String 24564438 文件大小,单位为字符。
type String mp4 文件的类型,即文件扩展名。包括:
  • aac:实时音频录制文件。
  • mp4:实时视频录制文件。
  • flv:互动直播视频录制文件。
url String http://***..126.net/**/0-51657353189055-1606974909978-0-mix.mp4 文件的下载地址。
uid Number 0 用户帐号,若该文件为混合录制文件,则该字段为 0。
taskId String abc 推流任务 ID。
mix Boolean true 是否为混合录制文件。
  • true:混合录制文件。
  • false:单人录制文件。
vid String 3333091818 点播文件 ID,通过该参数可以调用点播接口查询相关信息。
pieceIndex String 0 录制文件的切片索引,如果单通通话录制时长超过切片时长,则录制文件会被且被切割成多个文件。
timestamp Number 1606974909978 录制文件生成的系统时间。

JSON 示例

{
  "eventType": 3,
  "data": {
    "vid": "3231091818",
    "pieceIndex": "0",
    "filename": "0-53657353689055-1606974909978-0-mix.mp4",
    "size": "24564438",
    "type": "mp4",
    "mix": true,
    "uid": "0",
    "url": "http://*****.vod.126.net/*****/0-52657353689055-1606974909978-0-mix.mp4",
    "channelId": "52657353689055",
    "md5": "e66ff965e0f43bd4e3897e84cb245dd0",
    "timestamp": "1606974909978"
  }
}

4 用户进入房间

用户进入房间时,触发该消息抄送。

注意:用户进入房间事件的消息抄送涉及资源计费,若有需要,请联系云信商务经理查看计费策略并协助开通此抄送。

字段说明

字段 类型 示例 说明
eventType Number 4 事件类型。
uid Number 123 用户 UID。
user String 123 用户 UID。内容和 uid 字段相同。
channelId Number 123 房间 ID。
channelName String abc 房间名。
timestamp Number 1606974909978 发生该事件的 13 位时间戳。
platform Number - 用户使用的设备类型。
  • 1:Android。
  • 2:iOS。
  • 4:Windows。
  • 8:winphone。
  • 9:macOS。
  • 16:Web。
userRole Number - 用户角色。
  • 0:主播。
  • 1:观众。

JSON 示例

{
  "eventType": 4,
  "data": {
    "uid": 2334,
    "user": "2334",
    "channelId": 123,
    "channelName": "abc",
    "timestamp": 1606974909978,
    "platform": 1,
    "userRole": 0
  }
}

5 用户离开房间

每个用户离开房间时,均触发此抄送。

注意:用户进入房间事件的消息抄送涉及资源计费,若有需要,请联系云信商务经理查看计费策略并协助开通此抄送。

字段说明

字段 类型 示例 说明
eventType Number 5 事件类型。
uid Number 234 用户 UID。
user String 123 用户 UID。内容和 uid 字段相同。
channelId Number 234 房间 ID。
channelName String abc 房间名。
timestamp Number 1606974909978 发生该事件的 13 位时间戳。
platform Number 1 用户使用的设备类型。
  • 1:Android。
  • 2:iOS。
  • 4:Windows。
  • 8:winphone。
  • 9:macOS。
  • 16:Web。
reason Number 0 发生该事件的原因。
  • 0:正常离开。
  • 1:服务器错误。
  • 2:被踢出。
  • 3:超时离开。
duration String 123 用户在房间里的通话时长。
userRole Number - 用户角色。
  • 0:主播。
  • 1:观众。

JSON 示例

{
  "eventType": 5,
  "data": {
    "uid": 1234,
    "user": "1234",
    "channelId": 234,
    "channelName": "abc",
    "timestamp": 1606974909978,
    "platform": 1,
    "reason": 0,
    "duration": "123",
    "userRole": 0
  }
}

6 用户加入房间失败

房间内并发人数达到上限,导致用户加入房间失败,此时会触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 6 事件类型。
uid Number 123 用户 UID。
user String 123 用户 UID。内容和 uid 字段相同。
channelMaxUser Number 1000 房间能承载的最大用户数。
channelName String abc 房间名。
channelId Number 12345 房间 ID。
platform Number 1 用户使用的设备类型。
  • 1:Android。
  • 2:iOS。
  • 4:Windows。
  • 8:winphone。
  • 9:macOS。
  • 16:Web。
timestamp Number 1606974909978 发生该事件的 13 位时间戳。
userRole Number - 用户角色。
  • 0:主播。
  • 1:观众。
reason Number 4 发生该事件的原因。该事件下 reason 为 4,表示房间内并发人数达到上限。

JSON 示例

{
  "eventType": 6,
  "data": {
    "uid": 1234,
    "user": "1234",
    "channelName": "abc",
    "channelId": 234,
    "timestamp": 1606974909978,
    "platform": 1,,
    "userRole": 0
    "reason": 0,
    "channelMaxUser": 200
 }
}

8 房间时长消息抄送

此抄送的触发场景包括:

字段说明

字段 类型 示例 说明
eventType Number 8 事件类型。
channelName String abc 房间名。
channelId Number 123 房间 ID。
live Number 1 该房间是否已推流,即对外直播。
  • 0:该房间未开启直播。
  • 1:该房间已直播推流。
status String SUCCESS 当前房间的状态。
  • SUCCESS:正常挂断。
  • RUNNING:运行中。
type String AUDIO 通话类型,其中:
  • AUDIO:表示音频通话。
  • VIDEO:表示音视频通话。
duration Number 12 所有房间成员在房间里的时长的总和,单位为秒(s)。
createtime Number 1606974909978 音视频通话开始的时间,可转为 13 位时间戳。
members array([]RoomReportDurationMember) 参见下表 RoomReportDurationMember 房间中的人员信息。
running Boolean true 是否为超长时长通话的过程中的抄送。
  • true:超长时长通话的过程中的抄送。
  • false:表示普通时长通话的抄送或者超长时长通话的最后一次抄送。

RoomReportDurationMember

字段 类型 示例 说明
duration Number 12 用户在房间里的通话时长。
uid Number 1234 用户 ID。
userType Number 2 用户类型。2 表示 IM,3 表示独立音视频,4 表示录制SDK。

JSON 示例

{
  "eventType": 8,
  "data": {
    "channelName": "abc",
    "channelId": 123,
    "live": 1,
    "status": "SUCCESS",
    "type": "AUDIO",
    "duration": 12,
    "createtime": 1606974909978,
    "members": [{
        "duration": 12,
        "uid": 1234,
        "userType": 2
    }],
    "running": true
 }
}

9 用户角色变更为观众

用户角色由主播变更为观众时,触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 9 事件类型。
uid Number 123 用户 UID。
channelName String abc 房间名。
channelId Number 12345 房间 ID。
timestamp Number 1606974909978 发生该事件的 13 位时间戳。

JSON 示例

{
  "eventType": 6,
  "data": {
    "uid": 1234,
    "channelName": "abc",
    "channelId": 234,
    "timestamp": 1606974909978
 }
}

9 用户角色变更为主播

用户角色由观众变更为主播时,触发此抄送。

字段说明

字段 类型 示例 说明
eventType Number 9 事件类型。
uid Number 123 用户 UID。
channelName String abc 房间名。
channelId Number 12345 房间 ID。
timestamp Number 1606974909978 发生该事件的 13 位时间戳。

JSON 示例

{
  "eventType": 6,
  "data": {
    "uid": 1234,
    "channelName": "abc",
    "channelId": 234,
    "timestamp": 1606974909978
 }
}
×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。