API Reference
Help Center

Connect a call

post
https://api.ycloud.com/v2/whatsapp/calls/connect

Initiates a WhatsApp call connection.

Establishes the initial connection for a WhatsApp call by providing SDP offer information. This endpoint is used for business-initiated calling scenarios.

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

Provide exactly one of to or recipient. If both are provided, to takes precedence and recipient is ignored.

string
required

The caller's phone number in E.164 format.

string

The callee's phone number in E.164 format. Required when recipient is not provided.

string

The callee's WhatsApp Business-scoped user ID (BSUID) or parent BSUID. Required when to is not provided.

string
enum
required

The SDP type, must be "offer" for connection requests.

Allowed:
string
required

The Session Description Protocol (SDP) offer information compliant with RFC 8866. Contains media session parameters for establishing the WebRTC connection.

Responses

Updated about 2 months ago

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

Updated about 2 months ago