Sample Request

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

📘 Important!

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

Request Variables (Path Params)

The following parameter is required to update my number:

Variable Name	Description	Data Type
id	Unique ID of the active broadcast.	string

Sample Response

[
  {
    "id": 3176,
    "name": "trunk",
    "description": "trunk",
    "destination": "ivr",
    "destination_id": "7926",
    "list_id": "5748",
    "timeout": 120,
    "cuncurrent_limit": 5,
    "caller_id_number": "+911000000001",
    "time_group": null,
    "start_date_time": "2020-07-29 17:12:00",
    "end_date_time": "2020-07-31 23:59:00",
    "number_of_retry": 1,
    "retry_after_minutes": 5,
    "status": 0,
    "start_count": 0
  }
]

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
name*	Name for the broadcast.	string
description*	Description of the broadcast.	string
destination*	The destination where the call should land. eg: ivr\	id, id: IVR's id
timeout*	Time for which the call tries to connect to each number in the list. Minimum: 40	string
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: 5	string
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