API Reference

FlowBuilder

post
https://api.cm.com/voiceapi/v2/flowbuilder

Initiate an outbound FlowBuilder call.

Recipes
🦉
Create an outbound FlowBuilder call
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🦉
Create an outbound FlowBuilder call
Open Recipe

Voicemail detection

You can also determine the action when voicemail has been detected, by setting the property voicemail-response in your request. The following settings are supported:

ValueDescription
IgnoreDo not attempt to detect voicemail. When this value is given, your callflow will continue to run during the entire voicemail.
RestartRestarts the callflow when voicemail is detected. Default value when voicemail-response is not set in your request.
StopStops the call.
Body Params

Details of the FlowBuilder instruction.

string | null

Optional string that allows you to uniquely identify the placed outbound call. Its value is also included
in the callback and Call Detail Records (CDRs).

string | null

The number to dial. When the number is invalid, the request will be rejected. Must be in valid international
E.164 format.

callees
array of strings | null

List of multiple numbers to dial. When the list contains one or more invalid numbers, the request will be
rejected. Must be in valid international E.164 format.

callees
string
required
length between 1 and 24

The caller ID to display on the recipient's phone. Must be in valid international E.164 format.

boolean

Indicates whether the caller ID should be hidden. Defaults to false.

uri | null

URL that will be called when the call is finished. The body of this POST request will contain details about
the call or calls.

int32 | null
10 to 60

Determines how long the Voice API will wait for the callee to answer the call. Cancels the ringing call
after the timeout period exceeded. Defaults to 60.

string
required
length ≥ 1

This property represents the unique identifier for a FlowBuilder flow. For guidance on locating the callflow
ID of a specific flow, please refer to the FlowBuilder documentation.

flow-variables
object | null

Optional list of flow variables that will be set. For more information on FlowBuilder variables, please see
the FlowBuilder documentation.

string
enum

The type that determines the flow of Voicemail detection.

Allowed:
Responses

401

Unauthorized

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago