Skip to main content
POST
Start voice call

Authorizations

token
string
header
required

Body

application/json
number
string
required

Contact number in international format (e.g., 5511999999999)

Example:

"5511999999999"

call_duration
integer

Maximum call duration in seconds. Use 0 or omit it to not limit the audio by time.

Required range: x >= 0
Example:

15

fileUrl
string

MP3, WAV, or OGG/Opus audio via HTTP(S) URL, data URI, or base64, up to 25 MB. Playback starts when the call is answered.

Example:

"https://exemplo.com/audio.mp3"

Response

Call started successfully

response
string

Confirmation message

Example:

"Call request accepted locally, awaiting WhatsApp confirmation"

confirmed
boolean

Indicates whether the call was already confirmed by WhatsApp in the initial response

Example:

false

call
object

Metadata of the created call

audio
object

Present when fileUrl was provided