Skip to main content
Send a checkpoint event via WebSocket when the desired audio events are queued. Plivo will respond with playedStream, indicating that audio events buffered before the Checkpoint were successfully played out to the end user. playedStream will only be emitted if the preceding events were played successfully.

​
Attributes

event

Indicates the event type. checkpoint is the value expected.

 
name

Name of the checkpoint that you use to recognize upon receiving the acknowledgment.

streamId

A unique identifier generated for each audio stream.

Request
{
  "event": "checkpoint",
  "streamId": "20170ada-f610-433b-8758-c02a2aab3662",
  "name": "customer greeting audio"
}
Response
{
  "event": "playedStream",
  "streamId": "20170ada-f610-433b-8758-c02a2aab3662",
  "name": "customer greeting audio"
}