Download OpenAPI specification:Download
A callout is a call made to a phone number or app using the API.
Callout RequestMakes a call out to a phone number. The types of callouts currently supported are conference callouts, text-to-speech callouts, and custom callouts. The custom callout is the most flexible, but text-to-speech and conference callouts are more convenient.
Security Basic or Application
Request Body schema: application/json methodrequired
string
Sets the type of callout.
Enum: "conferenceCallout" "ttsCallout" "customCallout" conferenceCalloutobject (conferenceCalloutRequest)
The conference callout calls a phone number or a user. When the call is answered, it's connected to a conference room.
ttsCalloutobject (ttsCalloutRequest)
The text-to-speech callout calls a phone number and plays a synthesized text messages or pre-recorded sound files.
customCalloutobject (customCalloutRequest)
The custom callout, the server initiates a call from the servers that can be controlled by specifying how the call should progress at each call event.
200 A success response, or an Error .
Response Schema: application/json
callIdstring
The returned call identifier.
Payload Node.js C# Java Python curl Make a phone call Play a prompt with SSML Play a prompt with an external file Add a participant to a conference Make a custom callout Make a custom callout that enables AMD Make a phone call Place a phone call and use text to speech to convey a message.
Copy
Expand all Collapse all