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

Get list of all Broadcasts

Details of all the Broadcasts can be retrieved using the below method

curl --request GET \
  --url https://api.servetel.in/v1/broadcasts \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Response Variables

NameDescriptionData-type
idUnique ID of the BroadcastInteger
nameName for the BroadcastString
descriptionDescription for the broadcastString
cuncurrent_limitNumber of channels to use for broadcastInteger
statusCurrent status of the broadcast
0: Inactive, 1: Active, 2: Paused
Integer
timeoutTime for which the call tries to connect to each number in the list. Minimum: 10, Maximum: 60Integer
list_nameName of the lists in broadcastString
l_idUnique ID of the list associated with broadcastInteger

Get a Broadcast's details

To get details of a broadcast we can use the below method

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

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the BroadcastString

Creating a Broadcast

Broadcast can be created using the below method

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 NameDescriptionData 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: 60Integer
concurrent_limit*Number of channels to use for broadcastInteger
retry_after_minutes*Time after which failed numbers are tried again.Integer
caller_id_number*Caller ID that is shown to the clientInteger
number_of_retry*Maximum number of retry attempts allowed. Minimum: 0, Maximum: 5Integer
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_groupUnique ID of the Time group to be associated with broadcast.Integer

Response Variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString

Update Broadcast

Details of a particular broadcast can be updated using the the below method

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

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the Broadcast that needs to be updatedString

Request Variables

Variable NameDescriptionData type
name*Name of the BroadcastStrring
description*Description for the broadcast.String
phone_number_list*Unique List ID of phone numbers 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: 60Integer
concurrent_limit*Number of channels to use for broadcastInteger
retry_after_minutes*Time after which failed numbers are tried again.Integer
caller_id_number*Caller ID that is shown to the clientInteger
number_of_retry*Maximum number of retry attempts allowed. Minimum: 0, Maximum: 5Integer
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_groupUnique ID of the Time group to be associated with broadcast.Integer

Response Variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString

Delete Broadcast

Broadcast can be deleted using the below method

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

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the broadcast to be deletedString

Response Variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString

Start Broadcast

To start broadcast below method can be used

curl --request GET \
  --url https://api.servetel.in/v1/broadcast/start/id \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the broadcast that needs to be activatedString

Response variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString

Pause Broadcast

To pause broadcast below method can be used

curl --request GET \
  --url https://api.servetel.in/v1/broadcast/pause/id \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the active broadcastString

Response Variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString

Resume Broadcast

To resume broadcast below method can be used

curl --request GET \
  --url https://api.servetel.in/v1/broadcast/resume/id \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the paused broadcastString

Response Variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString

Stop Broadcast

To stop broadcast below method can be used

curl --request GET \
  --url https://api.servetel.in/v1/broadcast/end/id \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Path Parameters

Variable NameDescriptionData type
id*Unique ID of the BroadcastString

Response variables

Variable NameDescriptionData type
successRequest success statusBoolean
messageMessage corresponding success statusString