Callouts

A callout is a call made to a phone number or app using the API.

Callout Request

Makes 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.

Request
Security:
Basic
Request Body schema: application/json
method
required
string

Sets the type of callout.

Enum: "conferenceCallout" "ttsCallout" "customCallout"
object (conferenceCalloutRequest)

The conference callout calls a phone number or a user. When the call is answered, it's connected to a conference room.

object (ttsCalloutRequest)

The text-to-speech callout calls a phone number and plays a synthesized text messages or pre-recorded sound files.

object (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.

Responses
200OK
Response Schema: application/json
callid
string

The returned call identifier.

400Invalid request
402Not enough credit
post/calling/v1/callouts/
Request samples
application/json

Place a phone call and use text to speech to convey a message.

{
  • "method": "ttsCallout",
  • "ttsCallout": {
    • "cli": "+14045001000",
    • "destination": {
      },
    • "locale": "en-US",
    • "text": "Hello, this is a call from Sinch."
    }
}
Response samples
application/json
{
  • "callid": "adf92089-df2a-4f14-a377-1e975f588fe4"
}