Place an outbound call with a text-to-speech / IVR flow

post

https://api.commpeak.com/portal/calls

place an outbound call that speaks text to the callee, plays hosted audio, and can collect keypad input and branch on it

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

An outbound call and the script to run once the callee answers.

flow steps execute in order unless a gather branches to a step id. Text is
synthesized to speech upstream, so no audio files need to be hosted, though a
playback step can play one that is.

recipient_phone

string

required

Number to call, E.164 (no leading "+").

sender

string

required

Caller ID presented to the callee, E.164 (no leading "+"). Must be a verified caller ID of the account unless all caller IDs are allowed for it (see GET /portal/allowed_caller_ids).

voice

Default voice model id for every say step (see GET /portal/calls/voices). Defaults to en_US-amy-medium upstream.

flow

array of objects

required

Steps to execute once the callee answers, in order. A gather carrying on_digit jumps to the step with that id instead of continuing.

Flow*

status_callback_url

URL notified when the call finishes. See docs/voice-call-backend.md for the payload.

Responses

201Successful Response

422Validation Error