Skip to main content
GET
/
api
/
dnc
/
list
curl --location '{{baseUrl}}/api/dnc/list?page=1&limit=10&search=123' \
  --header 'Authorization: Bearer {{authToken}}'

{
  "message": "DNC list fetched successfully",
  "status": true,
  "code": 200,
  "errorMessage": "",
  "data": {
    "dncList": [
      {
        "_id": "64e5f12345abcdef98765432",
        "phoneNumber": "12125551234",
        "type": "customer_request",
        "orgId": "64e5f12345abcdef12345678",
        "batchId": "64e5f12345abcdef87654321",
        "requestUUID": "550e8400-e29b-41d4-a716-446655440000",
        "callRecording": "https://example.com/recording.mp3",
        "transcription": "Customer requested to be removed from calling list",
        "createdAt": "2025-05-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "total": 42,
      "page": 1,
      "limit": 10,
      "totalPages": 5
    }
  }
}

​
Overview

Fetch all phone numbers that have been added to your organization’s Do Not Call list. Results are paginated and can be filtered by search term. The list is automatically scoped to your organization based on your authentication token.

​
Prerequisites

  • Bearer token for authenticated workspace access
  • Organization membership (automatically determined from your user account)

​
Request

​
Authorization
string
required
Bearer token for the authenticated workspace account.
​
page
integer
default:"1"
Page number for pagination. Minimum value is 1.
​
limit
integer
default:"10"
Number of DNC entries to return per page. Default is 10.
​
search
string
Optional search term to filter results. Searches across phone number, type, and requestUUID fields (case-insensitive).
curl --location '{{baseUrl}}/api/dnc/list?page=1&limit=10&search=123' \
  --header 'Authorization: Bearer {{authToken}}'

​
Response

{
  "message": "DNC list fetched successfully",
  "status": true,
  "code": 200,
  "errorMessage": "",
  "data": {
    "dncList": [
      {
        "_id": "64e5f12345abcdef98765432",
        "phoneNumber": "12125551234",
        "type": "customer_request",
        "orgId": "64e5f12345abcdef12345678",
        "batchId": "64e5f12345abcdef87654321",
        "requestUUID": "550e8400-e29b-41d4-a716-446655440000",
        "callRecording": "https://example.com/recording.mp3",
        "transcription": "Customer requested to be removed from calling list",
        "createdAt": "2025-05-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "total": 42,
      "page": 1,
      "limit": 10,
      "totalPages": 5
    }
  }
}
​
dncList
array
required
Array of DNC entries matching the query parameters.
​
dncList[]._id
string
required
Unique identifier for the DNC record.
​
dncList[].phoneNumber
string
required
Phone number in the DNC list (with country code).
​
dncList[].type
string
Optional classification type for the DNC entry.
​
dncList[].orgId
string
required
Organization ID that owns this DNC entry.
​
dncList[].batchId
string
required
Batch ID associated with the call that triggered the DNC entry.
​
dncList[].requestUUID
string
required
UUID of the specific call record from the batch.
​
dncList[].callRecording
string
URL to the call recording (if available).
​
dncList[].transcription
string
Call transcription text (if available).
​
dncList[].createdAt
string
required
ISO 8601 timestamp when the DNC entry was created.
​
pagination
object
required
Pagination metadata for the current query.
​
pagination.total
integer
required
Total number of DNC entries matching the search criteria.
​
pagination.page
integer
required
Current page number.
​
pagination.limit
integer
required
Number of entries per page.
​
pagination.totalPages
integer
required
Total number of pages available.

​
Error Handling

  • 500 Internal Server Error – Server error while fetching the DNC list.
Use the search parameter to quickly find specific phone numbers or filter by type. The search is case-insensitive and matches partial strings.

Authorizations

​
Authorization
string
header
required

Bearer token authentication for workspace access

Query Parameters

​
page
integer
default:1
​
limit
integer
default:10
​
search
string

Response

DNC list fetched successfully