Errors

HTTP Status Codes

Unsuccessful requests to our REST API will result in one of the following HTTP status codes:

Status CodeNameDescription
400Bad RequestThe server was not able to process the request due to missing or invalid data.
401UnauthorizedWrong or missing credentials.
403ForbiddenThe request could not be processed due to missing permissions or because it would create an invalid state.
500Internal Server ErrorAn error occurred on the server while processing the request.

Response

Our service will respond to every request with JSON formatted data. If there is a problem with a request or if we encounter a problem, you will receive a response containing some information about what occurred. This will be helpful for resolution of any problems that occur.

Response Parameters

These parameters are wrapped in a ResponseStatus object.

ParameterTypeDescription
ErrorCodestringA single word descriptor of the type of error that was encountered (in capital letters) e.g. “FORBIDDEN”.
MessagestringA short friendly message describing the problem that was encountered.
ErrorsarrayAn array of ‘Error’ objects containing additional information.

Depending on the error, more details may be available. In this case the ‘ResponseStatus’ object contains an array of ‘error’ objects in a property called ‘Errors’ with following structure:

ParameterTypeDescription
FieldNamestringThe name of the invalid parameter.

Error Codes

Error CodeDescription
ADDRESS_CANNOT_BE_DELETEDA request to delete an address could not be processed as there are existing numbers which are linked to this address.
NUMBER_BELONGS_TO_DIFFERENT_PROPERTYThe number provided in the request belongs to a different property than the one provided in the request.
COUNTRY_UNAVAILABLEAttempted access to a country which is not available.
FORBIDDENA request could not be processed due to missing permissions.
PARAMETER_REQUIREDA required parameter is missing. The name of the missing parameter is available in the error message and as ‘FieldName’ in the ‘Error’ object (see above).
PARAMETER_INVALIDA supplied parameter is not within appropriate bounds. The name of the missing parameter is available in the error message and as ‘FieldName’ in the ‘Error’ object (see above).
PARAMETER_TOO_SHORTA provided parameter is too short. More details are available in the error message.
PARAMETER_TOO_LONGA provided parameter is too long. More details are available in the error message.
ONE_OF_SEVERAL_PARAMETERS_REQUIREDAt least one parameter from several parameters must be provided. The name of the parameters are available in the error message and (concatenated) as ‘FieldName’ in the ‘Error’ object (see above).
ADDRESS_NOT_FOUNDA matching address could not be found.
NUMBER_NOT_FOUNDA matching phone number could not be found.
LOCATION_NOT_FOUNDThe combination of geographical filters that were provided cannot be resolved to a known location.
COUNTRY_NOT_FOUNDA matching country could not be found.
PROPERTY_NOT_FOUNDA matching property could not be found.
ACCOUNT_NOT_FOUNDA matching account could not be found.
CALL_NOT_FOUNDA matching call could not be found.
UNKNOWN_ROUTING_METHODA provided routing method is not known.
UNKNOWN_RECORDING_OPTIONA provided recording option is not known.
UNKNOWN_CAPABILITYA provided capability is not known.
UNKNOWN_DISPOSITIONA provided disposition is not known.
UNKNOWN_NUMBERTYPEA provided number type is not known.
INVALID_PHONENUMBER_FORMATA provided number is not in the expected format (E.164).
INVALID_COUNTRYCODE_FORMATA provided country code is not in the expected format (ISO 3166-1).