Documentation

Support

Vivox Safe Text

Vivox Safe Text

Player evidence report API

Use the Player evidence report API to retrieve conversations a player participated in.
Read time 1 minuteLast updated 2 days ago

The player evidence report API returns a list of conversations in which a user participated, along with optional time filters. The following is an example of a player evidence request:
curl https://services.api.unity.com/vivox/text-evidence-management/v1/organizations/<organization_id>/projects/<project_id>/player-evidence-report?user_uri=sip:your-issuer.john.@yourvivoxdomainname.vivox.com -u service-acct-username:service-account-password
The
user_uri
is required and maps to the sip URI of the user in question.
The player evidence report API accepts the following optional query parameters:

Parameter

Description

start_ts
A Unix timestamp to filter for conversations where the user’s last activity was on and after this timestamp.
end_ts
A Unix timestamp to filter for conversations where the user’s last activity was before and including this timestamp.
num_conversations
The number of conversations to return in the response.
request_start_ts
Use this parameter for pagination requests after the first page. The value is returned in the response payload. The player’s most recent activity orders the conversations in the response, and the next value in the response represents the player’s most recent activity in the next conversation to retrieve. The
request_start_ts
parameter keeps pages accurate if the user is actively chatting.