Callback server

Set up a callback server

1. To set up a callback server, you need to create a server that can receive a POST request from the SSR API. The request will contain a JSON payload with the job's status.
2. SSR makes a request to any URL in the

   callbackUri

   field of the request. If you specify a

   callbackKey

   Vivox includes this in the header of the request under

   Authorization

   .

Callback payload

{    "job_status": "string",    "job_id": "string",    "code": "string",    "metadata": "object"}

• job_status

  will either be

  complete

  ,

  fail

  , or

  partial

  .
  • When a job is

    partial

    , this means that not all of the audio recorded or decoded successfully.

• job_id

  is the ID of the job. It corresponds to

  job_id

  in the response of the original request.

• code

  is the error code if the job failed. Refer to error codes for more information.

• metadata

  is any metadata you passed in the original request. If you did not set any

  metadata

  this field will be omitted from the request.

Error codes

filterUri