[BETA] start call

Places a voice or video call. Limited to 10 per minute and 100 per hour per instance; the slot is taken before the media URLs are fetched, so a bad audioUrl or videoUrl still spends one. With waitForAnswer (default true) the response tells whether the callee picked up within answerTimeout; on timeout the instance hangs up. Optional audioUrl/imageUrl/videoUrl play after the call was answered; hangupAfterSeconds ends the call and counts from the moment the call connects, not from this response, so a call can last up to the 10 second connection wait plus hangupAfterSeconds. Over the limit the answer is data.status: error with message: too many calls, an explanation and retryAfter in seconds. Note: This endpoint is currently in beta and may change without notice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID

Body Params
string
required

The number to call, as [email protected] or number@lid

boolean
Defaults to false

Place a video call instead of a voice call

boolean
Defaults to true

Wait for the callee to pick up before answering the request

integer
5000 to 45000
Defaults to 30000

How long to wait for the callee to pick up, in milliseconds (waitForAnswer only). Capped at 45000: the request blocks for that whole time, and a longer wait would outlive the HTTP connection.

uri

wav, mp3 or ogg played once after the call was answered, max 25 MB

uri

Still image shown as the outgoing camera once the call connects; jpeg or png, max 25 MB

uri

mp4 (H.264) looped as the outgoing camera after the call was answered, max 25 MB

integer
5 to 300

Hang up this many seconds after the call connected

Responses

data.status reports whether the action was carried out; on error data carries message and explanation. Payload: the call plus whether it was answered.

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

429

Too many requests — rate limit exceeded

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json