Sample Request

curl --request GET \
     --url https://api.servetel.in/v1/broadcast/dnd/lists \
     --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 a DND list.

Variable Name	Description	Data Type
limit	Number of records to be fetched. Min: 1 max: 100.	String
sort_dir	Order by which the fetched result will be displayed. For example: ascending or descending order.	String
cursor	Pointer where the cursor should start from.	String
name	Name of the list	String
updated_after	Date at which it was last updated.	String

Sample Response

{
  "hasMore": false,
  "limit": 10,
  "count": 1,
  "data": [
    {
      "id": 259,
      "name": "Test list",
      "description": "test description",
      "created_at": "2023-08-09T12:15:24+0530",
      "updated_at": "2023-08-09T12:15:24+0530",
      "deleted_at": null
    }
  ]
}

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
limit	Number of records to be fetched.	Integer
count	Total number of records in current page.	Integer
data[].id	Id of the list.	String
data[].name	Name of the list.	String
data[].description	Description of the list.	String
data[].created_at	Time stamp when the list was created.	String
data[].updated_at	Time stamp when the list was last updated.	String
data[].deleted_at	Time stamp at which the list was deleted from the records.	String