Skip to main content

Get Voip Action Token

GET 
/session/v1/session/:session_id/player/:player_uuid/voip/vivox::vivox_action

Generate a token for one of the specific vivox actions except logging in

JOIN Required Permissions:

  • For the player themselves : session:vivox:join

JOIN_MUTED Required Permissions:

  • For the player themselves : session:vivox:join_muted

KICK Required Permissions:

  • For any player (including themselves) any of: session:*, session:vivox:kick:all

  • For the player themselves : session:vivox:kick:self

or be leader of session and have Required Permissions:

  • For any player (including themselves) : session:vivox:kick:as-leader

MUTE Required Permissions:

  • For any player (including themselves) any of: session:*, session:vivox:mute:all

  • For the player themselves : session:vivox:mute:self

or be leader of session and have Required Permissions:

  • For any player (including themselves) : session:vivox:mute:as-leader

TRANSCRIBE Required Permissions:

  • For any player (including themselves) any of: session:*, session:vivox:transcribe:any

  • For the player themselves : session:vivox:transcribe:as-member

Request​

Path Parameters

    player_uuid uuidrequired
    vivox_action VivoxSessionActionSinglerequired

    Possible values: [join, join_muted, kick, mute, trxn]

    session_id Session Idrequired

    Possible values: non-empty and <= 128 characters

Query Parameters

    voip_session_type VoipSessionTyperequired

    Possible values: [session, team]

    refresh_ttl Refresh Ttl

    Default value: true

Responses​

Successful Response

Schema

    token Token (string)required

    Signed auth voip login token for a specific client

    issuer Issuer (string)required

    Issuer for client's login token

    server Server (string)required

    Server for voip login

    channel_name Channel Name (string)

    Channel name for the generated token if relevant

Loading...