Evidence report API
Use the Evidence report API to retrieve select messages from a channel or direct message conversation.
Read time 2 minutesLast updated 8 months 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 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 and a where both values are user URIs. The order of the and the does not matter because direct message requests return the entire conversation between two users.
target_uritarget_urisender_uritarget_urisender_uriThe 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. |
Note
A request with a specified number of messages returns a field containing the Unix timestamp pointing to the next message in the results if there are more messages to return.
nextRegardless of the number of messages that exist; at most 500 messages () 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.
message_idsTo retrieve the next page of the message results, use the value provided in the results as the parameter in your next query. A value of null indicates that there are no more messages to return.
nextstart_tsnext