Package com.vonage.client.verify2

Class VerificationCallback

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.verify2.VerificationCallback

All Implemented Interfaces:

Jsonable

public class VerificationCallback
extends JsonableBaseObject

Webhook for verification status updates and events. See the API reference for details.

Field Summary

Fields

Modifier and Type	Field	Description
protected Channel	channel
protected Integer	channelTimeout
protected String	clientRef
protected Instant	finalizedAt
protected UUID	requestId
protected VerificationStatus	status
protected Instant	submittedAt
protected Instant	triggeredAt
protected CallbackType	type
protected List<WorkflowStatus>	workflows

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VerificationCallback()

Method Summary

Modifier and Type	Method	Description
static VerificationCallback	fromJson(String json)	Constructs an instance of this class from a JSON payload.
Channel	getChannel()	If getType() is CallbackType.EVENT, this will return the contact channel of the event update, null otherwise.
Integer	getChannelTimeout()	If getType() is CallbackType.SUMMARY, this will return the number of seconds before the current step in the verification request times out, null otherwise.
String	getClientRef()	Contains the client reference given in the original Verify request if one was provided.
Instant	getFinalizedAt()	The date and time the verification request was completed in ISO 8601 format or null if this callback is not an event update.
UUID	getRequestId()	The ID of the request.
URI	getSilentAuthUrl()	If getChannel() is Channel.SILENT_AUTH, this will return the URL for Silent Auth Verify workflow completion, null otherwise.
VerificationStatus	getStatus()	Current status of this request.
Instant	getSubmittedAt()	If getType() is CallbackType.SUMMARY, this will return the date-time the verification request was submitted in ISO 8601 format, null otherwise.
Instant	getTriggeredAt()	If getType() is CallbackType.EVENT, this will return the date-time the verification request was triggered in ISO 8601 format, null otherwise.
CallbackType	getType()	Type of response.
List<WorkflowStatus>	getWorkflows()	If getType() is CallbackType.SUMMARY, this will return metadata of the workflow steps in the order they were declared / executed along with their status, null otherwise.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Field Details

channel

protected Channel channel

requestId

protected UUID requestId

triggeredAt

protected Instant triggeredAt

finalizedAt

protected Instant finalizedAt

submittedAt

protected Instant submittedAt

status

protected VerificationStatus status

type

protected CallbackType type

clientRef

protected String clientRef

channelTimeout

protected Integer channelTimeout

workflows

protected List<WorkflowStatus> workflows

Constructor Details

VerificationCallback

protected VerificationCallback()

Method Details

getChannel

public Channel getChannel()

If getType() is CallbackType.EVENT, this will return the contact channel of the event update, null otherwise.

Returns:

The communication channel, or null if not applicable.

getRequestId

public UUID getRequestId()

The ID of the request.

Returns:

The verification request ID.

getTriggeredAt

public Instant getTriggeredAt()

If getType() is CallbackType.EVENT, this will return the date-time the verification request was triggered in ISO 8601 format, null otherwise.

Returns:

The verification request's start timestamp, or null if not applicable.

getFinalizedAt

public Instant getFinalizedAt()

The date and time the verification request was completed in ISO 8601 format or null if this callback is not an event update.

Returns:

The request completion timestamp, or null if not applicable.

getSubmittedAt

public Instant getSubmittedAt()

If getType() is CallbackType.SUMMARY, this will return the date-time the verification request was submitted in ISO 8601 format, null otherwise.

Returns:

The verification request's start timestamp, or null if not applicable.

getStatus

public VerificationStatus getStatus()

Current status of this request.

Returns:

The request status as an enum.

getType

public CallbackType getType()

Type of response. CallbackType.SUMMARY only applies to WhatsApp Interactive and Silent Auth.

Returns:

The event type as an enum.

getClientRef

public String getClientRef()

Contains the client reference given in the original Verify request if one was provided.

Returns:

The client reference, or null if not available / applicable.

getChannelTimeout

public Integer getChannelTimeout()

If getType() is CallbackType.SUMMARY, this will return the number of seconds before the current step in the verification request times out, null otherwise.

Returns:

The verification request timeout, or null if not applicable.

getWorkflows

public List<WorkflowStatus> getWorkflows()

If getType() is CallbackType.SUMMARY, this will return metadata of the workflow steps in the order they were declared / executed along with their status, null otherwise.

Returns:

The workflow status updates, or null if not applicable.

getSilentAuthUrl

public URI getSilentAuthUrl()

If getChannel() is Channel.SILENT_AUTH, this will return the URL for Silent Auth Verify workflow completion, null otherwise.

Returns:

The Silent Authentication URL to check, or null if not applicable.

fromJson

public static VerificationCallback fromJson(String json)

Constructs an instance of this class from a JSON payload.

Parameters:

json - The webhook response JSON string.

Returns:

The deserialized webhook response object.

Throws:

VonageResponseParseException - If the response could not be deserialized.