Safe Voice Client API
Overview
The Safe Voice Client API allows you to perform various game client operations
relating to Safe Voice.
This includes the player consent api, which lets the game client to update the
consent status for a player. The consent status is used to determine if the player's
audio can be recorded and processed for content moderation.
For more information, please refer to our Documentation.
Download OpenAPI specification:
Update the player consent status
Update the player consent status in the Safe Voice for consent tracking
Authorizations
Client
HTTP: Client
HTTP Authorization Scheme: bearer
Code samples for "Update the player consent status":
Request example
curl -X PUT \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "consents": [ { "name": "vivox.safevoice_moderation", "granted": true } ]}' \ "https://vivox.services.api.unity.com/v1/projects/{projectId}/environments/{environmentId}/players/{playerId}/consents"
Response example
{ "consents": [ { "name": "vivox.safevoice_moderation", "granted": true } ]}
Get the player consent status
Get the player consent status in the Safe Voice for consent tracking
Authorizations
Client
HTTP: Client
HTTP Authorization Scheme: bearer
Code samples for "Get the player consent status":
Request example
curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://vivox.services.api.unity.com/v1/projects/{projectId}/environments/{environmentId}/players/{playerId}/consents"
Response example
{ "consents": [ { "name": "vivox.safevoice_moderation", "granted": true } ]}