-
Notifications
You must be signed in to change notification settings - Fork 2
Error codes
These are common error codes that could be returned for any API call. Some other operation-specific errors might be encountered too but those are described in their respective pages.
ERROR_OK (0): No error, indicates a successful API request.
ERROR_ACTION_NOT_FOUND (3): Invalid or non-existent action was requested. This could indicate a malformed request URL.
ERROR_INTERNAL (4): Internal system error. If an error like this persists, please contact our support and provide the information about the API request you made.
ERROR_UNKNOWN (5): Unknown error. This can happen in cases when the request calls upon a third party system, for example, when sending SMS messages or making number lookups, which returns an unknown status code.
ERROR_OTHER (6): Similar to ERROR_UNKNOWN - this can happen when an unknown or overly generic status code is received from an upstream provider.
ERROR_SERVICE_NOT_ENABLED (7): The service you're trying to use is not enabled for your account.
ERROR_KEY_UNAUTHORIZED (1): The API key/username provided for authorization was not found.
ERROR_IP_UNAUTHORIZED (2): The API account is not authorized to make requests from the IP address used.
ERROR_NO_NUMBER (1001): No number was provided to look up.
ERROR_INVALID_NUMBER (1002): An invalid number was provided (impossible number format for the given country code and number combination.
ERROR_UNKNOWN_SUBSCRIBER (1003): The operator doesn't have a subscriber for the provided number - this could happen if the number is assigned to the operator but the operator hasn't given number to any of its users.
ERROR_ABSENT_SUBSCRIBER (1004): The subscriber is currently not present in the operator's network. This can happen if the subscriber's phone is switched off or out of network coverage.
ERROR_UNKNOWN_EQUIPMENT (1005): The mobile device has not been recognized by the mobile operator.
ERROR_ROAMING_NOT_ALLOWED (1006): Subscriber is attempting to use another operator's infrastructure, however, the subscriber's home network and the roaming network do not have a roaming agreement, and it cannot be guaranteed that any call or messaging attempts will go through.
ERROR_ILLEGAL_SUBSCRIBER (1007): Subscriber is not allowed to use the network they're attempting to use.
ERROR_SERVICE_NOT_PROVISIONED (1008): The operator is currently not providing service to the subscriber. This could be due to temporarily cancelled agreements, low pre-paid account balance, unpaid bills, etc.
ERROR_ILLEGAL_EQUIPMENT (1009): The subscriber's device is not permitted in the mobile network.
ERROR_CALL_BARRED (1010): The subscriber has opted not to receive messages or calls to their number.
ERROR_FACILITY_NOT_SUPPORTED (1011): Facility not supported.
ERROR_NO_RESPONSE (1012): No response was received from the mobile network.
In addition to these error codes, the HTTP status code will indicate an error as well, for example, 401 for unauthorized requests, 404 when no data was found, etc.