Create a Broadcast

This API allows you to create a Broadcast.

Sample Request

curl --request POST \
     --url \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Body Params)

The following parameter is required to create a broadcast:

Variable NameDescriptionData Type
name*Name for the broadcast.string
description*Description of the broadcast.string
phone_number_list*Unique ID of list of phone numbers to be used for broadcast.integer
destination*The destination where the call should land. eg: ivr|id, id: IVR's idstring
timeout*Time for which the call tries to connect to each number in the list. Minimum: 40string
concurrent_limit*Number of channels to be used for broadcast.string
retry_after_minutes*Time after which failed numbers are tried again.string
caller_id_number*Caller ID that is showed to the called party.string
number_of _retry*Maximum number of retry attempts allowed. Minimum: 0, Maximum: 5string
start_date_time*Date and time in which leads associated with broadcast are called.string
end_date_time*Date and time till which leads associated with broadcast are called.string
time_group*Unique ID of the time_group to be associated with broadcast.string

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
SuccessThe request success status, the possible values are: True (default) for success. False for failure.Boolean
MessageThe message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.String
Click Try It! to start a request and see the response here!