Vivox Moderation API
Overview
The Vivox Moderation API allows users to moderate Vivox Voice and Text channels in real-time.
For more information about Vivox Voice and Text Services, refer to our documentation.
Request access to these APIs from a Vivox technical account manager or by submitting a request to Vivox Support.
Download OpenAPI specification:
Kick a user from all channels
Provide a Vivox user uri to kick the game user from all Vivox channels.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "user_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/server-kick"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}
Kick a user from a channel
Kick a user from a single channel by providing the channel URI and the user URI.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "user_uri": "string", "chan_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/kick"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}
Kick all users from a channel
Kick all users from a channel by providing the channel URI.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "chan_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/kick-all"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}
Mute a user in a channel
Mute a user in a channel by providing the channel URI and the user URI.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "user_uri": "string", "chan_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/mute"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}
Unmute a user in a channel
Unmute a user in a channel by providing the channel URI and the user URI.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "user_uri": "string", "chan_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/unmute"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}
Mute all users in a channel
Mute all users in a channel by providing the channel URI.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "chan_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/mute-all"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}
Unmute all users in a channel
Unmute all users in a channel by providing the channel URI.
Authorizations
ServiceAccount (Vivox Moderator)
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic
Required scopes: Vivox Moderator
Code samples for "{title}":
Request example
curl -X POST \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "chan_uri": "string"}' \ "https://services.api.unity.com/vivox/v1/organizations/{organizationId}/projects/{projectId}/unmute-all"
Response example
{ "title": "Bad Request", "detail": "Invalid target URI", "status": 400, "details": [ "string", "string" ]}