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

Name

Description

Data-type

id

Unique ID of the Broadcast

Integer

name

Name for the Broadcast

String

description

Description for the broadcast

String

cuncurrent_limit

Number of channels to use for broadcast

Integer

status

Current status of the broadcast
0: Inactive, 1: Active, 2: Paused

Integer

timeout

Time for which the call tries to connect to each number in the list. Minimum: 10, Maximum: 60

Integer

list_name

Name of the lists in broadcast

String

l_id

Unique ID of the list associated with broadcast

Integer

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 Name

Description

Data type

id*

Unique ID of the Broadcast

String

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 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

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 Name

Description

Data type

id*

Unique ID of the Broadcast that needs to be updated

String

Request Variables

Variable Name

Description

Data type

name*

Name of the Broadcast

Strring

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: 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

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 Name

Description

Data type

id*

Unique ID of the broadcast to be deleted

String

Response Variables

Variable Name

Description

Data type

success

Request success status

Boolean

message

Message corresponding success status

String

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 Name

Description

Data type

id*

Unique ID of the broadcast that needs to be activated

String

Response variables

Variable Name

Description

Data type

success

Request success status

Boolean

message

Message corresponding success status

String

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 Name

Description

Data type

id*

Unique ID of the active broadcast

String

Response Variables

Variable Name

Description

Data type

success

Request success status

Boolean

message

Message corresponding success status

String

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 Name

Description

Data type

id*

Unique ID of the paused broadcast

String

Response Variables

Variable Name

Description

Data type

success

Request success status

Boolean

message

Message corresponding success status

String

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 Name

Description

Data type

id*

Unique ID of the Broadcast

String

Response variables

Variable Name

Description

Data type

success

Request success status

Boolean

message

Message corresponding success status

String