# On_roleEventOccured

Description

Notification after one of the conference participants changes the role (take the podium, leave the podium, etc)

During a role-based conference

EventHandler<string> On_roleEventOccured

Response example

{
    "event": "roleEventOccured",
    "peerId": "user2@some.server",
    "peerDn": "user2",
    "role": 3,
    "type": 0,
    "result": 1,
    "broadcast": true,
    "confId": "00000351@some.server#vcs",
    "method": "event"
}

Response Parameters

Name Description
confId Unique communication session identifier
peerId TrueConf ID, unique user identifier
peerDn User display name
role Participant's role:
• 0 - Without changes
• 1 - General
• 2 - The conference owner
• 3 - The user who requested the podium
• 4 - The user who was invited to the podium
• 5 - The user who is currently making an audio reply
type Role change type
• 0 - Request
• 1 - Response
• 2 - Confirmation
• 3 - Notification
result Response to a role change request:
• 0 - Positive response
• 1 - General response
• 2 - The role is already taken
• 3 - Declined by the participant
• 4 - The participant did not reply
• 5 - The participant has not joined
broadcast Flag showing whether a user is on the podium

See also

Last Updated: 09/12/2025