Do-Not-Call

Check numbers against the Do-Not-Call list

POST /v1/dnc/check

Scope

dnc:check

Tier

Tier 1

Data

Personal data

Idempotency

Idempotency-Key: not used (this request changes nothing, so a retry is always safe)

Limit

Up to 100 numbers per request

Read-only; nothing is written, so a retry is always safe and no Idempotency-Key is needed. The answer is only listed or not listed: never who added a number, when, or why. At most 100 numbers, in E.164 form.

Parameters

Request body

The numbers.

JSON: DncCheckRequest

Response

200: One result per input number, in input order.

Examples

Request example

curl

curl -sS -X POST \
  "https://app.dialerbee.com/api/v1/dnc/check" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "phones": [
    "+12125550101",
    "+12125550102"
  ]
}'

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

result = db.dnc.check(phones=["+12125550101", "+12125550102"])

Response example

200

{
  "data": [
    {
      "phone": "+12125550101",
      "listed": false
    },
    {
      "phone": "+12125550102",
      "listed": true
    }
  ]
}

Error examples

400 batch_too_large

{
  "type": "https://docs.dialerbee.com/errors/batch-too-large",
  "title": "Batch too large",
  "status": 400,
  "detail": "Too many items in one request.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "batch_too_large",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

403 insufficient_scope

{
  "type": "https://docs.dialerbee.com/errors/insufficient-scope",
  "title": "Not permitted",
  "status": 403,
  "detail": "The API client does not hold the scope this operation requires.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "insufficient_scope",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

400 validation_failed

{
  "type": "https://docs.dialerbee.com/errors/validation-failed",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request is not valid.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "validation_failed",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "errors": [
    {
      "pointer": "/leads/1/phone",
      "code": "missing"
    }
  ]
}

Errors

Objects

DncCheckRequest

DncCheckResult

DncCheckItem