/v1/broadcast

Add a broadcast

Servetel offers a broadcast feature which works on lists that consist of leads.
Lead: Client's number and other related details
List: Collection of leads

Creating a Broadcast

Broadcast can be created using the below method

cURL

curl --request POST \
  --url https://api.servetel.in/v1/broadcast \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere' \
  --header 'content-type: application/json'

Request Variables

Variable Name	Description	Data type
name*	Name of the broadcast.	String
description*	Description for the broadcast.	String
phone_number_list*	Unique List ID of Leads to be used for broadcast.	Integer
destination*	The destination where the call should land. Format: ivr||ID, auto_attend||ID	String
timeout*	Time for which the call tries to connect to each number in the list. Minimum: 10, Maximum: 60	Integer
concurrent_limit*	Number of channels to use for broadcast	Integer
retry_after_minutes*	Time after which failed numbers are tried again.	Integer
caller_id_number*	Caller ID that is shown to the client	Integer
number_of_retry*	Maximum number of retry attempts allowed. Minimum: 0, Maximum: 5	Integer
start_date_time*	Date and time in which leads associated with broadcast are called. Format: Y-m-d H:i:s	Date-Time
end_date_time*	Date and time till which leads associated with broadcast are called. Format: Y-m-d H:i:s	Date-Time
time_group	Unique ID of the Time group to be associated with broadcast.	Integer

Response Variables

Variable Name	Description	Data type
success	Request success status	Boolean
message	Message corresponding success status	String