v1

latestOpenAPI 3.0.02026-07-1494623.7 KB

Stream Audio

Play an audio file into a call

put/{uuid}/stream

Request body

levelstring

Set the audio level of the stream in the range -1 >= level <= 1 with a precision of 0.1. The default value is 0.

loopinteger

the number of times to play the file, 0 for infinite

stream_urlstring[] required

Example request

{
  "level": "0.4",
  "stream_url": [
    "https://example.com/waiting.mp3"
  ]
}

Response

messagestring

Description of the action taken

uuidstring uuid

The unique identifier for this call leg. The UUID is created when your call request is accepted by Vonage. You use the UUID in all requests for individual live calls

Example response

{
  "message": "Stream started",
  "uuid": "63f61863-4a51-4f6b-86e1-46edebcf9356"
}