成员事件订阅

成员事件订阅,主要涉及成员相关的事件通知,通过订阅事件,您可以实现接收主持人在线状态更新通知/主持人变更通知 等功能。

1. 主持人在线状态更新通知 (HostStatusUpdate)

事件说明

1)事件解释:当用户收到该事件时,代表完成了主持人在线状态的更新

2)引入版本: 3.8.10

3)所属模块(method):Event/Members

4)事件名(sub_event):HostStatusUpdate

5)触发条件: Rooms完成了主持人在线状态的更新,会收到这个事件通知

事件参数

参数名称

参数类型

参数描述

host_status

int

主持人状态,只在等候室中返回:
0:主持人不在会中
1:主持人在会中

示例

{
    "jsonrpc":"2.0",
    "method":"Event/Members",
    "result":{
        "error_code":0,
        "message":"成功",
        "data":{
            "host_status":1
        }
    },
    "sub_event": "HostStatusUpdate"
}

2. 主持人变更通知 (HostChanged)

事件说明

1)事件解释:当用户收到该事件时,代表完成了主持人角色变更

2)引入版本: 3.8.10

3)所属模块(method):Event/Members

4)事件名(sub_event):HostChanged

5)触发条件: 用户通过Rooms或CSAPI进行主持人角色变更,都会收到这个事件通知

事件参数

参数名称

参数类型

参数描述

old_host_nickname

string

上一位主持人的名称

old_host_user_id

string

上一位主持人user id

user_id

string

新主持人user id

new_host_nickname

string

新主持人名称

reason

int

主持人变更原因:
0:主持人转移
1:系统自动分配(主持人离会
2:主动收回主持人
3:被动收回主持人

示例

{
    "jsonrpc":"2.0",
    "method":"Event/Members",
    "result":{
        "error_code":0,
        "message":"",
        "data":{
            "old_host_nickname":"",
            "old_host_user_id":"144115261167318138",
            "user_id":"144115235076610937",
            "new_host_nickname":"",
            "reason":0
        }
    },
    "sub_event": "HostChanged"
}

3. 用户信息更新通知 (UpdateUserInfo)

事件说明

1)事件解释:当用户收到该事件时,代表会中某个用户的信息状态发生了改变

2)引入版本: 3.19.230

3)所属模块(method):Event/Members

4)事件名(sub_event):UpdateUserInfo

5)触发条件: 当用户发生入会、离会、举手、共享等动作时,会触发这个事件的通知

事件参数

参数名称

参数类型

参数描述

user_list_info

array

用户信息,详见用户信息列表

用户信息列表(user_list_info)

参数名称

参数类型

参数描述

user_id

string

会中用户id

nickname

string

用户名称

audio_on

bool

是否开启音频:
true:开启
false:关闭

video_on

bool

是否开启视频:
true:开启
false:关闭

is_screen_share

bool

是否在共享屏幕:
true:开启
false:关闭

is_raise_hand

bool

是否举手:
true:是
false:否

is_speaking

bool

是否正在发言:
true:是
false:否

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Members",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "user_list_info": [{
                "user_id": "xxx",
                "nickname": "xxx",
                "audio_on": false,
                "video_on": false,
                "is_screen_share": false,
                "is_raise_hand": false,
                "is_speaking": false
            }]
        }
    },
    "sub_event": "UpdateUserInfo"
}

下载 成员事件订阅.pdf
文章内容是否对您有帮助?
有帮助
无帮助