Documentation

Support

Vivox Safe Text

Vivox Safe Text

Text evidence management

Retrieve text messages from a player's chat history using server-to-server APIs to review reported conversations and behavior.
Read time 1 minuteLast updated 2 days ago
Text evidence management is an optional feature that helps moderators evaluate player reports with conversational evidence. To enable this feature, contact Unity Support or your Vivox representative. With this server-to-server API, you can request text messages from player chat history to review instances of reported behavior. All versions are stored for review if a message was edited, deleted, or redacted by the Chat filter. The text evidence management feature contains a 
text-evidence-report
endpoint and a 
player-evidence-report
endpoint. The 
text-evidence-report
endpoint returns a report for a given channel or direct message. The 
player-evidence-report
endpoint returns a list of conversations a player participated in with optional time filters. When active, Text Evidence Management has a storage limit of 30 days, extending the storage limit of Chat History. The API leverages Unity Dashboard service accounts for authentication. After enablement, follow the admin authentication instructions (Unity Services Web API Docs) to create a service account and add the Text Evidence Management role.

Topic

Description

Evidence report APISummary of the Evidence report API and its parameters.
Evidence report HTTP requestAn example of a report request.
Evidence report HTTP response examplesAn example of a report response.
Player evidence report APISummary of the Player evidence report API and its parameters.
Player evidence report HTTP requestAn example of a report request.
Player evidence report HTTP responseAn example of a report response.