Sample Request

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

📘 Important!

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

Request Variables (Query Params)

The following parameter is required to Fetch List of Leads in DND List.

Variable Name	Description	Data Type
limit	Number of records to be fetched. Min: 1 max: 100.	String
last_seen_id	Reference ID of last user in the page.	String
list_id	ID of the list to be fetched.	String
id	Unique ID of the Account DND list.	String

Sample Response

{
  "hasMore": false,
  "count": 1,
  "limit": 10,
  "data": [
    {
      "id": "64d336a9706560031227a2b2",
      "list_id": 259,
      "added_by": 10959,
      "number": "9876543210",
      "type": "number",
      "created_at": "2023-08-09T12:18:09+0530"
    }
  ]
}

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
hasMore	It defines whether there exist more records or not. For example: true or false.	Boolean
count	Total number of records in current page.	Integer
limit	Number of records to be fetched.	Integer
data[].id	Id of the lead.	String
data[].list_id	ID of the list fetched.	String
data[].added_by	Client ID of who added this lead to the list.	String
data[].number	Number of the lead.	String
data[].type	Type of data for eg: number or lead_id.	String
data[].created_at	Time stamp when the list was created.	String