Type alias GetUserContextResponse

GetUserContextResponse: { status: "unauthenticated" | "authenticated" | "authorized"; screenName: string; participantId: string; participantUUID: string; role: string }

Example:

{
 "screenName": "Happy Zoomineer",
 "participantUUID": "xxxxx",
 "role": "host",
 "status": "authorized"
}

Type declaration

  • status: "unauthenticated" | "authenticated" | "authorized"
    status Description
    unauthenticated Not signed in with Zoom.
    authenticated Authenticated with Zoom, but did not add the app.
    authorized The user has added the app and granted the required scope permissions.
  • screenName: string

    The name of the Zoom user as it appears in the meeting

  • participantId: string

    A temporary participant-identifier - changes each time users join meetings or navigate between breakout rooms

    Deprecated

    use participantUUID instead of participantId

  • participantUUID: string

    A meeting-specific participant-identifier - it persists as users navigate between breakout rooms or briefly loses connections

  • role: string

    The role of the Zoom App user in the meeting. Values: 'host', 'coHost', 'attendee', 'panelist' (webinar only)

Settings

Member Visibility

Theme

Generated using TypeDoc