Create Call
POST/api/v1/calls
Place a call with an agent to a phone number, a Telegram target or a meeting link, and return the call id once dialling has started (202).
Requires Idempotency-Key: a retried request with the same key returns the original call instead of dialling again.
Request
Responses
- 202
- 400
- 401
- 402
- 403
- 404
- 409
- 422
- 429
- 502
Successful Response
Idempotency-Key header missing, or the request was rejected before any work started.
X-API-Key missing, invalid or revoked.
The workspace has not enough credit to place the call.
The key has no access to this workspace, or the workspace has the feature disabled.
No such resource in the key's workspace.
The account that would place the call is already in one, or this Idempotency-Key was already used.
Response Headers
Seconds to wait before retrying.
The request body failed validation, or the target cannot be reached on its channel (for example a number that is not on WhatsApp).
Per-key rate limit exceeded.
Response Headers
Seconds to wait before retrying.
The call could not be placed: the dispatcher or the telephony provider failed.