Download OpenAPI specification:Download

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.

SecurityBasic or Signed

Request

Request Body schema: application/json

method	string conferenceCallout
	object (conferenceCallout) The conference callout calls a phone number or a user. When the call is answered, it's connected to a conference room.

Responses

200

A success response, or an Error.

Response Schema: application/json

callId

string

The returned call identifier.

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": {"type": "number",
"endpoint": "+14045005000"
},
"locale": "en-US",
"text": "Hello, this is a call from Sinch."
}
}

Response samples

application/json

{"callId": "adf92089-df2a-4f14-a377-1e975f588fe4"
}

Security Privacy Legal & Compliance Cookie Statement