call

[BETA] play call audio

Plays wav/mp3/ogg (max 25 MB) into the connected call; resolves after playback. The call has to be connected — one that is still ringing has no media channel and answers data.status: error with message: failed to play call audio and an explanation. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/play-call-audio

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/play-call-audio
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

callIdstring

The call to act on. Omit to use the instance's only active call.

audioUrlstring uri required

wav, mp3 or ogg played into the call, max 25 MB

Example request

{
  "callId": "00E61C7AAD3559F3AFC223D4E3FC1914",
  "audioUrl": "https://example.com/greeting.mp3"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: how long the clip played.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "durationSeconds": 12.5
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.