get https://api.servetel.in/v2/broadcasts
This API allows you to fetch list of broadcasts.
This API helps you access the entire list of existing broadcasts and their corresponding data. From the fetched broadcast list, you get privy to the number of calls made using a particular campaign, the time the call tries to connect to each number in the list, the agents acting for the broadcast, and more.
Sample Request
You can retrieve the list of all broadcasts using the below method:
curl --request GET \
--url https://api-cloudphone.tatateleservices.com/v2/broadcasts \
--header 'accept: application/json' \
--header 'authorization: Bearer yourtokenhere'
Response Variables
After the execution of the API, you will get the following response variables:
| Name | Description | Data-type |
|---|---|---|
| limit | number of records to be fetched. Min: 1 max: 100. | Integer |
| size | number of records fetched. | Integer |
| page | page number of which broadcasts need to be fetched. | Integer |
| Result[].broadcast_limit | max number of broadcast concurrent limits allowed for the account | Integer |
| Result[].id | The unique ID of the broadcast. For example, 9. | String |
| Result[].name | The name of the broadcast. For example, Campaign 1. | String |
| Result[].description | The description of the broadcast. For example, Campaign 1 description. | String |
| Result[].concurrent limit | The number of channels to be used for broadcast. For example,15. | Integer |
| Result[].status | The current status of the broadcast. For example, The possible values are 0: Inactive, 1: Active, 2: Paused. | Integer |
| Result[].timeout | The time the call tries to connect to each number in the list. For example, Minimum: 10, Maximum: 60. | Integer |
| Result[].list_name | The name of the lists in the broadcast. For example, Campaign list. | String |
| Result[].l_id | The unique ID of the list associated with the broadcast. For example, 70006. | String |
| Result[].outbound_type | The type of outbound campaign. For example, outbound campaigns. | String |
| Result[].calls_count | The number of calls made using a particular campaign. For example, 0. | Integer |
| Result[].ab_testing | The status of a/b testing using the campaign. For example, 0. | Integer |
| Result[].active_agents | The agents active for the broadcast. For example, 45464. | String |
{
"page": 1,
"size": 10,
"limit": 10,
"broadcast_limit": 4500,
"results": [{
"id": "1",
"name": "Test Broadcast 1",
"description": "Test Broadcast 1",
"destination_type": "ivr",
"destination_id": "12",
"list_id": "1",
"list_name": "Test List 1",
"timeout": 30,
"concurrent_limit": 1,
"caller_id": null,
"time_group_id": null,
"time_group_name": null,
"start_date_time": 1662376980,
"end_date_time": 1664562540,
"retry": 0,
"retry_after": null,
"sms_notification": null,
"status": 0,
"start_count": 1,
"created_at": 1662380712,
"dialstatus": ["New", "Message Played", "DTMF Pressed", "No Answer"]
}]
}