API reference

Compliance

Outbound-calling compliance settings, the do-not-call list, the do-not-disturb list and the verified-numbers restriction.

These endpoints control what the platform checks before it places an outbound call: the workspace's compliance settings, its own do-not-call (suppression) list, an uploaded do-not-disturb list, and the account setting that restricts calls to verified numbers. The compliance guide explains how the checks apply to calls, batches and campaigns.

Reading needs the viewer role. Every change, and the do-not-disturb lookup, needs admin. An API key acts as an admin.

Limitation: No official do-not-disturb registry is integrated. There is no connection to any regulator's registry or scrubbing service. The do-not-disturb check works only against a list the workspace uploads itself (plus an optional list the operator provides), or against a development mock. Keeping an uploaded list current is your responsibility.

Phone number format

Numbers are normalised before they are stored or compared: digits are kept, a leading + is kept, a 10-digit number gets +91, an 11-digit number starting with 0 becomes +91 plus the rest, and a 12-digit number starting with 91 gets a +. Send E.164 (+919876500000) to avoid surprises.

Role errors

Your role (member) can't change compliance settings. It needs admin access; ask an owner or admin of the workspace.
Your role (member) can't change the do-not-call list. It needs admin access; ask an owner or admin of the workspace.
Your role (member) can't change account settings. It needs admin access; ask an owner or admin of the workspace.

Compliance settings

Get compliance settings

GET /compliance/settings

Returns the workspace's outbound-calling settings with defaults filled in, plus the name of the do-not-disturb registry the platform can ask.

Auth: API key or session token. Role: viewer and up.

Request

curl https://api.sevennadi.si/compliance/settings \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"

Response 200 OK

{
  "require_ai_disclosure": false,
  "require_consent": false,
  "max_daily_attempts_per_number": 3,
  "pii_redaction": "mask",
  "timezone": "Asia/Kolkata",
  "dnd_check": "off",
  "dnd_registry": "mock"
}

Update compliance settings

PATCH /compliance/settings

Updates the settings you send. dnd_registry is accepted and ignored, so you can send back what you read.

Auth: API key or session token. Role: admin and up.

Request

curl -X PATCH https://api.sevennadi.si/compliance/settings \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{"require_consent": true, "max_daily_attempts_per_number": 2}'

Response 200 OK

The full settings, as in Get compliance settings.

Errors

Do-not-call list

The suppression list is the workspace's own do-not-call list. A number on it is never dialled by a call, a batch, a campaign or a website callback.

List suppressed numbers

GET /suppression-list

Lists suppressed numbers, newest first.

Auth: API key or session token. Role: viewer and up.

Request

curl "https://api.sevennadi.si/suppression-list?page_size=50" \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"

Response 200 OK

{
  "page_number": 1,
  "page_size": 50,
  "total": 1,
  "has_more": false,
  "data": [
    {"phone_number": "+919876500000", "reason": "asked not to be called", "source": "api", "created_at": "2026-10-13T09:00:00Z"}
  ]
}

source is api or csv for entries added through these endpoints.

Errors

Add suppressed numbers

POST /suppression-list

Adds one number or a list. Numbers already on the list are skipped.

Auth: API key or session token. Role: admin and up.

Request

curl -X POST https://api.sevennadi.si/suppression-list \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{"phone_numbers": ["+919876500000", "+919876500001"], "reason": "asked not to be called"}'

Response 201 Created

{"message": "success", "added": 2, "total_given": 2}

added counts the numbers that were new. If any number is invalid the whole request is refused.

Errors

Upload suppressed numbers

POST /suppression-list/upload

Adds numbers from a CSV file. The file needs a phone_number column (contact_number and mobile_number are accepted too) and may have a reason column. Invalid numbers are reported and skipped; the valid ones are added.

Auth: API key or session token. Role: admin and up.

Request

curl -X POST https://api.sevennadi.si/suppression-list/upload \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef" \
  -F "file=@do-not-call.csv"

Response 201 Created

{"message": "success", "added": 2, "rows": 3, "invalid": ["12345"]}

rows counts the non-empty rows read; invalid lists the values that are not valid numbers.

Errors

Remove a suppressed number

DELETE /suppression-list/{phone_number}

Takes a number off the list.

Auth: API key or session token. Role: admin and up.

Request

curl -X DELETE https://api.sevennadi.si/suppression-list/%2B919876500000 \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"

Response 200 OK

{"message": "success", "phone_number": "+919876500000"}

Errors

Do-not-disturb list

The do-not-disturb check answers registered or clear for a number. It is used before outbound calls when dnd_check is block or warn. The operator chooses the registry:

Get do-not-disturb status

GET /compliance/dnd

Returns which registry the platform checks and how many numbers the workspace has uploaded.

Auth: API key or session token. Role: viewer and up.

Request

curl https://api.sevennadi.si/compliance/dnd \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"

Response 200 OK

{"registry": "mock", "official_registry": false, "uploaded_numbers": 0, "dnd_check": "off"}

official_registry is always false.

Upload a do-not-disturb list

POST /compliance/dnd/upload

Uploads the numbers that are registered do-not-disturb, typically the result of your own scrubbing run. The file is a CSV with a phone_number column (contact_number, mobile_number and number are accepted too), or a plain list with one number per line. The uploaded list is used when the operator's registry is file.

Auth: API key or session token. Role: admin and up.

Request

curl -X POST "https://api.sevennadi.si/compliance/dnd/upload?replace=true" \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef" \
  -F "file=@dnd-registered.csv"

Response 201 Created

{"message": "success", "added": 1200, "rows": 1203, "invalid": 3, "total": 1200}

added counts new numbers, invalid counts values that are not plausible numbers, and total is the size of the list afterwards.

Errors

Clear the do-not-disturb list

DELETE /compliance/dnd

Deletes every number the workspace uploaded.

Auth: API key or session token. Role: admin and up.

Request

curl -X DELETE https://api.sevennadi.si/compliance/dnd \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"

Response 200 OK

{"message": "success", "removed": 1200}

Check numbers against the registry

POST /compliance/dnd/check

Looks up to 1000 numbers in the configured registry. It changes nothing, but because it is a POST under /compliance it needs the admin role.

Auth: API key or session token. Role: admin and up.

Request

curl -X POST https://api.sevennadi.si/compliance/dnd/check \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{"phone_numbers": ["+919876500000", "+919876509999"]}'

Response 200 OK

{
  "registry": "mock",
  "results": {"+919876500000": "clear", "+919876509999": "registered"}
}

The keys of results are the normalised numbers.

Errors

Account settings

Get account settings

GET /user/settings

Returns the account setting that restricts outbound calls to verified numbers.

Auth: API key or session token. Role: viewer and up.

Request

curl https://api.sevennadi.si/user/settings \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef"

Response 200 OK

{"restrict_to_verified_numbers": false}

Update account settings

PATCH /user/settings

Switches the restriction on or off. While it is on, a call to a number that is not verified is refused with 403 and a message that names the numbers to verify.

Auth: API key or session token. Role: admin and up.

Request

curl -X PATCH https://api.sevennadi.si/user/settings \
  -H "Authorization: Bearer vk-0123456789abcdef0123456789abcdef" \
  -H "Content-Type: application/json" \
  -d '{"restrict_to_verified_numbers": true}'

Response 200 OK

{"restrict_to_verified_numbers": true}

Errors