Package com.vonage.client.verify

Class VerifyRequest

java.lang.Object

com.vonage.client.verify.BaseRequest

com.vonage.client.verify.VerifyRequest

All Implemented Interfaces:

QueryParamsRequest

public class VerifyRequest
extends BaseRequest

Describes a Verify request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VerifyRequest.Builder	Builder to create a Two Factor Authentication request
static enum	VerifyRequest.Workflow	Enumeration representing different verification workflows.

Constructor Summary

Constructors

Constructor	Description
VerifyRequest(VerifyRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static VerifyRequest.Builder	builder(String number, String brand)
String	getBrand()
String	getFrom()
String	getPinCode()	A custom PIN to send to the user.
VerifyRequest.Workflow	getWorkflow()
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.
String	toString()

Methods inherited from class com.vonage.client.verify.BaseRequest

getCountry, getDashedLocale, getLength, getLocale, getNextEventWait, getNumber, getPinExpiry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

VerifyRequest

public VerifyRequest(VerifyRequest.Builder builder)

Method Details

getBrand

public String getBrand()

Returns:

The name of the company or app to be verified for.

getFrom

public String getFrom()

Returns:

the short alphanumeric string to specify the SenderID for SMS sent by Verify, or null if one was not provided. This value is specified in some BaseRequest sub-class constructors.

If this value is null</tt>, the sender_id used will be <tt>VERIFY.

getWorkflow

public VerifyRequest.Workflow getWorkflow()

Returns:

The predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.

getPinCode

public String getPinCode()

A custom PIN to send to the user. If a PIN is not provided, Verify will generate a random PIN for you. This feature is not enabled by default - please discuss with your Account Manager if you would like it enabled.

Returns:

The custom pin code as a string, or null if not set.

Since:

7.5.0

makeParams

public Map<String,String> makeParams()

Description copied from interface: QueryParamsRequest

Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.

Specified by:

makeParams in interface QueryParamsRequest

Overrides:

makeParams in class BaseRequest

Returns:

The query parameters as unique key-value pairs.

toString

public String toString()

Overrides:

toString in class BaseRequest

builder

public static VerifyRequest.Builder builder(String number,
 String brand)

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app to be verified for. Must not be longer than 18 characters.

Returns:

A new Builder to start building.