CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Query for existing do not contact (DNC) numbers.
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| QueryDncNumbersRequest | Query numbers in do not contact lists | object | |
| MaxResults | Max number of results to return limited to 1000 (default: 1000) | long | |
| FirstResult | Start of next result set (default: 0) | long | |
| Prefix | Prefix (1-10 digits) of numbers | string | |
| DncListId | DNC List ID | long | |
| DncListName | DNC List name | string | |
| CallDnc | Filter by call do not contact list | boolean | |
| TextDnc | Filter by text do not contact list | boolean |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| QueryDncNumbersResponse | List of numbers in dnc list | |
| TotalResults | Results count | long |
| DncNumber | Do not contact number | |
| Number | 11 digit number | PhoneNumber |
| DncListId | Unique ID of DncList | long |
| CallDnc | Is number in call do not contact list | boolean |
| TextDnc | Is number in text do not contact list | boolean |