Calls
Fake Call
Rings the recipient’s phone for a few seconds then hangs up automatically (no audio)
POST
Fake Call
Auth:
Error envelope:
TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no
Description
Starts a voice call that rings the recipient’s phone for a few seconds and hangs up on its own, no audio, no media connection. Useful to grab attention, validate a number, or for “ring-and-drop” flows. Theduration field controls how many seconds the call rings before the automatic hang-up: default 8 seconds, allowed range 1 to 60.
Examples
Simple fake call
Uses the default duration (8 seconds).Ring for a specific duration
duration: 15 makes the call ring for 15 seconds before hanging up.
Success response
200 OK
The call is ended automatically by the server after
duration seconds. There is no audio stream on this call.Path parameters
Instance name (e.g.,
$Instance_Name).Headers
TokenAccount or TokenInstance.application/jsonRequest body
Destination: phone (
5511999999999) or JID (@s.whatsapp.net).Seconds the call rings before hanging up automatically. Allowed range: 1 to 60. Omitted or
0 uses the default 8.Errors
| HTTP | Message |
|---|---|
| 400 | Instance name is required |
| 400 | Invalid request body: <detail> |
| 400 | Number is required |
| 400 | Duration must be between 1 and 60 seconds |
| 404 | instance not found |
| 500 | <failure reason> |