com.nexmo.client.verify

Class VerifyRequest.Builder

java.lang.Object

com.nexmo.client.verify.VerifyRequest.Builder

Enclosing class:

VerifyRequest

public static class VerifyRequest.Builder
extends java.lang.Object

Builder to create a Two Factor Authentication request

Since:

5.5.0

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String number, java.lang.String brand)

Method Summary

Modifier and Type	Method and Description
VerifyRequest	build()
VerifyRequest.Builder	country(java.lang.String country) The country for the destination phone number.
VerifyRequest.Builder	length(java.lang.Integer length)
VerifyRequest.Builder	locale(java.util.Locale locale)
VerifyRequest.Builder	nextEventWait(java.lang.Integer nextEventWait)
VerifyRequest.Builder	pinExpiry(java.lang.Integer pinExpiry)
VerifyRequest.Builder	senderId(java.lang.String senderId)
VerifyRequest.Builder	type(VerifyRequest.LineType type)
VerifyRequest.Builder	workflow(VerifyRequest.Workflow workflow) Set the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String number,
               java.lang.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.

Method Detail

senderId

public VerifyRequest.Builder senderId(java.lang.String senderId)

Parameters:

senderId - the short alphanumeric string to specify the SenderID for SMS sent by Verify.

Returns:

VerifyRequest.Builder

type

public VerifyRequest.Builder type(VerifyRequest.LineType type)

Parameters:

type - the type of network the verification will be restricted to. This value has no effect unless it has been enabled by contacting support@nexmo.com.

Returns:

VerifyRequest.Builder

workflow

public VerifyRequest.Builder workflow(VerifyRequest.Workflow workflow)

Set the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user. See https://developer.nexmo.com/verify/guides/workflows-and-events

Parameters:

workflow - The workflow to use for conveying the PIN to your user.

Returns:

VerifyRequest.Builder

locale

public VerifyRequest.Builder locale(java.util.Locale locale)

Parameters:

locale - (optional) Override the default locale used for verification. By default the locale is determined from the country code included in number

Returns:

VerifyRequest.Builder

length

public VerifyRequest.Builder length(java.lang.Integer length)

Parameters:

length - (optional) The length of the verification code to be sent to the user. Must be either 4 or 6. Use -1 to use the default value.

Returns:

VerifyRequest.Builder

pinExpiry

public VerifyRequest.Builder pinExpiry(java.lang.Integer pinExpiry)

Parameters:

pinExpiry - (optional) the PIN validity time from generation, in seconds. Default is 300 seconds

Returns:

VerifyRequest.Builder

nextEventWait

public VerifyRequest.Builder nextEventWait(java.lang.Integer nextEventWait)

Parameters:

nextEventWait - (optional) the wait time between attempts to deliver the PIN. A number between 600-900.

Returns:

VerifyRequest.Builder

country

public VerifyRequest.Builder country(java.lang.String country)

The country for the destination phone number.

If you wish to used localised number formats or you are not sure if number is correctly formatted, set this to a two-character country code. For example, GB, US. Verify will work out the international phone number for you.

Parameters:

country - a String containing a 2-character country code

Returns:

VerifyRequest.Builder

build

public VerifyRequest build()