Enables the insertion of Leads into a Campaign-specific or Global Do Not Call (DNC) List.
Endpoint:
POST https://api.convoso.com/v1/dnc/insert
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | authorization token |
| phone_number | string | Yes | The phone number to add to the DNC List (digits only, no formatting) |
| phone_code | string | Yes | The phone code / country code of the number to add to the DNC List |
| campaign_id | string | Yes | Campaign Id to restrict status to a specific campaign. (0 for global) |
| reason | string | Optional | DNC reason |
| purpose | string | Optional | DNC purpose |
⚠️ Error Codes
| Code | Message |
|---|---|
6006 | Invalid Campaign ID |
6007 | Invalid Phone Number |
6008 | The phone number already exists. |
6026 | Missing or invalid Country Code |
6056 | Missing or invalid value for ID |
6057 | Invalid Purpose Provided |
6058 | Invalid Reason Provided |
Example Request
POST https://api.convoso.com/v1/dnc/insert?auth_token=YOUR_AUTH_TOKEN&phone_number=9999999999&phone_code=1&campaign_id=1234
Response Format (JSON)
{
"success": true,
"id": 1
}Response Field Definitions
Response Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| id | integer | Lead identifier within the DNC List |