Skip to content
Sinch Voice API: Choosing between v1 and v2

For all new projects, please use Voice API v2. This is especially important for projects involving:

  • AI capabilities like Streams and Voice Relay
  • Voice campaigns like Batch calling

You should only use the older Voice API v1 if one of the following is a strict requirement:

  • The project must be in General Availability (GA).
  • The project requires In-App voice or Conferencing (until these features are available in v2).

PlaybackEvent

Payload Schema

  • command (string, required) Identifies the type of playback event. Enum: textPlaybackStart, textPlaybackStop, textPlaybackCancel

  • batchSequence (integer, required) Auto-incrementing sequence number that identifies the TTS batch this event relates to.

The sequence starts at 0 for the first batch sent after the session is accepted and increments by 1 for each subsequent batch. Use this value to correlate playback events with the textResponse messages sent from the server.