List the do-not-call list

GET /v1/do-not-call

Every number your organization's agents will never ring, newest first. number asks whether one number is listed. Needs do_not_call:read.

Parameters

Name	In	Type	Required	Description
`number`	query	string or null	No	Only this number, if it is listed.
`limit`	query	integer	No	How many to return, 1 to 100.
`cursor`	query	string or null	No	`next_cursor` from the previous page, with the same filters.

Answer

200 with DoNotCallList.

Errors

Every error is a problem document with a stable code.

Status	When
`401`	The key is missing, mistyped, unknown, revoked or expired.
`403`	A key limited to some projects or agents.
`422`	Validation Error
`429`	Too many requests for this key or its organization; see `Retry-After`.
`500`	Something went wrong on our side. Quote the `request_id` to support.

Examples

Ask whether a number may be called

#!/bin/sh
# Ask whether a number may be called. An empty list means it is not on it.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/do-not-call?number=+12025550188" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.