V1 to V2 Migration Guide

Key changes

• TTL is no longer a valid option, you must use history for all requests.
• The API now supports GCP buckets for storage.
• The API has been redesigned to be more restful:
  • Status complete files are now replaced with a callback server.
• SSR now requires the use of service accounts from a Unity Cloud organization.
• Deduplication has been removed as a feature. You will no longer see

  409

  error codes for duplicate requests.
• Auto end has been removed a feature. Requests will always run for the full duration of the history request.
• You no longer need to make a request to decode audio. Vivox will manage the state for you and the final product will be one .WAV file per speaker in the channel.

Authentication changes

1. SSR now requires the use of Unity Authentication for all requests.
   • If you have not created an organization or project, create one. Refer to How to create a project for more information.
2. Once you have your project and organization you need to share the details with your account manager. Your account manager will enable SSR for your organization.
3. Once SSR is enabled you need to create a service account to authenticate with the API. Refer to How to create a service account.
4. On the service account page, assign permissions to the service account. Select Manage organization permissions and assign the

   Server Side Recording Processor Role

   . This enables this service account to access the SSR API.

   

5. To use this service account refer to How to authenticate with a service account.

API Changes

Request changes

1. destination_credentials

   are now contained within

   storageOptions

   . To use AWS in the same way as the V1 API you need to replace a specific code segment.

{  "destination_credentials": {  "bucket": "my-bucket",  "access_key_id": "secret",  "secret_access_key": "secret"  }}

{  "storageOptions": {    "provider": "aws",    "credentials": {      "bucket": "my-bucket",      "accessKeyId": "secret",      "secretAccessKey": "secret"    }  }}

2. Remove the

   target_type

   field. The V2 API only supports channel subscriptions.
3. The

   ttl

   field has been removed. Use the

   history

   field to specify the duration of the recording.

callbackUri

SSR Decoder

Callback server

status_complete

status_decoded