TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no
The /api/call/* module covers placing voice calls and creating shareable call links from the instance. There are currently five operations: the fake call, which makes the phone ring for a few seconds and hangs up on its own (no audio); the audio call, which rings and plays a file once the recipient answers; create call link, which generates a shareable link (audio or video) that anyone can open to join; preview call link, which looks up a link’s metadata without joining the call; and schedule call, which creates a link and sends an event card with that link, title, and start time. Every route validates instance ownership and accepts TokenAccount or TokenInstance.
Available endpoints
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".
Standard response (200)
Both routes return an envelope with thecallId assigned by WhatsApp:
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
Error envelope:
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.
Create Call Link
Creates a shareable call link (audio or video) that anyone can open.
Preview Call Link
Looks up a call link’s metadata without joining the call.
Schedule Call
Creates a link and sends an event card with the link, title, and start time.