Vonage Communication - Check phone verification code

Use the Vonage Communication - Check phone verification code action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to confirm that the PIN received from a user matches the one sent by Vonage in the verification request.

For more information about Vonage Communication, go to Vonage Communication

Before you begin: 

Jump to:

Configure the Vonage Communication - Check phone verification code action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  1. Select a Connection. If you do not have a connection, see Add a connection.
  1. Specify the received verification PIN Code.
  2. Specify the Request ID.
  3. Create or select a variable for the output.

Vonage Communication - Check phone verification code action fields and settings

Section

Field

Description

Variable types

(Unlabeled)

Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The Vonage Communication connection to use to check the verification code.

To refresh the available connections, click .

(n/a)
Code The verification code entered by the recipient. Text, Decimal, Integer, Boolean, DateTime, Collection
  Request ID The unique ID of the verification request to check (associated with the PIN code used in this action).
You can use the output object of a Vonage Communication - Send verification request to phone action to retrieve the request ID.
  
Output Verification details

Stores the result of the action as an object. The following values are returned:

  • Status: (Text) Indicates the outcome of the request. For example, zero is success. The following table describes all status codes:

    Code

    Text

    Description
    0 Success The request was successfully accepted by Vonage.
    1 Throttled You are trying to send more than the maximum of 30 requests per second.
    2 Your request is incomplete and missing the mandatory parameter $parameter The stated parameter is missing.
    3 Invalid value for parameter $parameter 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.
    4 Invalid credentials were provided The supplied API key or secret in the request is either invalid or disabled
    5 Internal Error An error occurred processing this request in the Cloud Communications Platform.
    6 The Vonage platform was unable to process this message for the following reason: $reason The request could not be routed.
    16 The code inserted does not match the expected value.  
    17 The wrong code was provided too many times 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.
  • Request ID: (Text) The request ID received in the response to the verification request and used in the verification check request.
  • Event ID: (Text) The ID of the verification event, such as an SMS or TTS call.
  • Price: (Text) The cost incurred for this request.
  • Currency: (Text) The currency code.
  • Estimated price message sent: (Text) This field may not be present, depending on your pricing model. The value indicates the cost (in EUR) of the calls made and messages sent for the verification process. This value may be updated during and shortly after the request completes because user input events can overlap with message/call events. When this field is present, the total cost of the verification is the sum of this field and the price field.

  • Error text: (Text) If the Status is not zero, this describes the error encountered.

 Object