Package com.vonage.client.verify

Enum Class VerifyStatus

java.lang.Object
java.lang.Enum<VerifyStatus>
com.vonage.client.verify.VerifyStatus
All Implemented Interfaces:
Serializable, Comparable<VerifyStatus>, java.lang.constant.Constable
public enum VerifyStatus extends Enum<VerifyStatus>

  • Enum Constant Details

    • OK

      public static final VerifyStatus OK
      The request was successfully accepted by Vonage.

    • THROTTLED

      public static final VerifyStatus THROTTLED
      You are trying to send more than the maximum of 30 requests per second.

    • MISSING_PARAMS

      public static final VerifyStatus MISSING_PARAMS
      Your request is incomplete and missing the mandatory parameter(s).

    • INVALID_PARAMS

      public static final VerifyStatus INVALID_PARAMS
      Invalid value for parameter. If you see Facility not allowed in the error text, check that you are using the correct Base URL in your request.

    • INVALID_CREDENTIALS

      public static final VerifyStatus INVALID_CREDENTIALS
      The supplied API key or secret in the request is either invalid or disabled.

    • INTERNAL_ERROR

      public static final VerifyStatus INTERNAL_ERROR
      An error occurred processing this request in the Cloud Communications Platform.

    • INVALID_REQUEST

      public static final VerifyStatus INVALID_REQUEST
      The request could not be routed.

    • NUMBER_BARRED

      public static final VerifyStatus NUMBER_BARRED
      The number you are trying to verify is blacklisted for verification.

    • PARTNER_ACCOUNT_BARRED

      public static final VerifyStatus PARTNER_ACCOUNT_BARRED
      The api_key you supplied is for an account that has been barred from submitting messages.

    • PARTNER_QUOTA_EXCEEDED

      public static final VerifyStatus PARTNER_QUOTA_EXCEEDED
      Your account does not have sufficient credit to process this request.

    • ALREADY_REQUESTED

      public static final VerifyStatus ALREADY_REQUESTED
      Concurrent verifications to the same number are not allowed.

    • UNSUPPORTED_NETWORK

      public static final VerifyStatus UNSUPPORTED_NETWORK
      The request has been rejected. Find out more about this error in the Knowledge Base.

    • INVALID_CODE

      public static final VerifyStatus INVALID_CODE
      The code inserted does not match the expected value.

    • WRONG_CODE_THROTTLED

      public static final VerifyStatus WRONG_CODE_THROTTLED
      You can run Verify check on a specific request_id up to three times unless a new verification code is generated. If you check a request more than three times, it is set to FAILED and you cannot check it again.

    • WAIT_FOR_COMPLETION

      public static final VerifyStatus WAIT_FOR_COMPLETION
      For cancel: Either you have not waited at least 30 seconds after sending a Verify request before cancelling or Verify has made too many attempts to deliver the verification code for this request, and you must now wait for the process to complete. For trigger_next_event: All attempts to deliver the verification code for this request have completed and there are no remaining events to advance to.

    • UNSUPPORTED_PIN_CODE

      public static final VerifyStatus UNSUPPORTED_PIN_CODE
      Only certain accounts have the ability to set the pin_code parameter. Please contact your account manager for more information.

    • NON_PERMITTED_DESTINATION

      public static final VerifyStatus NON_PERMITTED_DESTINATION
      Your Vonage account is still in demo mode. While in demo mode you must add target numbers to the approved list for your account. Add funds to your account tO remove this limitation.

    • UNKNOWN

      public static final VerifyStatus UNKNOWN
      Undefined or unknown value.

  • Method Details

    • values

      public static VerifyStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VerifyStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromInt

      public static VerifyStatus fromInt(int verifyStatus)
      Look up the VerifyStatus based on the int value.
      Parameters:
      verifyStatus - the int value of the verify status.
      Returns:
      VerifyStatus based on the int value given.

    • getVerifyStatus

      public int getVerifyStatus()