Skip to main content
Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no The /api/call/* module covers placing voice calls from the instance. There are currently two operations: the fake call, which makes the phone ring for a few seconds and hangs up on its own (no audio), and the audio call, which rings and plays a file once the recipient answers. Every route validates instance ownership and accepts TokenAccount or TokenInstance.

​
Available endpoints

MethodPathType
POST/api/call/fake/:instanceFake Call
POST/api/call/audio/:instanceAudio Call

​
Common structure

​
Recipient (number)

Both endpoints take the destination in the number field, which accepts:
  • Plain number: "5511999999999" (preferred).
  • Private JID: "5511999999999@s.whatsapp.net".
Calls are always 1:1 — there is no group call via the API.

​
Standard response (200)

Both routes return an envelope with the callId assigned by WhatsApp: 
{
  "success": true,
  "message": "Audio call placed",
  "callId":  "3EB08FCF27E532F1D3D3",
  "number":  "5511999999999"
}
The fake call also includes a duration field (seconds it rang).
The callId identifies the call on WhatsApp. The fake call is ended automatically by the server after duration seconds; the audio call only plays the file if the recipient answers.

​
Common errors

HTTPMessage
400Instance name is required
400Invalid request body: <detail>
400Number is required
400Duration must be between 1 and 60 seconds (fake)
400Provide exactly one of mediaUrl or mediaBase64 (audio)
404instance not found
500<failure reason>
Error envelope: 
{
  "success": false,
  "error": { "message": "Number is required" }
}

​
Next steps

Fake Call

Makes the phone ring for a few seconds and hangs up on its own.

Audio Call

Rings and plays an audio (URL or base64) when answered.