Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Subscribe API query parameters

Reference the query parameters for the server-side recording subscribe API.
Read time 1 minuteLast updated 2 days ago

The server-side recording /ssr/subscribe API uses the following query parameters. auth_token
  • Required for all /subscribe requests.
  • Generated from /api/viv_signin.php.
  • For more information, refer to the Access Token Developer Guide.
destination_credentials
  • Required for all /subscribe requests.
  • Generated from Amazon S3.
  • Requires write access.
  • Uses the following format:
    {"bucket":"name-of-bucket","access\_key\_id":"aws-access-id","secret\_access\_key":"aws-secret-key"}
target_uri
  • Required for all /subscribe requests.
  • The SIP URI of the channel or speaker you want to record.
target_type
  • Required for all /subscribe requests.
  • If you pass a SIP URI for a channel, set target_type to channel.
  • If you pass a SIP URI for a speaker, set target_type to speaker.
filter_uris
  • A comma-separated list of optional URIs that is used to filter the subscription.
  • For a channel subscription, this is a list of user URIs in the channel that you want to capture audio for.
  • For a user subscription, this is a list of channels the user is in that you want to capture audio for.
history
  • The amount of time to collect in minutes from when you subscribe to n number of minutes into the past.
  • The default setting is 5 minutes.
  • Example: If you make a request at 15:00 and ask for 5 minutes of history, then you get data from all users who spoke from 14:56 to 15:00.
ttl
  • The amount of time to collect in minutes from when you subscribe to n number of minutes into the future (the time to live).
  • The default setting is 5 minutes.
  • Example: If you make a request at 15:00 and set a ttl of 30 minutes, then you get data from all users who spoke from 15:00 to 15:29.