v1

latestOpenAPI 3.1.02026-07-241360148.9 KB

Create a Broadcast

This API allows you to create a Broadcast.

post/v1/broadcast

Authorizationstring required

namestring required

The name of the broadcast. For example, Campaign 1.

descriptionstring required

The description of the broadcast. For example, Details of campaign 1.

phone_number_liststring required

Unique ID of list of phone numbers to be used for broadcast.

destinationstring required

The destination where the call should land. eg: ivr||ID.

timeoutstring required

Time for which the call tries to connect to each number in the list. Minimum: 40

concurrent_limitstring required

Number of channels to be used for broadcast.

retry_after_minutesinteger[] required

Time after which failed numbers are tried again.

caller_id_numberstring

Caller ID that is showed to the called party.

number_of_retrystring

Maximum number of retry attempts allowed. Minimum: 0, Maximum: 5

start_date_timestring required

The date and time in which leads associated with broadcast are called. The format is: yyyy-mm-dd hh:mm:ss (For example: 2019-12-02 00:00:00).

end_date_timestring required

The date and time in which leads are associated with broadcast are called. The format is: yyyy-mm-dd hh:mm:ss (For example: 2019-12-02 00:02:00).

time_groupstring required

Unique ID of the time_group to be associated with broadcast.

dialstatusinteger[] required

[1, 2, 3, 4, 5]

retry_dialstatusinteger[] required

[1, 3]

200

object required