Package com.vonage.client.verify

Class CheckResponse

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.verify.CheckResponse

All Implemented Interfaces:

Jsonable

public class CheckResponse
extends JsonableBaseObject

Constructor Summary

Constructors

Constructor	Description
CheckResponse(VerifyStatus status)

Method Summary

Modifier and Type	Method	Description
static CheckResponse	fromJson(String json)	Constructs a CheckResponse with the fields populated from the JSON payload.
String	getCurrency()
String	getErrorText()
BigDecimal	getEstimatedPriceMessagesSent()
String	getEventId()
BigDecimal	getPrice()
String	getRequestId()
VerifyStatus	getStatus()
void	updateFromJson(String json)	Updates this class's fields from the JSON payload.

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

Constructor Details

CheckResponse

public CheckResponse(VerifyStatus status)

Method Details

getRequestId

public String getRequestId()

Returns:

The request_id that you received in the response to the Verify request and used in the Verify check request.

getEventId

public String getEventId()

Returns:

The ID of the verification event, such as an SMS or TTS call.

getStatus

public VerifyStatus getStatus()

Returns:

A value of VerifyStatus.OK indicates that your user entered the correct code. Otherwise, check getErrorText().

getPrice

public BigDecimal getPrice()

Returns:

The cost incurred for this request.

getCurrency

public String getCurrency()

Returns:

The currency code.

getErrorText

public String getErrorText()

Returns:

If the status is non-zero, this explains the error encountered.

getEstimatedPriceMessagesSent

public BigDecimal getEstimatedPriceMessagesSent()

Returns:

This field may not be present, depending on your pricing model. The value indicates the cost (in EUR) of the calls made and messages sent for the verification process. This value may be updated during and shortly after the request completes because user input events can overlap with message/call events. When this field is present, the total cost of the verification is the sum of this field and the price field.

Since:

7.1.0

updateFromJson

public void updateFromJson(String json)

Description copied from interface: Jsonable

Updates this class's fields from the JSON payload.

Parameters:

json - The JSON string.

fromJson

public static CheckResponse fromJson(String json)

Constructs a CheckResponse with the fields populated from the JSON payload.

Parameters:

json - The JSON string.

Returns:

A new instance of this class.