Package com.vonage.client.verify2
Class VerificationCallback
java.lang.Object
com.vonage.client.JsonableBaseObject
com.vonage.client.verify2.VerificationCallback
- All Implemented Interfaces:
Jsonable
Webhook for verification status updates and events. See the
API reference for details.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Channelprotected Integerprotected Stringprotected Instantprotected UUIDprotected VerificationStatusprotected Instantprotected Instantprotected CallbackTypeprotected List<WorkflowStatus> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic VerificationCallbackConstructs an instance of this class from a JSON payload.If getType() is CallbackType.EVENT, this will return the contact channel of the event update,nullotherwise.If getType() is CallbackType.SUMMARY, this will return the number of seconds before the current step in the verification request times out,nullotherwise.Contains the client reference given in the original Verify request if one was provided.The date and time the verification request was completed in ISO 8601 format ornullif this callback is not an event update.The ID of the request.If getChannel() is Channel.SILENT_AUTH, this will return the URL for Silent Auth Verify workflow completion,nullotherwise.Current status of this request.If getType() is CallbackType.SUMMARY, this will return the date-time the verification request was submitted in ISO 8601 format,nullotherwise.If getType() is CallbackType.EVENT, this will return the date-time the verification request was triggered in ISO 8601 format,nullotherwise.getType()Type of response.If getType() is CallbackType.SUMMARY, this will return metadata of the workflow steps in the order they were declared / executed along with their status,nullotherwise.Methods inherited from class com.vonage.client.JsonableBaseObject
createJsonObjectMapper, equals, hashCode, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.vonage.client.Jsonable
toJson, updateFromJson
-
Field Details
-
channel
-
requestId
-
triggeredAt
-
finalizedAt
-
submittedAt
-
status
-
type
-
clientRef
-
channelTimeout
-
workflows
-
-
Constructor Details
-
VerificationCallback
protected VerificationCallback()
-
-
Method Details
-
getChannel
If getType() is CallbackType.EVENT, this will return the contact channel of the event update,nullotherwise.- Returns:
- The communication channel, or
nullif not applicable.
-
getRequestId
The ID of the request.- Returns:
- The verification request ID.
-
getTriggeredAt
If getType() is CallbackType.EVENT, this will return the date-time the verification request was triggered in ISO 8601 format,nullotherwise.- Returns:
- The verification request's start timestamp, or
nullif not applicable.
-
getFinalizedAt
The date and time the verification request was completed in ISO 8601 format ornullif this callback is not an event update.- Returns:
- The request completion timestamp, or
nullif not applicable.
-
getSubmittedAt
If getType() is CallbackType.SUMMARY, this will return the date-time the verification request was submitted in ISO 8601 format,nullotherwise.- Returns:
- The verification request's start timestamp, or
nullif not applicable.
-
getStatus
Current status of this request.- Returns:
- The request status as an enum.
-
getType
Type of response. CallbackType.SUMMARY only applies to WhatsApp Interactive and Silent Auth.- Returns:
- The event type as an enum.
-
getClientRef
Contains the client reference given in the original Verify request if one was provided.- Returns:
- The client reference, or
nullif not available / applicable.
-
getChannelTimeout
If getType() is CallbackType.SUMMARY, this will return the number of seconds before the current step in the verification request times out,nullotherwise.- Returns:
- The verification request timeout, or
nullif not applicable.
-
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,nullotherwise.- Returns:
- The workflow status updates, or
nullif not applicable.
-
getSilentAuthUrl
If getChannel() is Channel.SILENT_AUTH, this will return the URL for Silent Auth Verify workflow completion,nullotherwise.- Returns:
- The Silent Authentication URL to check, or
nullif not applicable.
-
fromJson
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.
-