Skip to content

Get Voip Action Token Me

GET
/session/v1/session/{session_id}/player/me/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:kick: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

Authorizations

Parameters

Path Parameters

vivox_action
required

An enumeration.

string
Allowed values: join join_muted kick mute trxn
session_id
required
string
>= 1 characters <= 128 characters

Query Parameters

voip_session_type
required

An enumeration.

string
Allowed values: session team
refresh_ttl
boolean
default: true

Responses

200

Successful Response

object
token
required

Signed auth voip login token for a specific client

string
issuer
required

Issuer for client’s login token

string
server
required

Server for voip login

string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string