Package com.nexmo.client.verify
Class BaseResult
- java.lang.Object
-
- com.nexmo.client.verify.BaseResult
-
public abstract class BaseResult extends java.lang.Object
An abstract base class for verification results.
-
-
Field Summary
Fields Modifier and Type Field Description static int
STATUS_ALREADY_REQUESTED
Verify was rejected because another verification to the same number was already requested.static int
STATUS_COMMS_FAILURE
A network error occurredstatic int
STATUS_INTERNAL_ERROR
Verify was rejected due to a failure within the Nexmo systems.
Verify can be re-submitted after a short delaystatic int
STATUS_INVALID_CODE
The code inserted does not match the expected valuestatic int
STATUS_INVALID_CREDENTIALS
Verify was rejected due to receiving invalid account api key and/or secretstatic int
STATUS_INVALID_PARAMS
Verify was rejected due to an illegal value in one or more elements of the submission requeststatic int
STATUS_INVALID_REQUEST
Verify was rejected because the Nexmo service was unable to handle this request.static int
STATUS_MISSING_PARAMS
Verify was rejected due to incomplete data in the submission requeststatic int
STATUS_NO_RESPONSE
There are no matching verification requestsstatic int
STATUS_NUMBER_BARRED
Verify was rejected because the phone number you tried to submit to has been blacklisted.static int
STATUS_OK
Verify was successfully submitted to the Nexmo servicestatic int
STATUS_PARTNER_ACCOUNT_BARRED
Verify was rejected because your account has been barred, or has not yet been activatedstatic int
STATUS_PARTNER_QUOTA_EXCEEDED
Verify was rejected because your pre-paid balance does not contain enough credit to handle this request.
Please top up your balance before re-submitting this request or subsequent requests.static int
STATUS_THROTTLED
Verify was rejected due to exceeding the maximum throughput allowed for this account.
Verify can be re-requested after a short delaystatic int
STATUS_TOO_MANY_DESTINATIONS
There are more than the maximum allowed number of destinations in this requeststatic int
STATUS_UNSUPPORTED_NETWORK
The destination number is not in a supported networkstatic int
STATUS_WRONG_CODE_THROTTLED
A wrong code was provided too many times
-
Constructor Summary
Constructors Modifier Constructor Description protected
BaseResult(int status, java.lang.String errorText, boolean temporaryError)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getErrorText()
int
getStatus()
boolean
isTemporaryError()
-
-
-
Field Detail
-
STATUS_OK
public static final int STATUS_OK
Verify was successfully submitted to the Nexmo service- See Also:
- Constant Field Values
-
STATUS_THROTTLED
public static final int STATUS_THROTTLED
Verify was rejected due to exceeding the maximum throughput allowed for this account.
Verify can be re-requested after a short delay- See Also:
- Constant Field Values
-
STATUS_MISSING_PARAMS
public static final int STATUS_MISSING_PARAMS
Verify was rejected due to incomplete data in the submission request- See Also:
- Constant Field Values
-
STATUS_INVALID_PARAMS
public static final int STATUS_INVALID_PARAMS
Verify was rejected due to an illegal value in one or more elements of the submission request- See Also:
- Constant Field Values
-
STATUS_INVALID_CREDENTIALS
public static final int STATUS_INVALID_CREDENTIALS
Verify was rejected due to receiving invalid account api key and/or secret- See Also:
- Constant Field Values
-
STATUS_INTERNAL_ERROR
public static final int STATUS_INTERNAL_ERROR
Verify was rejected due to a failure within the Nexmo systems.
Verify can be re-submitted after a short delay- See Also:
- Constant Field Values
-
STATUS_INVALID_REQUEST
public static final int STATUS_INVALID_REQUEST
Verify was rejected because the Nexmo service was unable to handle this request. eg, the destination was un-routable.- See Also:
- Constant Field Values
-
STATUS_NUMBER_BARRED
public static final int STATUS_NUMBER_BARRED
Verify was rejected because the phone number you tried to submit to has been blacklisted.- See Also:
- Constant Field Values
-
STATUS_PARTNER_ACCOUNT_BARRED
public static final int STATUS_PARTNER_ACCOUNT_BARRED
Verify was rejected because your account has been barred, or has not yet been activated- See Also:
- Constant Field Values
-
STATUS_PARTNER_QUOTA_EXCEEDED
public static final int STATUS_PARTNER_QUOTA_EXCEEDED
Verify was rejected because your pre-paid balance does not contain enough credit to handle this request.
Please top up your balance before re-submitting this request or subsequent requests.- See Also:
- Constant Field Values
-
STATUS_ALREADY_REQUESTED
public static final int STATUS_ALREADY_REQUESTED
Verify was rejected because another verification to the same number was already requested.- See Also:
- Constant Field Values
-
STATUS_UNSUPPORTED_NETWORK
public static final int STATUS_UNSUPPORTED_NETWORK
The destination number is not in a supported network- See Also:
- Constant Field Values
-
STATUS_INVALID_CODE
public static final int STATUS_INVALID_CODE
The code inserted does not match the expected value- See Also:
- Constant Field Values
-
STATUS_WRONG_CODE_THROTTLED
public static final int STATUS_WRONG_CODE_THROTTLED
A wrong code was provided too many times- See Also:
- Constant Field Values
-
STATUS_TOO_MANY_DESTINATIONS
public static final int STATUS_TOO_MANY_DESTINATIONS
There are more than the maximum allowed number of destinations in this request- See Also:
- Constant Field Values
-
STATUS_NO_RESPONSE
public static final int STATUS_NO_RESPONSE
There are no matching verification requests- See Also:
- Constant Field Values
-
STATUS_COMMS_FAILURE
public static final int STATUS_COMMS_FAILURE
A network error occurred- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BaseResult
protected BaseResult(int status, java.lang.String errorText, boolean temporaryError)
-
-
Method Detail
-
getStatus
public int getStatus()
-
getErrorText
public java.lang.String getErrorText()
-
isTemporaryError
public boolean isTemporaryError()
-
-