Sample Request

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

📘 Important!

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

Sample Response

[
  {
    "id": 5358,
    "name": "June Payment Collection",
    "description": "June Payment Collection",
    "sensitive_field_map": [],
    "field_map": [
      "Phone Number",
      "Name",
      "Email Id",
      "Address",
      "Company Name",
      "Due Amount",
      "Due Date"
    ],
    "in_process": 0,
    "assigned_to": null,
    "outbound_skill_based_routing": {
      "enabled": false,
      "skill_list": null
    }
  },.....
]

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
id	Unique ID of the broadcast list	Integer
name	Name of the broadcast	String
description	Description Related to broadcast.	String
sensitive_field_map	Number of fields mapped with the list that are sensitive.	String
field_map	Number of fields mapped with the list.	String
in_process	Whether the status of the list is active or inactive. For example: PROCESS_ACTIVE => 1, self:: PROCESS_INACTIVE => 0	Integer
assigned_to	Returns the ID of broadcast on which this list is assigned to.	Integer
outbound_skill_based_routing.enabled	Whether skill list is mapped against the lead list or not.	Boolean.
outbound_skill_based_routing.skill_list	Return the ID and name of the skill list.	String.
count_id	Count of leads associated with the list.	Integer