Vonage Communication - Send verification request to phone

Use the Vonage Communication - Send verification request to phone action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to send a PIN code to a phone number and have the recipient enter that PIN in a form that returns it to the workflow, to verify that number is correct.

For more information about Vonage Communication, go to Vonage Communication

Before you begin: 

Jump to:

Configure the Vonage Communication - Send verification request to phone 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 Phone number you want to send the verification PIN to.
  2. Create or select a variable for the output.

Vonage Communication - Send verification request to phone 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 send the verification request.

To refresh the available connections, click .

(n/a)
Phone number The phone number you want to send the verification PIN to. The number must conform to the E. 164 standard. The number must contain digits split into at most 3 digits for the country code and 12 digits for the subscriber number. For example, +14253242400. The plus sign (+) indicates that the number includes the country calling code. Text, Decimal, Integer, Boolean, DateTime, Collection
Output Verification details

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

  • Request ID: (Text) The unique ID of the verify request. You need this value for the Vonage Communication - Check phone verification code action. This may be blank in an error situation.

  • 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.
    7 The number you are trying to verify is blacklisted for verification.  
    8 The api_key you supplied is for an account that has been barred from submitting messages.  
    9 Partner quota exceeded Your account does not have sufficient credit to process this request.
    10 Concurrent verifications to the same number are not allowed  
    15 The destination number is not in a supported network The request has been rejected. Find out more about this error in the Knowledge Base.
    20 This account does not support the parameter: pin_code. Only certain accounts have the ability to set the pin_code. Please contact your account manager for more information.
    29 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.

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

 Object