Call control

Plays an audio prompt into the active call identified by id. The audio is audible to the remote party in real time.

post/v1/calls/{id}/play

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/calls/{id}/play
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The uuid of the call.

Request body

audio_filestring required

URL of the audio file to play to the call.

Example request

{
  "audio_file": "https://examples.com/audio.wav"
}

Response

Returns a success confirmation. Audio playback starts.

successboolean required

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes