API reference
Take a number off the do-not-call list
DELETE /v1/do-not-call/{number}
Its agents may ring it again from the next dial. Recorded in the audit log under the key: taking a number off is undoing somebody's request not to be called. Needs do_not_call:write and a live key.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
number |
path | string | Yes |
Answer
200 with DoNotCallRemoved.
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 test key, or a key limited to some projects or agents: the list decides which real people are called. |
404 |
The number is not listed. |
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
#!/bin/sh
# Take a number off the do-not-call list. With a live key. Recorded in the audit log under it.
curl -sS --fail-with-body -X DELETE "https://api.aigently.ai/v1/do-not-call/+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.