Skip to main content
POST
Call and Play

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required

Tenant ID to place the call for

to
string
required

Destination phone number (10-digit US format)

Pattern: ^[1-9]\d{9}$
from
string
required

Caller ID phone number (must belong to tenant)

Pattern: ^[1-9]\d{9}$
text
string
required

Text to convert to speech and play on the call

Minimum string length: 3
webhookUrl
string<uri>

Optional webhook URL for call status updates

Response

Call initiated successfully

status
string
required

Request status

message
string
required

Status message