[BETA] accept call

Accepts the ringing incoming call. Media starts after the call connected; audioUrl plays once, imageUrl is shown, videoUrl loops as the camera. hangupAfterSeconds, if given, ends the call that many seconds after it connects. Every media URL is fetched before the call is accepted, so an unusable URL fails the request instead of answering a call that then plays nothing. Errors come back as data.status: error with message and explanation. 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

The call to act on. Omit to use the instance's only active call.

boolean
Defaults to false

Accept as a video call and send a camera track

uri

wav, mp3 or ogg played once into the call, max 25 MB

uri

jpeg or png shown as the outgoing camera, max 25 MB

uri

mp4 (H.264) looped as the outgoing camera, max 25 MB

integer
5 to 300

Hang up at the latest this many seconds after the call connects; omitted means the call stays up until someone ends it

Responses

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

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