Documentation

Support

Vivox Safe Text

Vivox Safe Text

Evidence report API

Use the Evidence report API to retrieve select messages from a channel or direct message conversation.
Read time 1 minuteLast updated 2 days ago
Use the evidence report API to retrieve select messages from the server. The following is an example of how a request to text evidence management is formatted: 
curl "https://services.api.unity.com/vivox/text-evidence-management/v1/organizations/:yourOrgID/projects/:yourProjectID/text-evidence-report?target_uri=add-your-vivox-channel-uri" -u service-acct-username:service-account-password
The 
target_uri
parameter is required. It maps to a Vivox channel ID or a user ID for a direct message request. A direct message request must have a 
target_uri
and a 
sender_uri
where both values are user URIs. The order of the 
target_uri
and the 
sender_uri
does not matter because direct message requests return the entire conversation between two users. The request accepts the following optional query parameters:

Parameter

Description

sender_uri
A Vivox user URI, use it to filter the response by message sender. Note that this value is required for direct message requests.
target_uri
The URI of the message receiving entity (channel or user).
start_ts
All messages reported at this time stamp and after this time stamp in Unix time format.
end_ts
All messages reported before and including this time stamp in Unix time format.
as_file
True or false value to return the response as a file.
file_type
If as_file is true, specify the file type. The default is CSV.
num_messages
The number of messages to return. The maximum value of 500 messages is returned per request query if this number is not provided.
Regardless of the number of messages that exist; at most 500 messages (message_ids) are returned per query. If more than 500 messages are wanted, you can continue to send new queries for subsequent message results until no more results exist. To retrieve the next page of the message results, use the 
next
value provided in the results as the 
start_ts
parameter in your next query. A 
next
value of null indicates that there are no more messages to return.