Skip to main content
POST
Start a call or ask permission to call

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json
to
string
required

E.164 phone number.

Maximum string length: 32
type
enum<string>
default:call_permission_request
Available options:
call_permission_request,
business_initiated
body
string | null
Maximum string length: 1024
phone_number_id
string | null
Maximum string length: 64
connection_uuid
string<uuid> | null
sdp_offer
string

Required for business_initiated. RFC 8866 SDP offer: Opus 48 kHz, ptime 20, one audio SSRC.

Maximum string length: 20000
biz_opaque_callback_data
string | null

Your own tracking data, echoed on call webhooks.

Maximum string length: 512
recording
object

Ask Meta to record or transcribe this call. Both people hear a short notice built from purpose first.

transcription
object

Ask Meta to record or transcribe this call. Both people hear a short notice built from purpose first.

Response

Permission request sent, or call placed and ringing.

kind
enum<string>
required
Available options:
call_permission_request
message
object
required