Introduction

The blacklist API call is used retrieve all the records that was blacklisted.

Query Parameters

All the blacklist API calls will use the following query parameters.

The start and end data parameters are for when the record's were blacklisted.

Query Parameters:

Blacklist SMS

This API call is used to retrieve all the records that have been blacklisted for sending a SMS.

Valid Record Response:

{
    "status": true,
    "data": [
        {
            "cellphone": "+27123456789",
            "work": "+27123456712",
            "home": "+27123456734"
        },
        ...
    ]
}

Blacklist Phone

This API call is used to retrieve all the records that have been blacklisted for Phoning.

Valid Record Response:

{
    "status": true,
    "data": [
        {
            "cellphone": "+27123456789",
            "work": "+27123456712",
            "home": "+27123456734"
        },
        ...
    ]
}

Error Response:

{
    "status": false,
    "error": "Not authorized to make this API call. Requesting Read on General."
}

When you get this API response ensure that under the API keys section your API Key has the correct permissions: API Keys