Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ABSENT - Enum constant in enum class com.vonage.client.insight.Reachability
 
AbstractAnswerServlet - Class in com.vonage.client.voice.servlet
Deprecated.
This class is no longer maintained and may be removed in a future release.
AbstractAnswerServlet() - Constructor for class com.vonage.client.voice.servlet.AbstractAnswerServlet
Deprecated.
 
AbstractHasher - Class in com.vonage.client.auth.hashutils
 
AbstractHasher() - Constructor for class com.vonage.client.auth.hashutils.AbstractHasher
 
AbstractMethod<RequestT,ResultT> - Class in com.vonage.client
Abstract class to assist in implementing a call against a REST endpoint.
AbstractMethod(HttpWrapper) - Constructor for class com.vonage.client.AbstractMethod
 
AbstractMOServlet - Class in com.vonage.client.sms.callback
Deprecated.
This class is no longer maintained and may be removed in a future release.
AbstractMOServlet(boolean, String, boolean, String, String) - Constructor for class com.vonage.client.sms.callback.AbstractMOServlet
Deprecated.
 
AbstractMOServlet(boolean, String, boolean, String, String, HashUtil.HashType) - Constructor for class com.vonage.client.sms.callback.AbstractMOServlet
Deprecated.
 
accept - Variable in class com.vonage.client.DynamicEndpoint
 
acceptHeader(String) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
Account - Class in com.vonage.client.subaccounts
Represents a subaccount.
Account() - Constructor for class com.vonage.client.subaccounts.Account
 
ACCOUNT_NOT_HTTP - Enum constant in enum class com.vonage.client.sms.MessageStatus
This account is not provisioned for the SMS API.
ACCOUNT_UPDATE - Enum constant in enum class com.vonage.client.messages.messenger.Tag
 
AccountClient - Class in com.vonage.client.account
A client for talking to the Vonage Account API.
AccountClient(HttpWrapper) - Constructor for class com.vonage.client.account.AccountClient
Constructor.
AccountResponseException - Exception in com.vonage.client.account
Response returned when an error is encountered (i.e.
AccountResponseException() - Constructor for exception com.vonage.client.account.AccountResponseException
 
Action - Class in com.vonage.client.messages.viber
 
Action - Interface in com.vonage.client.voice.ncco
An NCCO action.
ACTION_CALL_FAILED - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Action call failed
ACTION_CALL_INFO - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Action call info
ACTION_CALL_SUCCEEDED - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Action call succeeded
ACTION_PENDING - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
Action pending.
actionId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Action ID to filter by.
actionText - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
actionText(String) - Method in class com.vonage.client.messages.viber.ViberImageRequest.Builder
 
actionText(String) - Method in class com.vonage.client.messages.viber.ViberRequest.Builder
(OPTIONAL) Text which is rendered on the action button.
actionText(String) - Method in class com.vonage.client.messages.viber.ViberTextRequest.Builder
 
actionUrl - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
actionUrl(String) - Method in class com.vonage.client.messages.viber.ViberImageRequest.Builder
 
actionUrl(String) - Method in class com.vonage.client.messages.viber.ViberRequest.Builder
(OPTIONAL) A URL which is requested when the action button is clicked.
actionUrl(String) - Method in class com.vonage.client.messages.viber.ViberTextRequest.Builder
 
activeStatus - Variable in class com.vonage.client.insight.RealTimeData
 
add(AuthMethod) - Method in class com.vonage.client.auth.AuthCollection
Add a new AuthMethod to the set managed by this AuthCollection.
addCapability(Capability) - Method in class com.vonage.client.application.Application.Builder
Add a capability for the application.
addProductsSection(String, String...) - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
(REQUIRED) Adds a grouping of products using their unique retail identifiers.
addProductsSection(String, List<String>) - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
(REQUIRED) Adds a grouping of products using their unique retail identifiers.
address(String) - Method in class com.vonage.client.common.Webhook.Builder
(REQUIRED) The webhook's URL.
address(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest.Builder
(OPTIONAL) Address of the location.
addWebhook(Webhook.Type, Webhook) - Method in class com.vonage.client.application.capabilities.Messages.Builder
 
addWebhook(Webhook.Type, Webhook) - Method in class com.vonage.client.application.capabilities.Rtc.Builder
 
addWebhook(Webhook.Type, Webhook) - Method in class com.vonage.client.application.capabilities.Voice.Builder
 
addWorkflow(Workflow) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(REQUIRED) Workflows are a sequence of actions that Vonage use to reach the user you wish to verify with a PIN code.
AdvancedInsightRequest - Class in com.vonage.client.insight
 
AdvancedInsightRequest.Builder - Class in com.vonage.client.insight
 
AdvancedInsightResponse - Class in com.vonage.client.insight
Response object constructed from the JSON payload returned for Advanced number insight requests.
AdvancedInsightResponse() - Constructor for class com.vonage.client.insight.AdvancedInsightResponse
 
advancedMachineDetection(AdvancedMachineDetection) - Method in class com.vonage.client.voice.Call.Builder
Configure the behavior of Vonage's advanced machine detection.
advancedMachineDetection(AdvancedMachineDetection) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Configure the behavior of Vonage's advanced machine detection.
AdvancedMachineDetection - Class in com.vonage.client.voice
Configure the behavior of Vonage's advanced machine detection.
AdvancedMachineDetection.Builder - Class in com.vonage.client.voice
 
AdvancedMachineDetection.Mode - Enum Class in com.vonage.client.voice
Represents the beep detection mode.
advanceVerification(String) - Method in class com.vonage.client.verify.VerifyClient
Advance a current verification request to the next stage in the process.
AFRIKAANS - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
AFRIKAANS - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
AFTER_OWNER_ONLY - Enum constant in enum class com.vonage.client.meetings.JoinApprovalLevel
Participants will join the meeting only after the host joined.
ALBANIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ALBANIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
alias - Variable in class com.vonage.client.proactiveconnect.ListAttribute.Builder
 
alias(String) - Method in class com.vonage.client.proactiveconnect.ListAttribute.Builder
Sets the list attribute alias.
ALL - Enum constant in enum class com.vonage.client.verify.VerifyRequest.LineType
 
ALREADY_REQUESTED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Concurrent verifications to the same number are not allowed.
AMERICAN_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
AMERICAN_SPANISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
AMHARIC - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
amount(double) - Method in class com.vonage.client.subaccounts.MoneyTransfer.Builder
(REQUIRED) Transfer amount.
amount(double) - Method in class com.vonage.client.verify.Psd2Request.Builder
(REQUIRED)
amount(double) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(REQUIRED)
amount(BigDecimal) - Method in class com.vonage.client.subaccounts.MoneyTransfer.Builder
(REQUIRED) Transfer amount.
ANSWER - Enum constant in enum class com.vonage.client.common.Webhook.Type
 
ANSWERED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
ANSWERED - Enum constant in enum class com.vonage.client.voice.CallStatus
 
answerMethod(HttpMethod) - Method in class com.vonage.client.voice.Call.Builder
The HTTP method used to send event information to answer_url.
answerUrl(String) - Method in class com.vonage.client.voice.Call.Builder
The webhook endpoint where you provide the Nexmo Call Control Object that governs this call.
ANYWHERE - Enum constant in enum class com.vonage.client.numbers.SearchPattern
 
APAC_AUSTRALIA - Enum constant in enum class com.vonage.client.application.capabilities.Region
api-ap-4.vonage.com (Sydney)
APAC_SNG - Enum constant in enum class com.vonage.client.application.capabilities.Region
api-ap-3.vonage.com (Singapore)
apiBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
 
apiEuBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
 
apiKey(String) - Method in class com.vonage.client.VonageClient.Builder
When setting an apiKey, it is also expected that VonageClient.Builder.apiSecret(String) and/or VonageClient.Builder.signatureSecret(String) will also be set.
apiSecret(String) - Method in class com.vonage.client.VonageClient.Builder
When setting an apiSecret, it is also expected that VonageClient.Builder.apiKey(String) will also be set.
APP - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
appendNcco(Action) - Method in class com.vonage.client.voice.servlet.NccoResponse
 
appendNcco(Action) - Method in class com.vonage.client.voice.servlet.NccoResponseBuilder
 
AppEndpoint - Class in com.vonage.client.voice
Represents an app-to-app call type.
AppEndpoint - Class in com.vonage.client.voice.ncco
Represents an app endpoint used in a ConnectAction.
AppEndpoint() - Constructor for class com.vonage.client.voice.AppEndpoint
 
AppEndpoint(String) - Constructor for class com.vonage.client.voice.AppEndpoint
 
AppEndpoint.Builder - Class in com.vonage.client.voice.ncco
 
Application - Class in com.vonage.client.application
Represents a Vonage Application (both request and response).
Application - Class in com.vonage.client.meetings
 
Application() - Constructor for class com.vonage.client.meetings.Application
 
APPLICATION_JSON - Static variable in class com.vonage.client.auth.RequestSigning
 
Application.Builder - Class in com.vonage.client.application
 
Application.Capabilities - Class in com.vonage.client.application
 
Application.Keys - Class in com.vonage.client.application
Represents the cryptographic keys of an Application.
Application.Privacy - Class in com.vonage.client.application
Application privacy configuration settings.
ApplicationClient - Class in com.vonage.client.application
A client for talking to the Vonage Application API.
ApplicationClient(HttpWrapper) - Constructor for class com.vonage.client.application.ApplicationClient
 
applicationId(String) - Method in class com.vonage.client.VonageClient.Builder
When setting an applicationId, it is also expected that the VonageClient.Builder.privateKeyContents will also be set.
ApplicationList - Class in com.vonage.client.application
ApplicationList() - Constructor for class com.vonage.client.application.ApplicationList
 
ApplicationResponseException - Exception in com.vonage.client.application
Response returned when an error is encountered (i.e.
ApplicationResponseException() - Constructor for exception com.vonage.client.application.ApplicationResponseException
 
apply(RequestBuilder) - Method in interface com.vonage.client.auth.AuthMethod
 
apply(RequestBuilder) - Method in class com.vonage.client.auth.JWTAuthMethod
 
apply(RequestBuilder) - Method in class com.vonage.client.auth.SignatureAuthMethod
 
apply(RequestBuilder) - Method in class com.vonage.client.auth.TokenAuthMethod
 
applyAsBasicAuth() - Method in class com.vonage.client.DynamicEndpoint.Builder
 
applyAsBasicAuth(boolean) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
applyAsBasicAuth(RequestBuilder) - Method in interface com.vonage.client.auth.AuthMethod
Apply the authentication to the header as basic authentication.
applyAsBasicAuth(RequestBuilder) - Method in class com.vonage.client.auth.TokenAuthMethod
 
applyAsJsonProperties(RequestBuilder) - Method in interface com.vonage.client.auth.AuthMethod
Apply the authentication by adding it to the entity payload.
applyAsJsonProperties(RequestBuilder) - Method in class com.vonage.client.auth.TokenAuthMethod
 
applyAuth(RequestBuilder) - Method in class com.vonage.client.AbstractMethod
Apply an appropriate authentication method (specified by AbstractMethod.getAcceptableAuthMethods()) to the provided RequestBuilder, and return the result.
applyAuth(RequestBuilder) - Method in class com.vonage.client.DynamicEndpoint
 
applyBasicAuth - Variable in class com.vonage.client.DynamicEndpoint
 
AR - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Arabic
ARABIC - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ARABIC - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
ARABIC_ALGERIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_ARABIAN_PENINSULA - Enum constant in enum class com.vonage.client.verify2.Locale
 
ARABIC_BAHRAIN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_EGYPT - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_IRAQ - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_ISRAEL - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_JORDAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_KUWAIT - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_LEBANON - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_MOROCCO - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_OMAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_QATAR - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_SAUDI_ARABIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_STATE_OF_PALESTINE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_TUNISIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARABIC_UNITED_ARAB_EMIRATES - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ARMENIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ASC - Enum constant in enum class com.vonage.client.proactiveconnect.SortOrder
Ascending
ASC - Enum constant in enum class com.vonage.client.users.ListUsersRequest.SortOrder
Ascending
ASCENDING - Enum constant in enum class com.vonage.client.voice.CallOrder
 
ASSUMED_NOT_PORTED - Enum constant in enum class com.vonage.client.insight.PortedStatus
 
ASSUMED_PORTED - Enum constant in enum class com.vonage.client.insight.PortedStatus
 
async - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
async(boolean) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
attributes(ListAttribute...) - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Sets the list attributes.
attributes(List<ListAttribute>) - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Sets the list attributes.
audio - Variable in class com.vonage.client.messages.InboundMessage
 
AUDIO - Enum constant in enum class com.vonage.client.messages.MessageType
 
AUDIO_L16_16K - Enum constant in enum class com.vonage.client.users.channels.Websocket.ContentType
audio/l16 with bitrate of 16000.
AUDIO_L16_8K - Enum constant in enum class com.vonage.client.users.channels.Websocket.ContentType
audio/l16 with bitrate of 8000.
AUSTRALIAN_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
AuthCollection - Class in com.vonage.client.auth
Internal class, managing a collection of AuthMethods.
AuthCollection() - Constructor for class com.vonage.client.auth.AuthCollection
Create a new AuthCollection with an empty set of AuthMethods.
AuthCollection(AuthMethod...) - Constructor for class com.vonage.client.auth.AuthCollection
 
AuthCollection(SortedSet<AuthMethod>) - Constructor for class com.vonage.client.auth.AuthCollection
 
authMethod(Class<? extends AuthMethod>, Class<? extends AuthMethod>...) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
AuthMethod - Interface in com.vonage.client.auth
 
authMethods - Variable in class com.vonage.client.DynamicEndpoint
 
autoRecord(boolean) - Method in class com.vonage.client.meetings.RecordingOptions.Builder
 
availableFeatures(AvailableFeatures) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Available features for this meeting.
availableFeatures(AvailableFeatures) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
AvailableFeatures - Class in com.vonage.client.meetings
 
AvailableFeatures() - Constructor for class com.vonage.client.meetings.AvailableFeatures
 
AvailableFeatures.Builder - Class in com.vonage.client.meetings
 
AvailableNumber - Class in com.vonage.client.numbers
 
AvailableNumber() - Constructor for class com.vonage.client.numbers.AvailableNumber
 
AZERBAIJANI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
AZERBAIJANI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 

B

BAD_NUMBER - Enum constant in enum class com.vonage.client.insight.Reachability
 
BalanceResponse - Class in com.vonage.client.account
 
BalanceResponse() - Constructor for class com.vonage.client.account.BalanceResponse
 
BalanceResponse(double, boolean) - Constructor for class com.vonage.client.account.BalanceResponse
Deprecated.
bargeIn(Boolean) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
bargeIn(Boolean) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
BaseInsightRequest - Class in com.vonage.client.insight
 
BaseInsightRequest(String, String) - Constructor for class com.vonage.client.insight.BaseInsightRequest
 
BaseRequest - Class in com.vonage.client.verify
Base request class for VerifyRequest and Psd2Request.
BaseRequest(String, Integer, Locale, String, Integer, Integer) - Constructor for class com.vonage.client.verify.BaseRequest
 
BaseResult - Class in com.vonage.client.verify
Deprecated.
This class isn't used anywhere in the codebase and will be removed.
BaseResult(int, String, boolean) - Constructor for class com.vonage.client.verify.BaseResult
Deprecated.
 
baseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
 
BaseUser - Class in com.vonage.client.users
Represents the main attributes of a User.
BasicInsightRequest - Class in com.vonage.client.insight
 
BasicInsightRequest.Builder - Class in com.vonage.client.insight
 
BasicInsightResponse - Class in com.vonage.client.insight
Response object constructed from the JSON payload returned for Basic number insight requests.
BasicInsightResponse() - Constructor for class com.vonage.client.insight.BasicInsightResponse
 
basicResponseHandler - Static variable in class com.vonage.client.AbstractMethod
 
BASQUE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
BASQUE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
beepStart(Boolean) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
beepTimeout(int) - Method in class com.vonage.client.voice.AdvancedMachineDetection.Builder
Maximum time in seconds Vonage should wait for a machine beep to be detected.
behavior(MachineDetection) - Method in class com.vonage.client.voice.AdvancedMachineDetection.Builder
Define how the system responds when a machine is detected.
BENGALI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
BENGALI_BANGLADESH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
BENGALI_INDIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
BINARY - Enum constant in enum class com.vonage.client.incoming.MessageType
 
BINARY - Enum constant in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
This is a raw binary message
BINARY - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageType
Message is a binary SMS message with a custom UDH and binary payload
BinaryMessage - Class in com.vonage.client.sms.messages
A binary message to be submitted via the Vonage SMS API.
BinaryMessage(String, String, byte[], byte[]) - Constructor for class com.vonage.client.sms.messages.BinaryMessage
Instantiate a new binary sms message request.
BinaryRequest - Interface in com.vonage.client
Indicates that a class used for request is to be serialised as binary data (e.g.
BLACKLISTED - Enum constant in enum class com.vonage.client.insight.Reachability
 
bodyText(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
(REQUIRED) The main message text.
bodyText(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest.Builder
(OPTIONAL) The main message text.
brand - Variable in class com.vonage.client.verify2.VerificationRequest
 
brand(String) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(REQUIRED) The brand that is sending the verification request.
brandText(String) - Method in class com.vonage.client.meetings.Theme.Builder
(REQUIRED) The brand / logo text.
BRAZILIAN_PORTUGUESE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
build() - Method in class com.vonage.client.application.Application.Builder
Builds the Application object.
build() - Method in class com.vonage.client.application.capabilities.Messages.Builder
Builds the Messages object.
build() - Method in class com.vonage.client.application.capabilities.Rtc.Builder
Builds the Rtc object.
build() - Method in class com.vonage.client.application.capabilities.Vbc.Builder
Builds the Vbc object.
build() - Method in class com.vonage.client.application.capabilities.Voice.Builder
Builds the Voice object.
build() - Method in class com.vonage.client.application.ListApplicationRequest.Builder
 
build() - Method in class com.vonage.client.common.Webhook.Builder
Builds the Webhook object.
build() - Method in class com.vonage.client.DynamicEndpoint.Builder
 
build() - Method in class com.vonage.client.HttpConfig.Builder
 
build() - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
build() - Method in class com.vonage.client.insight.BasicInsightRequest.Builder
 
build() - Method in class com.vonage.client.insight.StandardInsightRequest.Builder
 
build() - Method in class com.vonage.client.meetings.AvailableFeatures.Builder
Builds the AvailableFeatures.
build() - Method in class com.vonage.client.meetings.CallbackUrls.Builder
Builds the CallbackUrls.
build() - Method in class com.vonage.client.meetings.InitialJoinOptions.Builder
Builds the InitialJoinOptions.
build() - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Builds the MeetingRoom.
build() - Method in class com.vonage.client.meetings.RecordingOptions.Builder
Builds the RecordingOptions.
build() - Method in class com.vonage.client.meetings.Theme.Builder
Builds the Theme.
build() - Method in class com.vonage.client.meetings.UISettings.Builder
Builds the UISettings.
build() - Method in class com.vonage.client.meetings.UpdateApplicationRequest.Builder
build() - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
Builds the UpdateRoomRequest.
build() - Method in class com.vonage.client.messages.MessageRequest.Builder
Builds the MessageRequest.
build() - Method in class com.vonage.client.messages.messenger.MessengerAudioRequest.Builder
 
build() - Method in class com.vonage.client.messages.messenger.MessengerFileRequest.Builder
 
build() - Method in class com.vonage.client.messages.messenger.MessengerImageRequest.Builder
 
build() - Method in class com.vonage.client.messages.messenger.MessengerTextRequest.Builder
 
build() - Method in class com.vonage.client.messages.messenger.MessengerVideoRequest.Builder
 
build() - Method in class com.vonage.client.messages.mms.MmsAudioRequest.Builder
 
build() - Method in class com.vonage.client.messages.mms.MmsImageRequest.Builder
 
build() - Method in class com.vonage.client.messages.mms.MmsVcardRequest.Builder
 
build() - Method in class com.vonage.client.messages.mms.MmsVideoRequest.Builder
 
build() - Method in class com.vonage.client.messages.sms.SmsTextRequest.Builder
 
build() - Method in class com.vonage.client.messages.viber.ViberFileRequest.Builder
 
build() - Method in class com.vonage.client.messages.viber.ViberImageRequest.Builder
 
build() - Method in class com.vonage.client.messages.viber.ViberTextRequest.Builder
 
build() - Method in class com.vonage.client.messages.viber.ViberVideoRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappAudioRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappCustomRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappFileRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappImageRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappStickerRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappTextRequest.Builder
 
build() - Method in class com.vonage.client.messages.whatsapp.WhatsappVideoRequest.Builder
 
build() - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Builds the ContactsList.
build() - Method in class com.vonage.client.proactiveconnect.ListAttribute.Builder
Builds the list attribute object.
build() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Builds the ListEventsFilter.
build() - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest.Builder
build() - Method in class com.vonage.client.subaccounts.ListTransfersFilter.Builder
build() - Method in class com.vonage.client.subaccounts.MoneyTransfer.Builder
Builds the MoneyTransfer.
build() - Method in class com.vonage.client.subaccounts.NumberTransfer.Builder
Builds the NumberTransfer.
build() - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest.Builder
build() - Method in class com.vonage.client.users.ListUsersRequest.Builder
Builds the request.
build() - Method in class com.vonage.client.users.User.Builder
Builds the Application object.
build() - Method in class com.vonage.client.verify.Psd2Request.Builder
 
build() - Method in class com.vonage.client.verify.VerifyRequest.Builder
Builds the VerifyRequest.
build() - Method in class com.vonage.client.verify2.VerificationRequest.Builder
Constructs a VerificationRequest with this builder's properties.
build() - Method in class com.vonage.client.voice.AdvancedMachineDetection.Builder
Constructs the AdvancedMachineDetection object.
build() - Method in class com.vonage.client.voice.Call.Builder
Builds the Call object with this builder's properties.
build() - Method in class com.vonage.client.voice.CallsFilter.Builder
Constructs an instance of CallsFilter.
build() - Method in class com.vonage.client.voice.ncco.AppEndpoint.Builder
Builds the AppEndpoint.
build() - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Builds the ConnectAction.
build() - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
build() - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
build() - Method in class com.vonage.client.voice.ncco.NotifyAction.Builder
 
build() - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
Builds the PayAction object with this builder's fields.
build() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
Builds the PaymentPrompt object with this builder's fields..
build() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.Builder
 
build() - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
build() - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
 
build() - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
build() - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
build() - Method in class com.vonage.client.voice.ncco.VbcEndpoint.Builder
Builds the VbcEndpoint with this builder's properties.
build() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
build() - Method in class com.vonage.client.voice.TalkPayload.Builder
Constructs the TalkPayload object.
build() - Method in class com.vonage.client.VonageClient.Builder
 
builder() - Static method in class com.vonage.client.application.Application
Entry point for creating an instance of this class.
builder() - Static method in class com.vonage.client.application.capabilities.Messages
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.application.capabilities.Rtc
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.application.capabilities.Vbc
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.application.capabilities.Voice
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.application.ListApplicationRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.common.Webhook
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.HttpConfig
 
builder() - Static method in class com.vonage.client.insight.AdvancedInsightRequest
This method is the starting point for constructing an Advanced Insight Note that the number field must be set.
builder() - Static method in class com.vonage.client.insight.BasicInsightRequest
This method is the starting point for constructing a Basic Insight request.
builder() - Static method in class com.vonage.client.insight.StandardInsightRequest
This method is the starting point for constructing a Standard Insight request.
builder() - Static method in class com.vonage.client.meetings.AvailableFeatures
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.CallbackUrls
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.InitialJoinOptions
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.RecordingOptions
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.Theme
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.UISettings
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.UpdateApplicationRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.meetings.UpdateRoomRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.messages.messenger.MessengerAudioRequest
 
builder() - Static method in class com.vonage.client.messages.messenger.MessengerFileRequest
 
builder() - Static method in class com.vonage.client.messages.messenger.MessengerImageRequest
 
builder() - Static method in class com.vonage.client.messages.messenger.MessengerTextRequest
 
builder() - Static method in class com.vonage.client.messages.messenger.MessengerVideoRequest
 
builder() - Static method in class com.vonage.client.messages.mms.MmsAudioRequest
 
builder() - Static method in class com.vonage.client.messages.mms.MmsImageRequest
 
builder() - Static method in class com.vonage.client.messages.mms.MmsVcardRequest
 
builder() - Static method in class com.vonage.client.messages.mms.MmsVideoRequest
 
builder() - Static method in class com.vonage.client.messages.sms.SmsTextRequest
 
builder() - Static method in class com.vonage.client.messages.viber.ViberFileRequest
 
builder() - Static method in class com.vonage.client.messages.viber.ViberImageRequest
 
builder() - Static method in class com.vonage.client.messages.viber.ViberTextRequest
 
builder() - Static method in class com.vonage.client.messages.viber.ViberVideoRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappAudioRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappCustomRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappFileRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappImageRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappStickerRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappTextRequest
 
builder() - Static method in class com.vonage.client.messages.whatsapp.WhatsappVideoRequest
 
builder() - Static method in class com.vonage.client.proactiveconnect.ListAttribute
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.proactiveconnect.ListEventsFilter
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.subaccounts.CreateSubaccountRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.subaccounts.ListTransfersFilter
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.subaccounts.MoneyTransfer
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.subaccounts.NumberTransfer
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.users.ListUsersRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.users.User
Entry point for creating an instance of this class.
builder() - Static method in class com.vonage.client.verify.Psd2Request
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.verify2.VerificationRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.AdvancedMachineDetection
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.Call
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.CallsFilter
 
builder() - Static method in class com.vonage.client.voice.ncco.InputAction
 
builder() - Static method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
Entry point for constructing a PayAction.
builder() - Static method in class com.vonage.client.voice.ncco.RecordAction
 
builder() - Static method in class com.vonage.client.VonageClient
Entry point for constructing an instance of this class.
builder(Application) - Static method in class com.vonage.client.application.Application
Copy an application to a new builder to modify into a new application object.
builder(Endpoint...) - Static method in class com.vonage.client.voice.ncco.ConnectAction
Entry point for constructing an instance of this class.
builder(PaymentPrompt.Type) - Static method in class com.vonage.client.voice.ncco.PaymentPrompt
Deprecated.
Entry point for constructing a PaymentPrompt.
builder(Class<R>) - Static method in class com.vonage.client.DynamicEndpoint
 
builder(String) - Static method in class com.vonage.client.insight.AdvancedInsightRequest
This method is the starting point for constructing an Advanced Insight
builder(String) - Static method in class com.vonage.client.insight.BasicInsightRequest
This method is the starting point for constructing a Basic Insight request.
builder(String) - Static method in class com.vonage.client.insight.StandardInsightRequest
This method is the starting point for constructing a Standard Insight request.
builder(String) - Static method in class com.vonage.client.meetings.MeetingRoom
Entry point for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.proactiveconnect.ContactsList
Entry point for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.subaccounts.UpdateSubaccountRequest
Entry point for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.voice.ncco.AppEndpoint
Entry point for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.voice.ncco.ConversationAction
 
builder(String) - Static method in class com.vonage.client.voice.ncco.PhoneEndpoint
 
builder(String) - Static method in class com.vonage.client.voice.ncco.SipEndpoint
Entry point for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.voice.ncco.TalkAction
 
builder(String) - Static method in class com.vonage.client.voice.ncco.VbcEndpoint
Entry point for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.voice.TalkPayload
Entry point for constructing an instance of this class.
builder(String...) - Static method in class com.vonage.client.voice.ncco.StreamAction
 
builder(String, Double, String) - Static method in class com.vonage.client.verify.Psd2Request
Entry point for constructing an instance of this class, with the required parameters.
builder(String, String) - Static method in class com.vonage.client.verify.VerifyRequest
 
builder(String, String) - Static method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
builder(URI) - Static method in class com.vonage.client.voice.ncco.SipEndpoint
Entry point for constructing an instance of this class.
builder(Collection<Endpoint>) - Static method in class com.vonage.client.voice.ncco.ConnectAction
Entry point for constructing an instance of this class.
builder(Collection<String>) - Static method in class com.vonage.client.voice.ncco.StreamAction
 
builder(Map<String, ?>, String...) - Static method in class com.vonage.client.voice.ncco.NotifyAction
 
builder(Map<String, ?>, Collection<String>) - Static method in class com.vonage.client.voice.ncco.NotifyAction
 
builder(R[]) - Static method in class com.vonage.client.DynamicEndpoint
This trick enables initialisation of the builder whilst inferring the response type <R> without directly providing the class by using varargs as a parameter.
Builder() - Constructor for class com.vonage.client.application.Application.Builder
 
Builder() - Constructor for class com.vonage.client.application.capabilities.Messages.Builder
 
Builder() - Constructor for class com.vonage.client.application.capabilities.Rtc.Builder
 
Builder() - Constructor for class com.vonage.client.application.capabilities.Vbc.Builder
 
Builder() - Constructor for class com.vonage.client.application.capabilities.Voice.Builder
 
Builder() - Constructor for class com.vonage.client.application.ListApplicationRequest.Builder
 
Builder() - Constructor for class com.vonage.client.HttpConfig.Builder
 
Builder() - Constructor for class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
Builder() - Constructor for class com.vonage.client.insight.BasicInsightRequest.Builder
 
Builder() - Constructor for class com.vonage.client.insight.StandardInsightRequest.Builder
 
Builder() - Constructor for class com.vonage.client.messages.MessageRequest.Builder
Protected constructor to prevent users from explicitly creating this object.
Builder() - Constructor for class com.vonage.client.messages.messenger.MessengerRequest.Builder
 
Builder() - Constructor for class com.vonage.client.messages.mms.MmsRequest.Builder
 
Builder() - Constructor for class com.vonage.client.messages.viber.ViberRequest.Builder
 
Builder() - Constructor for class com.vonage.client.messages.whatsapp.WhatsappRequest.Builder
 
Builder() - Constructor for class com.vonage.client.voice.CallsFilter.Builder
Deprecated.
Builder() - Constructor for class com.vonage.client.VonageClient.Builder
 
Builder(Application) - Constructor for class com.vonage.client.application.Application.Builder
 
Builder(String) - Constructor for class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
Builder(String) - Constructor for class com.vonage.client.insight.BasicInsightRequest.Builder
 
Builder(String) - Constructor for class com.vonage.client.insight.StandardInsightRequest.Builder
 
Builder(String, Double, String) - Constructor for class com.vonage.client.verify.Psd2Request.Builder
 
Builder(String, String) - Constructor for class com.vonage.client.verify.VerifyRequest.Builder
 
buildHexString(byte[]) - Method in class com.vonage.client.auth.hashutils.AbstractHasher
 
BULGARIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
BULGARIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
BUSINESS - Enum constant in enum class com.vonage.client.insight.CallerType
 
BUSY - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
BUSY - Enum constant in enum class com.vonage.client.voice.CallStatus
 
buyNumber(String, String) - Method in class com.vonage.client.numbers.NumbersClient
Start renting a Vonage Virtual Number.
BuyNumberRequest - Class in com.vonage.client.numbers
 
BuyNumberRequest(String, String) - Constructor for class com.vonage.client.numbers.BuyNumberRequest
 
bytesToHex(byte[]) - Static method in class com.vonage.client.sms.HexUtil
translate a byte array of raw data into a String with a hex representation of that data
bytesToHex(byte[], String) - Static method in class com.vonage.client.sms.HexUtil
translate a byte array of raw data into a String with a hex representation of that data.

C

CA - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Catalan
cachedRequestBody - Variable in class com.vonage.client.DynamicEndpoint
 
calculate(String) - Method in class com.vonage.client.auth.hashutils.AbstractHasher
Calculates hash for string.
calculate(String, HashUtil.HashType) - Static method in class com.vonage.client.auth.hashutils.HashUtil
Calculates hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.AbstractHasher
Calculates hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacMd5Hasher
Calculates HMAC MD-5 hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha1Hasher
Calculates HMAC SHA-1 hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha256Hasher
Calculates HMAC SHA-256 hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha512Hasher
Calculates HMAC SHA-512 hash for string.
calculate(String, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.hashutils.HashUtil
Calculates hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.AbstractHasher
Calculates hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacMd5Hasher
Calculates HMAC MD-5 hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha1Hasher
Calculates HMAC SHA-1 hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha256Hasher
Calculates HMAC SHA-256 hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha512Hasher
Calculates HMAC SHA-512 hash for string.
calculate(String, String, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.hashutils.HashUtil
Calculates hash for string.
Call - Class in com.vonage.client.voice
Call encapsulates the information required to create a call using VoiceClient.createCall(Call)
Call() - Constructor for class com.vonage.client.voice.Call
Deprecated.
Call(Endpoint[], Endpoint, String) - Constructor for class com.vonage.client.voice.Call
 
Call(Endpoint[], Endpoint, Collection<? extends Action>) - Constructor for class com.vonage.client.voice.Call
 
Call(Endpoint, Endpoint, String) - Constructor for class com.vonage.client.voice.Call
 
Call(Endpoint, Endpoint, Collection<? extends Action>) - Constructor for class com.vonage.client.voice.Call
 
Call(String, String, String) - Constructor for class com.vonage.client.voice.Call
 
Call(String, String, Collection<? extends Action>) - Constructor for class com.vonage.client.voice.Call
 
Call.Builder - Class in com.vonage.client.voice
Builder for constructing a Call object.
callback - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
callback(String) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
CallbackType - Enum Class in com.vonage.client.verify2
Represents the type of webhook in VerificationCallback.getType().
callbackUrls(CallbackUrls) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Callback URLs for this meeting.
callbackUrls(CallbackUrls) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
CallbackUrls - Class in com.vonage.client.meetings
 
CallbackUrls() - Constructor for class com.vonage.client.meetings.CallbackUrls
 
CallbackUrls.Builder - Class in com.vonage.client.meetings
 
CallDirection - Enum Class in com.vonage.client.incoming
 
CallDirection - Enum Class in com.vonage.client.voice
 
CallerIdentity - Class in com.vonage.client.insight
 
CallerIdentity() - Constructor for class com.vonage.client.insight.CallerIdentity
 
CallerType - Enum Class in com.vonage.client.insight
Represents the type of the number's owner as an enum.
CallEvent - Class in com.vonage.client.incoming
 
CallEvent - Class in com.vonage.client.voice
 
CallEvent() - Constructor for class com.vonage.client.incoming.CallEvent
 
CallEvent() - Constructor for class com.vonage.client.voice.CallEvent
 
CallInfo - Class in com.vonage.client.voice
CallInfo holds the information related to a call.
CallInfo() - Constructor for class com.vonage.client.voice.CallInfo
Deprecated.
CallInfo(Endpoint, Endpoint) - Constructor for class com.vonage.client.voice.CallInfo
Deprecated.
CallInfo(String, String) - Constructor for class com.vonage.client.voice.CallInfo
Deprecated.
CallInfoPage - Class in com.vonage.client.voice
 
CallInfoPage() - Constructor for class com.vonage.client.voice.CallInfoPage
 
CallModifier - Class in com.vonage.client.voice
Deprecated.
Will be removed in next major release.
CallModifier(String, ModifyCallAction) - Constructor for class com.vonage.client.voice.CallModifier
Deprecated.
 
CallModifier(String, ModifyCallPayload) - Constructor for class com.vonage.client.voice.CallModifier
Deprecated.
 
CallOrder - Enum Class in com.vonage.client.voice
 
CallsFilter - Class in com.vonage.client.voice
 
CallsFilter.Builder - Class in com.vonage.client.voice
 
CallStatus - Enum Class in com.vonage.client.incoming
 
CallStatus - Enum Class in com.vonage.client.voice
 
CallStatusDetail - Enum Class in com.vonage.client.incoming
 
CANADIAN_FRENCH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
CANCEL - Enum constant in enum class com.vonage.client.verify.VerifyControlCommand
 
CANCELLED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
CANCELLED - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
CANCELLED - Enum constant in enum class com.vonage.client.verify.VerifyDetails.Status
The verification process was cancelled by a Verify control request.
CANCELLED - Enum constant in enum class com.vonage.client.voice.CallStatus
 
cancelNumber(String, String) - Method in class com.vonage.client.numbers.NumbersClient
Stop renting a Vonage Virtual Number.
CancelNumberRequest - Class in com.vonage.client.numbers
 
CancelNumberRequest(String, String) - Constructor for class com.vonage.client.numbers.CancelNumberRequest
 
cancelVerification(String) - Method in class com.vonage.client.verify.VerifyClient
Cancel a current verification request.
cancelVerification(UUID) - Method in class com.vonage.client.verify2.Verify2Client
Attempts to abort an active verification workflow.
CANNOT_ROUTE - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
cannot route to the number
Capabilities() - Constructor for class com.vonage.client.application.Application.Capabilities
 
Capability - Class in com.vonage.client.application.capabilities
Represents a capability of a Vonage Application
Capability() - Constructor for class com.vonage.client.application.capabilities.Capability
 
Capability.Type - Enum Class in com.vonage.client.application.capabilities
 
caption - Variable in class com.vonage.client.messages.internal.MessagePayload
 
caption(String) - Method in class com.vonage.client.messages.mms.MmsAudioRequest.Builder
(OPTIONAL) Additional text to accompany the audio.
caption(String) - Method in class com.vonage.client.messages.mms.MmsImageRequest.Builder
(OPTIONAL) Additional text to accompany the image.
caption(String) - Method in class com.vonage.client.messages.mms.MmsVideoRequest.Builder
(OPTIONAL) Additional text to accompany the video.
caption(String) - Method in class com.vonage.client.messages.viber.ViberVideoRequest.Builder
(OPTIONAL) Additional text to accompany the video.
caption(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappFileRequest.Builder
(OPTIONAL) Additional text to accompany the file.
caption(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappImageRequest.Builder
(OPTIONAL) Additional text to accompany the image.
caption(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappVideoRequest.Builder
(OPTIONAL) Additional text to accompany the video.
CARD_NUMBER - Enum constant in enum class com.vonage.client.voice.ncco.PaymentPrompt.Type
Deprecated.
 
CARRIER_TIMEOUT - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Carrier timed out
CarrierDetails - Class in com.vonage.client.insight
 
CarrierDetails() - Constructor for class com.vonage.client.insight.CarrierDetails
 
CarrierDetails.NetworkType - Enum Class in com.vonage.client.insight
Enum representing the type of network that the number is associated with.
CATALAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
CATALAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
catalogId(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
(REQUIRED) ID for the catalog you want to use for this message.
catalogId(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest.Builder
(REQUIRED) ID for the catalog you want to use for this message.
category - Variable in class com.vonage.client.messages.messenger.MessengerRequest.Builder
 
category - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
category(Category) - Method in class com.vonage.client.messages.messenger.MessengerRequest.Builder
(OPTIONAL) The use of different category tags enables the business to send messages for different use cases.
category(Category) - Method in class com.vonage.client.messages.viber.ViberRequest.Builder
(OPTIONAL) Sets the category tag of the message.
Category - Enum Class in com.vonage.client.messages.messenger
See the Facebook documentation for details on what these mean.
Category - Enum Class in com.vonage.client.messages.viber
The use of different category tags enables the business to send messages for different use cases.
channel - Variable in class com.vonage.client.messages.InboundMessage
 
channel - Variable in class com.vonage.client.messages.MessageStatus
 
channel - Variable in class com.vonage.client.verify2.VerificationCallback
 
channel - Variable in class com.vonage.client.verify2.Workflow
 
channel - Variable in class com.vonage.client.verify2.WorkflowStatus
 
Channel - Class in com.vonage.client.users.channels
Base class for channels.
Channel - Enum Class in com.vonage.client.messages
Represents the services available for sending messages.
Channel - Enum Class in com.vonage.client.verify2
Represents the verification channel type in a Workflow.
Channel() - Constructor for class com.vonage.client.users.channels.Channel
 
channels(Channel...) - Method in class com.vonage.client.users.User.Builder
Sets the communication channels for this user.
channels(Integer) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
channels(Collection<? extends Channel>) - Method in class com.vonage.client.users.User.Builder
Sets the communication channels for this user.
Channels - Class in com.vonage.client.users.channels
Represents the "channels" field on User.
Channels(Collection<? extends Channel>) - Constructor for class com.vonage.client.users.channels.Channels
Creates a new Channels object and assigns the specified channels to the appropriate fields based on their type.
channelTimeout - Variable in class com.vonage.client.verify2.VerificationCallback
 
channelTimeout - Variable in class com.vonage.client.verify2.VerificationRequest
 
channelTimeout(int) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) Specifies the wait time in seconds between attempts to delivery the verification code between workflows.
check(CheckRequest) - Method in class com.vonage.client.verify.VerifyClient
Validate a code provided by a user in response to a call from VerifyClient.verify.
check(String, String) - Method in class com.vonage.client.verify.VerifyClient
Validate a code provided by a user in response to a call from VerifyClient.verify.
check(String, String, String) - Method in class com.vonage.client.verify.VerifyClient
Deprecated.
ipAddress is no longer used and will be removed in the next major release. Please use VerifyClient.check(String, String)
CheckRequest - Class in com.vonage.client.verify
 
CheckRequest(String, String) - Constructor for class com.vonage.client.verify.CheckRequest
 
CheckRequest(String, String, String) - Constructor for class com.vonage.client.verify.CheckRequest
Deprecated.
CheckResponse - Class in com.vonage.client.verify
 
CheckResponse(VerifyStatus) - Constructor for class com.vonage.client.verify.CheckResponse
 
checkUrl - Variable in class com.vonage.client.verify2.VerificationResponse
 
checkVerificationCode(UUID, String) - Method in class com.vonage.client.verify2.Verify2Client
Check a supplied code against an existing verification request.
CHINESE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
CHINESE_CHINA - Enum constant in enum class com.vonage.client.verify2.Locale
 
CHINESE_CHN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
CHINESE_HKG - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
CHINESE_MANDARIN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
CHINESE_TAI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
CHINESE_TAIWAN - Enum constant in enum class com.vonage.client.verify2.Locale
 
CHINESE_YUE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
CLASS_0 - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageClass
Message Class 0
CLASS_1 - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageClass
Message Class 1
CLASS_2 - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageClass
Message Class 2
CLASS_3 - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageClass
Message Class 3
clean(String) - Static method in class com.vonage.client.auth.RequestSigning
 
CLEARING - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
clearList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Delete all items in a list.
clientRef - Variable in class com.vonage.client.messages.InboundMessage
 
clientRef - Variable in class com.vonage.client.messages.MessageRequest.Builder
 
clientRef - Variable in class com.vonage.client.messages.MessageStatus
 
clientRef - Variable in class com.vonage.client.verify2.VerificationCallback
 
clientRef - Variable in class com.vonage.client.verify2.VerificationRequest
 
clientRef(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(OPTIONAL) Sets the client reference, which will be present in every message status.
clientRef(String) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) If this reference is set when the request is sent, it will be included in the callbacks.
cnam - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
cnam - Variable in class com.vonage.client.insight.StandardInsightRequest.Builder
 
cnam(boolean) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
cnam(Boolean) - Method in class com.vonage.client.insight.StandardInsightRequest.Builder
 
code - Variable in class com.vonage.client.verify2.VerificationRequest
 
code - Variable in exception com.vonage.client.VonageApiResponseException
 
code(String) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) An optional alphanumeric custom code to use, if you don't want Vonage to generate the code.
codeLength - Variable in class com.vonage.client.verify2.VerificationRequest
 
codeLength(int) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) Length of the code to send to the user, must be between 4 and 10 (inclusive).
COLORED - Enum constant in enum class com.vonage.client.meetings.LogoType
 
com.vonage.client - package com.vonage.client
The root of the Vonage client library, containing VonageClient class, which is probably what you want.
com.vonage.client.account - package com.vonage.client.account
 
com.vonage.client.application - package com.vonage.client.application
Implementation of the Application API.
com.vonage.client.application.capabilities - package com.vonage.client.application.capabilities
 
com.vonage.client.auth - package com.vonage.client.auth
Provides support for the various authentication methods supported by different Vonage APIs.
com.vonage.client.auth.hashutils - package com.vonage.client.auth.hashutils
 
com.vonage.client.common - package com.vonage.client.common
 
com.vonage.client.conversion - package com.vonage.client.conversion
 
com.vonage.client.incoming - package com.vonage.client.incoming
 
com.vonage.client.insight - package com.vonage.client.insight
 
com.vonage.client.legacyutils - package com.vonage.client.legacyutils
 
com.vonage.client.logging - package com.vonage.client.logging
 
com.vonage.client.meetings - package com.vonage.client.meetings
This package contains classes and sub-packages to support usage of the Meetings API.
com.vonage.client.messages - package com.vonage.client.messages
This package contains classes and sub-packages to support usage of the Vonage Messages API.
com.vonage.client.messages.internal - package com.vonage.client.messages.internal
 
com.vonage.client.messages.messenger - package com.vonage.client.messages.messenger
 
com.vonage.client.messages.mms - package com.vonage.client.messages.mms
 
com.vonage.client.messages.sms - package com.vonage.client.messages.sms
 
com.vonage.client.messages.viber - package com.vonage.client.messages.viber
 
com.vonage.client.messages.whatsapp - package com.vonage.client.messages.whatsapp
 
com.vonage.client.numbers - package com.vonage.client.numbers
 
com.vonage.client.proactiveconnect - package com.vonage.client.proactiveconnect
This package contains classes and sub-packages to support usage of the Vonage Proactive Connect API.
com.vonage.client.redact - package com.vonage.client.redact
 
com.vonage.client.sms - package com.vonage.client.sms
 
com.vonage.client.sms.callback - package com.vonage.client.sms.callback
 
com.vonage.client.sms.callback.messages - package com.vonage.client.sms.callback.messages
 
com.vonage.client.sms.messages - package com.vonage.client.sms.messages
 
com.vonage.client.sns - package com.vonage.client.sns
 
com.vonage.client.sns.request - package com.vonage.client.sns.request
 
com.vonage.client.sns.response - package com.vonage.client.sns.response
 
com.vonage.client.subaccounts - package com.vonage.client.subaccounts
Implementation of the Subaccounts API.
com.vonage.client.users - package com.vonage.client.users
This package contains classes and sub-packages to support usage of the Vonage Users API.

com.vonage.client.users.channels - package com.vonage.client.users.channels
 
com.vonage.client.verify - package com.vonage.client.verify
 
com.vonage.client.verify2 - package com.vonage.client.verify2
Implementation of the Verify v2 API.
com.vonage.client.voice - package com.vonage.client.voice
Implementation of the Vonage Voice API.
com.vonage.client.voice.ncco - package com.vonage.client.voice.ncco
Provides useful NCCO classes which can be serialized using Jackson when implementing webhooks to drive the Vonage Voice API.
com.vonage.client.voice.servlet - package com.vonage.client.voice.servlet
Provides an abstract Servlet for building NCCO webhooks for the Vonage Voice API.
COMMS_FAILURE - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
COMMS_FAILURE - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Deprecated.
This value is no longer used / returned by the API.
compareTo(AuthMethod) - Method in interface com.vonage.client.auth.AuthMethod
 
COMPLETED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
COMPLETED - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
COMPLETED - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
Completed.
COMPLETED - Enum constant in enum class com.vonage.client.voice.CallStatus
 
CONFIGURED - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
CONFIRMED_EVENT_UPDATE - Enum constant in enum class com.vonage.client.messages.messenger.Tag
 
ConnectAction - Class in com.vonage.client.voice.ncco
An NCCO connect action that allows for the establishment of a connection to various Endpoint.
ConnectAction.Builder - Class in com.vonage.client.voice.ncco
 
connectionTimeout(int) - Method in class com.vonage.client.common.Webhook.Builder
(OPTIONAL) If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint.
constructSignatureForRequestParameters(List<NameValuePair>, String) - Static method in class com.vonage.client.auth.RequestSigning
Signs a set of request parameters.
constructSignatureForRequestParameters(List<NameValuePair>, String, long) - Static method in class com.vonage.client.auth.RequestSigning
Signs a set of request parameters.
constructSignatureForRequestParameters(List<NameValuePair>, String, long, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
Signs a set of request parameters.
constructSignatureForRequestParameters(List<NameValuePair>, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
Signs a set of request parameters.
consume(MO) - Method in class com.vonage.client.sms.callback.AbstractMOServlet
Deprecated.
This method is asynchronously passed a complete MO instance to be dealt with by your application logic
consumer - Variable in class com.vonage.client.sms.callback.AbstractMOServlet
Deprecated.
 
CONSUMER - Enum constant in enum class com.vonage.client.insight.CallerType
 
ContactsList - Class in com.vonage.client.proactiveconnect
Represents a Proactive Connect list.
ContactsList.Builder - Class in com.vonage.client.proactiveconnect
 
contentType - Variable in class com.vonage.client.DynamicEndpoint
 
contentType(String) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
contentTypeHeader(String) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
Context - Class in com.vonage.client.messages.whatsapp
This is only present for the Inbound Message where the user is quoting another message.
CONTINUE - Enum constant in enum class com.vonage.client.voice.MachineDetection
 
ControlRequest - Class in com.vonage.client.verify
 
ControlRequest(String, VerifyControlCommand) - Constructor for class com.vonage.client.verify.ControlRequest
 
ControlResponse - Class in com.vonage.client.verify
 
ControlResponse(String, VerifyControlCommand) - Constructor for class com.vonage.client.verify.ControlResponse
 
CONVERSATION - Enum constant in enum class com.vonage.client.voice.ncco.SplitRecording
 
ConversationAction - Class in com.vonage.client.voice.ncco
An NCCO conversation action which enables the ability to host conference calls.
ConversationAction.Builder - Class in com.vonage.client.voice.ncco
 
conversationsTtl(int) - Method in class com.vonage.client.application.capabilities.Voice.Builder
The length of time named conversations will remain active for after creation, in hours.
conversationUuid(String) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
ConversionClient - Class in com.vonage.client.conversion
A client for talking to the Vonage Conversion API.
ConversionClient(HttpWrapper) - Constructor for class com.vonage.client.conversion.ConversionClient
 
ConversionRequest - Class in com.vonage.client.conversion
 
ConversionRequest(ConversionRequest.Type, String, boolean, Date) - Constructor for class com.vonage.client.conversion.ConversionRequest
 
ConversionRequest.Type - Enum Class in com.vonage.client.conversion
 
country - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
country - Variable in class com.vonage.client.insight.BaseInsightRequest
 
country - Variable in class com.vonage.client.insight.BasicInsightRequest.Builder
 
country - Variable in class com.vonage.client.insight.StandardInsightRequest.Builder
 
country(String) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
country(String) - Method in class com.vonage.client.insight.BasicInsightRequest.Builder
 
country(String) - Method in class com.vonage.client.insight.StandardInsightRequest.Builder
 
country(String) - Method in class com.vonage.client.subaccounts.NumberTransfer.Builder
(REQUIRED) Country the number is registered in, in ISO 3166-1 alpha-2 format.
country(String) - Method in class com.vonage.client.verify.Psd2Request.Builder
The country for the destination phone number.
country(String) - Method in class com.vonage.client.verify.VerifyRequest.Builder
The country for the destination phone number.
Country - Class in com.vonage.client.account
 
Country() - Constructor for class com.vonage.client.account.Country
 
createApplication(Application) - Method in class com.vonage.client.application.ApplicationClient
Create a new application.
createCall(Call) - Method in class com.vonage.client.voice.VoiceClient
Begin a call to a phone number.
createDefaultObjectMapper() - Static method in interface com.vonage.client.Jsonable
 
createHttpClient() - Method in class com.vonage.client.HttpWrapper
 
createList(ContactsList) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Create a new list.
createListItem(UUID, Map<String, ?>) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Create a new list item.
createRoom(MeetingRoom) - Method in class com.vonage.client.meetings.MeetingsClient
Create a new room.
createSecret(String) - Method in class com.vonage.client.account.AccountClient
Create a secret to be used with this account's main API key.
createSecret(String, String) - Method in class com.vonage.client.account.AccountClient
Create a secret to be used with a specific API key.
createSubaccount(CreateSubaccountRequest) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Create a new subaccount under this API primary account.
CreateSubaccountRequest - Class in com.vonage.client.subaccounts
 
CreateSubaccountRequest.Builder - Class in com.vonage.client.subaccounts
 
createTheme(Theme) - Method in class com.vonage.client.meetings.MeetingsClient
Create a new theme.
createUser(User) - Method in class com.vonage.client.users.UsersClient
Create a new user.
CROATIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
CROATIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
currency(String) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
currency(Currency) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
cursor(URI) - Method in class com.vonage.client.users.ListUsersRequest.Builder
The cursor to start returning results from.
You are not expected to provide this manually.
custom(Map<?, ?>) - Method in class com.vonage.client.messages.whatsapp.WhatsappCustomRequest.Builder
(OPTIONAL) A custom payload, which is passed directly to WhatsApp for certain features such as templates and interactive messages.
CUSTOM - Enum constant in enum class com.vonage.client.messages.MessageType
 
customData(Map<String, ?>) - Method in class com.vonage.client.users.User.Builder
Arbitrary freeform data to associate with the user.
CUSTOMER_FEEDBACK - Enum constant in enum class com.vonage.client.messages.messenger.Tag
 
CZECH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
CZECH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
CZECH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
CZECH_CZECH_REPUBLIC - Enum constant in enum class com.vonage.client.verify2.Locale
 

D

DANISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
DANISH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
DANISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
datasource(Datasource) - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Sets the datasource.
Datasource - Class in com.vonage.client.proactiveconnect
Base class for datasource types used in Proactive Connect lists.
Datasource(String) - Constructor for class com.vonage.client.proactiveconnect.Datasource
 
dateEnd(Date) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
dateStart(Date) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
DE - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
German
DECLINED - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
call rejected by callee
DEFAULT - Enum constant in enum class com.vonage.client.meetings.MicrophoneState
 
defaultConfig() - Static method in class com.vonage.client.HttpConfig
 
defaultThemeId(UUID) - Method in class com.vonage.client.meetings.UpdateApplicationRequest.Builder
 
DELETE - Enum constant in enum class com.vonage.client.common.HttpMethod
 
deleteApplication(String) - Method in class com.vonage.client.application.ApplicationClient
Delete an application.
deleteList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Delete a list.
deleteListItem(UUID, UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Delete a list item.
deleteRecording(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Delete a recording.
deleteTheme(UUID, boolean) - Method in class com.vonage.client.meetings.MeetingsClient
Delete a theme by its ID.
deleteUser(String) - Method in class com.vonage.client.users.UsersClient
Delete a user.
DELIVERED - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
DESC - Enum constant in enum class com.vonage.client.proactiveconnect.SortOrder
Descending
DESC - Enum constant in enum class com.vonage.client.users.ListUsersRequest.SortOrder
Descending
DESCENDING - Enum constant in enum class com.vonage.client.voice.CallOrder
 
description(String) - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Sets the resource description.
deserialize(JsonParser, DeserializationContext) - Method in class com.vonage.client.insight.RoamingDeseriazlizer
 
detail - Variable in exception com.vonage.client.VonageApiResponseException
 
DETECT - Enum constant in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
Detect machine and send a status human / machine webhook.
DETECT_BEEP - Enum constant in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
Detect machine and send back a status human / machine webhook, but also when machine is detected, attempt to detect voice mail beep and send back another status machine webhook with sub_state: beep_start.
DETERMINISTIC - Enum constant in enum class com.vonage.client.messages.whatsapp.Policy
 
DialInNumber - Class in com.vonage.client.meetings
Details about a number that that can be used to dial into a meeting.
DialInNumber() - Constructor for class com.vonage.client.meetings.DialInNumber
 
displayName(String) - Method in class com.vonage.client.users.User.Builder
Set the display name for the user.
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.vonage.client.sms.callback.AbstractMOServlet
Deprecated.
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.vonage.client.voice.servlet.AbstractAnswerServlet
Deprecated.
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class com.vonage.client.sms.callback.AbstractMOServlet
Deprecated.
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class com.vonage.client.voice.servlet.AbstractAnswerServlet
Deprecated.
 
downloadListItems(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Download all items in a list in CSV format.
downloadListItems(UUID, Path) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Download all items in a list in CSV format.
downloadRecording(String) - Method in class com.vonage.client.voice.VoiceClient
Download a recording, given the recordingUrl provided from the webhook callback.
dtmf(DtmfSettings) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
dtmfAnswer(String) - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.Builder
 
DtmfResponse - Class in com.vonage.client.voice
Response if DTMF tones were successfully sent to an active Call.
DtmfResponse() - Constructor for class com.vonage.client.voice.DtmfResponse
 
DtmfResult - Class in com.vonage.client.incoming
 
DtmfResult() - Constructor for class com.vonage.client.incoming.DtmfResult
 
DtmfSettings - Class in com.vonage.client.voice.ncco
DTMF(Dial Tone Multi Frequency) settings for Input Actions that will be added to a NCCO object.
DtmfSettings() - Constructor for class com.vonage.client.voice.ncco.DtmfSettings
 
duration - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
duration(int) - Method in class com.vonage.client.messages.viber.ViberVideoRequest.Builder
(REQUIRED) Length of the video in seconds.
DUTCH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
DUTCH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
DUTCH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
DUTCH_NETHERLANDS - Enum constant in enum class com.vonage.client.verify2.Locale
 
DynamicEndpoint<T,R> - Class in com.vonage.client
Enables convenient declaration of endpoints without directly implementing AbstractMethod.
DynamicEndpoint(DynamicEndpoint.Builder<T, R>) - Constructor for class com.vonage.client.DynamicEndpoint
 
DynamicEndpoint.Builder<T,R> - Class in com.vonage.client
 

E

E164 - Class in com.vonage.client.common
Utility class for validating and sanitising phone numbers to be compliant with the E164 format.
E164(String) - Constructor for class com.vonage.client.common.E164
 
EARMUFF - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
EMAIL - Enum constant in enum class com.vonage.client.verify2.Channel
E-mail text message.
EmailWorkflow - Class in com.vonage.client.verify2
Defines properties for sending a verification code to a user via e-mail.
EmailWorkflow(String) - Constructor for class com.vonage.client.verify2.EmailWorkflow
Constructs a new e-mail verification workflow.
EmailWorkflow(String, String) - Constructor for class com.vonage.client.verify2.EmailWorkflow
Constructs a new e-mail verification workflow with a custom sender address.
EmbeddedCalls - Class in com.vonage.client.voice
 
EmbeddedCalls() - Constructor for class com.vonage.client.voice.EmbeddedCalls
 
EN - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
English
END_ON_SILENCE_TIMEOUT - Enum constant in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
 
endDate(Instant) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
ISO-8601 formatted date for when to end events filter.
endDate(Instant) - Method in class com.vonage.client.subaccounts.ListTransfersFilter.Builder
(OPTIONAL) End of the retrieval period.
endOnExit(Boolean) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
endOnKey(Character) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
endOnSilence(Integer) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
endpoint(Endpoint...) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Connect the call to a specific Endpoint.
endpoint(Collection<Endpoint>) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Connect the call to a specific Endpoint.
Endpoint - Interface in com.vonage.client.voice
 
Endpoint - Interface in com.vonage.client.voice.ncco
An endpoint for a ConnectAction to connect to.
ENDS_WITH - Enum constant in enum class com.vonage.client.numbers.SearchPattern
 
ENGLISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ENGLISH_AUSTRALIA - Enum constant in enum class com.vonage.client.verify2.Locale
 
ENGLISH_AUSTRALIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_CANADA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_GHANA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_INDIA - Enum constant in enum class com.vonage.client.verify2.Locale
 
ENGLISH_INDIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_IRELAND - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_KENYA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_NEW_ZEALAND - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_NIGERIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_PHILIPPINES - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_SOUTH_AFRICA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_TANZANIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_UK - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ENGLISH_UK - Enum constant in enum class com.vonage.client.verify2.Locale
 
ENGLISH_UNITED_KINGDOM - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_UNITED_STATES - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ENGLISH_US - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ENGLISH_US - Enum constant in enum class com.vonage.client.verify2.Locale
 
equals(Object) - Method in class com.vonage.client.messages.MessageStatus
 
equals(Object) - Method in class com.vonage.client.messages.MessageStatus.Error
 
equals(Object) - Method in class com.vonage.client.messages.MessageStatus.Usage
 
equals(Object) - Method in class com.vonage.client.users.BaseUser
 
equals(Object) - Method in class com.vonage.client.users.channels.Channels
 
equals(Object) - Method in class com.vonage.client.users.channels.Messenger
 
equals(Object) - Method in class com.vonage.client.users.channels.Whatsapp
 
equals(Object) - Method in class com.vonage.client.users.channels.Sip
 
equals(Object) - Method in class com.vonage.client.users.channels.Vbc
 
equals(Object) - Method in class com.vonage.client.users.channels.Websocket
 
equals(Object) - Method in class com.vonage.client.users.User
 
equals(Object) - Method in class com.vonage.client.voice.PhoneEndpoint
 
equals(Object) - Method in exception com.vonage.client.VonageApiResponseException
 
error - Variable in class com.vonage.client.messages.MessageStatus
 
Error() - Constructor for class com.vonage.client.messages.MessageStatus.Error
 
Error(String) - Constructor for class com.vonage.client.voice.ncco.PaymentPrompt.Errors.Error
Deprecated.
 
errorCode - Variable in exception com.vonage.client.VonageApiResponseException
 
errorCodeLabel - Variable in exception com.vonage.client.VonageApiResponseException
 
errors - Variable in exception com.vonage.client.VonageApiResponseException
 
ES - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Spanish
ESTONIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
EU_EAST - Enum constant in enum class com.vonage.client.application.capabilities.Region
api-eu-4.vonage.com (Frankfurt)
EU_WEST - Enum constant in enum class com.vonage.client.application.capabilities.Region
api-eu-3.vonage.com (Dublin)
Event - Class in com.vonage.client.proactiveconnect
Represents an event in the Proactive Connect API.
Event() - Constructor for class com.vonage.client.proactiveconnect.Event
 
EVENT - Enum constant in enum class com.vonage.client.common.Webhook.Type
 
EVENT - Enum constant in enum class com.vonage.client.verify2.CallbackType
Used for miscellaneous event updates.
EVENT_HANDLER - Enum constant in enum class com.vonage.client.proactiveconnect.SourceType
Event handler
eventMethod(HttpMethod) - Method in class com.vonage.client.voice.Call.Builder
The HTTP method used to send event information to event_url.
eventMethod(EventMethod) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
The HTTP method Vonage uses to make the request to eventUrl.
eventMethod(EventMethod) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
eventMethod(EventMethod) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
eventMethod(EventMethod) - Method in class com.vonage.client.voice.ncco.NotifyAction.Builder
 
eventMethod(EventMethod) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
EventMethod - Enum Class in com.vonage.client.voice.ncco
The type of request to use when connecting to an event url.
eventType(EventType) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Set to EventType.SYNCHRONOUS to: Make the connect action synchronous.
EventType - Enum Class in com.vonage.client.meetings
Represents the event type in MeetingsEventCallback.getEvent().
EventType - Enum Class in com.vonage.client.proactiveconnect
Represents values for Event.getType().
EventType - Enum Class in com.vonage.client.voice.ncco
The type of event to use.
eventUrl(String) - Method in class com.vonage.client.voice.Call.Builder
The webhook endpoint where call progress events are sent to.
eventUrl(String) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
eventUrl(String...) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Set the webhook endpoint that Vonage calls asynchronously on each of the possible Call States.
eventUrl(String...) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
eventUrl(String...) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
eventUrl(String...) - Method in class com.vonage.client.voice.ncco.NotifyAction.Builder
 
eventUrl(String...) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
eventUrl(URI) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
eventUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Set the webhook endpoint that Vonage calls asynchronously on each of the possible Call States.
eventUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
eventUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
eventUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.NotifyAction.Builder
 
eventUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
execute(RequestT) - Method in class com.vonage.client.AbstractMethod
Execute the REST call represented by this method object.
execute(T) - Method in interface com.vonage.client.RestEndpoint
 
EXPIRATION_DATE - Enum constant in enum class com.vonage.client.voice.ncco.PaymentPrompt.Type
Deprecated.
 
expireAfterUse(boolean) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Close the room after a session ends.
expireAfterUse(Boolean) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
EXPIRED - Enum constant in enum class com.vonage.client.verify.VerifyDetails.Status
Your user did not enter a code before the pin_expiry time elapsed.
EXPIRED - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
Expired.
expiresAt(Instant) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
NOTE: This parameter is REQUIRED if the room type is RoomType.LONG_TERM, but should not be present if the room type is RoomType.INSTANT.
expiresAt(Instant) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
EXPLICIT_APPROVAL - Enum constant in enum class com.vonage.client.meetings.JoinApprovalLevel
Participants will join the waiting room and the host will deny/approve them.
extension(String) - Method in class com.vonage.client.voice.ncco.VbcEndpoint.Builder
The VBC extension to connect the call to.

F

FACILITY_NOT_ALLOWED - Enum constant in enum class com.vonage.client.insight.InsightStatus
Your request makes use of a facility that is not enabled on your account.
FACILITY_NOT_ALLOWED - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
FAILED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
FAILED - Enum constant in enum class com.vonage.client.insight.LookupOutcome
 
FAILED - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
FAILED - Enum constant in enum class com.vonage.client.verify.VerifyDetails.Status
Your user entered an incorrect code more than three times.
FAILED - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
Failed.
FAILED - Enum constant in enum class com.vonage.client.voice.CallStatus
 
FALLBACK_ANSWER - Enum constant in enum class com.vonage.client.common.Webhook.Type
 
FAVICON - Enum constant in enum class com.vonage.client.meetings.LogoType
 
FETCHING - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
fetchList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Fetch and replace all items from datasource.
Fields() - Constructor for class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
file - Variable in class com.vonage.client.messages.InboundMessage
 
File - Class in com.vonage.client.messages.viber
 
File(String, String) - Constructor for class com.vonage.client.messages.viber.File
 
FILE - Enum constant in enum class com.vonage.client.messages.MessageType
 
fileSize - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
fileSize(int) - Method in class com.vonage.client.messages.viber.ViberVideoRequest.Builder
(REQUIRED) The video file size in megabytes.
FILIPINO - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
FILIPINO - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
FILIPINO_PHILIPPINES - Enum constant in enum class com.vonage.client.verify2.Locale
 
finalizedAt - Variable in class com.vonage.client.verify2.VerificationCallback
 
FINISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
FINNISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
FINNISH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
FINNISH_FINLAND - Enum constant in enum class com.vonage.client.verify2.Locale
 
footerText(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
(OPTIONAL) The text which appears at the end of the message.
footerText(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest.Builder
(OPTIONAL) The text which appears at the end of the message.
format(RecordingFormat) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
FR - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
French
fraudCheck - Variable in class com.vonage.client.verify2.VerificationRequest
 
fraudCheck() - Method in class com.vonage.client.verify2.VerificationRequest.Builder
Bypasses the network block used for fraud check.
fraudCheck(boolean) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) Set this parameter to false to force through the request even if it's blocked by the network's fraud protection.
FRENCH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
FRENCH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
FRENCH_CANADA - Enum constant in enum class com.vonage.client.verify2.Locale
 
FRENCH_CANADA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
FRENCH_FRANCE - Enum constant in enum class com.vonage.client.verify2.Locale
 
FRENCH_FRANCE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
from - Variable in class com.vonage.client.messages.InboundMessage
 
from - Variable in class com.vonage.client.messages.MessageRequest.Builder
 
from - Variable in class com.vonage.client.messages.MessageRequest
 
from - Variable in class com.vonage.client.messages.MessageStatus
 
from - Variable in class com.vonage.client.verify2.Workflow
 
from(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(REQUIRED) Sets the sender number or ID.
from(String) - Method in class com.vonage.client.voice.Call.Builder
Connect to a Phone (PSTN) number.
from(String) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Sets the caller ID number.
fromHttpResponse(Class<E>, HttpResponse) - Static method in exception com.vonage.client.VonageApiResponseException
 
fromInt(int) - Static method in enum class com.vonage.client.insight.InsightStatus
Look up the InsightStatus based on the int value.
fromInt(int) - Static method in enum class com.vonage.client.sms.MessageStatus
Look up the MessageStatus based on the int value.
fromInt(int) - Static method in enum class com.vonage.client.verify.VerifyStatus
Look up the VerifyStatus based on the int value.
fromInt(Integer) - Static method in enum class com.vonage.client.insight.LookupOutcome
 
fromJson(Class<E>, String) - Static method in exception com.vonage.client.VonageApiResponseException
 
fromJson(String) - Static method in exception com.vonage.client.account.AccountResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.account.BalanceResponse
 
fromJson(String) - Static method in class com.vonage.client.account.ListSecretsResponse
 
fromJson(String) - Static method in class com.vonage.client.account.PrefixPricingResponse
 
fromJson(String) - Static method in class com.vonage.client.account.PricingResponse
 
fromJson(String) - Static method in class com.vonage.client.account.SecretResponse
 
fromJson(String) - Static method in class com.vonage.client.account.SettingsResponse
 
fromJson(String) - Static method in class com.vonage.client.application.Application
 
fromJson(String) - Static method in class com.vonage.client.application.ApplicationList
 
fromJson(String) - Static method in exception com.vonage.client.application.ApplicationResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.incoming.CallEvent
 
fromJson(String) - Static method in class com.vonage.client.incoming.InputEvent
 
fromJson(String) - Static method in class com.vonage.client.incoming.MessageEvent
 
fromJson(String) - Static method in class com.vonage.client.incoming.NotifyEvent
 
fromJson(String) - Static method in class com.vonage.client.incoming.RecordEvent
 
fromJson(String) - Static method in class com.vonage.client.insight.AdvancedInsightResponse
 
fromJson(String) - Static method in class com.vonage.client.insight.BasicInsightResponse
 
fromJson(String) - Static method in class com.vonage.client.insight.StandardInsightResponse
 
fromJson(String) - Static method in class com.vonage.client.meetings.Application
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.meetings.MeetingRoom
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.meetings.MeetingsEventCallback
Constructs an instance of this class from a JSON payload.
fromJson(String) - Static method in exception com.vonage.client.meetings.MeetingsResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.meetings.Recording
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.meetings.Theme
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.messages.InboundMessage
Constructs an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.messages.MessageResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception com.vonage.client.messages.MessageResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.messages.MessageStatus
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.numbers.ListNumbersResponse
 
fromJson(String) - Static method in exception com.vonage.client.numbers.NumbersResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.numbers.SearchNumbersResponse
 
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.ContactsList
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.Event
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.ListItem
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.ListItemsResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.ListListsResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception com.vonage.client.proactiveconnect.ProactiveConnectResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.SyncStatus
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.proactiveconnect.UploadListItemsResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.sms.SmsSubmissionResponse
 
fromJson(String) - Static method in class com.vonage.client.subaccounts.Account
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.subaccounts.ListSubaccountsResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.subaccounts.MoneyTransfer
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.subaccounts.NumberTransfer
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception com.vonage.client.subaccounts.SubaccountsResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.users.User
Constructs a user from the JSON payload.
fromJson(String) - Static method in exception com.vonage.client.users.UsersResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.verify.CheckResponse
Constructs a CheckResponse with the fields populated from the JSON payload.
fromJson(String) - Static method in class com.vonage.client.verify.ControlResponse
 
fromJson(String) - Static method in class com.vonage.client.verify.SearchVerifyResponse
 
fromJson(String) - Static method in class com.vonage.client.verify.VerifyResponse
 
fromJson(String) - Static method in class com.vonage.client.verify2.VerificationCallback
Constructs an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.verify2.VerificationResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception com.vonage.client.verify2.VerifyResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.Call
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.CallEvent
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.CallInfo
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.CallInfoPage
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.DtmfResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.ModifyCallResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.StreamResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.TalkResponse
Creates an instance of this class from a JSON payload.
fromJson(String, Class<? extends J>) - Static method in interface com.vonage.client.Jsonable
 
fromName(String) - Static method in enum class com.vonage.client.common.Webhook.Type
 
fromRandomNumber(boolean) - Method in class com.vonage.client.voice.Call.Builder
Set to @{code true} to use random phone number as the caller.
fromString(String) - Static method in enum class com.vonage.client.account.Network.Type
 
fromString(String) - Static method in enum class com.vonage.client.application.capabilities.Region
 
fromString(String) - Static method in enum class com.vonage.client.common.HttpMethod
 
fromString(String) - Static method in enum class com.vonage.client.incoming.CallDirection
 
fromString(String) - Static method in enum class com.vonage.client.incoming.CallStatus
 
fromString(String) - Static method in enum class com.vonage.client.incoming.CallStatusDetail
 
fromString(String) - Static method in enum class com.vonage.client.incoming.MessageType
 
fromString(String) - Static method in enum class com.vonage.client.insight.CallerType
 
fromString(String) - Static method in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
fromString(String) - Static method in enum class com.vonage.client.insight.PortedStatus
 
fromString(String) - Static method in enum class com.vonage.client.insight.Reachability
 
fromString(String) - Static method in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
 
fromString(String) - Static method in enum class com.vonage.client.insight.Validity
 
fromString(String) - Static method in enum class com.vonage.client.meetings.JoinApprovalLevel
 
fromString(String) - Static method in enum class com.vonage.client.meetings.LogoType
 
fromString(String) - Static method in enum class com.vonage.client.meetings.MicrophoneState
 
fromString(String) - Static method in enum class com.vonage.client.meetings.RecordingStatus
 
fromString(String) - Static method in enum class com.vonage.client.meetings.RoomLanguage
 
fromString(String) - Static method in enum class com.vonage.client.meetings.RoomType
 
fromString(String) - Static method in enum class com.vonage.client.meetings.ThemeDomain
 
fromString(String) - Static method in enum class com.vonage.client.messages.Channel
 
fromString(String) - Static method in enum class com.vonage.client.messages.MessageStatus.Status
 
fromString(String) - Static method in enum class com.vonage.client.messages.MessageType
 
fromString(String) - Static method in enum class com.vonage.client.numbers.Type
 
fromString(String) - Static method in enum class com.vonage.client.proactiveconnect.EventType
 
fromString(String) - Static method in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
fromString(String) - Static method in enum class com.vonage.client.users.channels.Websocket.ContentType
 
fromString(String) - Static method in enum class com.vonage.client.verify.VerifyControlCommand
 
fromString(String) - Static method in enum class com.vonage.client.verify.VerifyDetails.Status
Look up the Status enum based on the string value.
fromString(String) - Static method in enum class com.vonage.client.verify2.CallbackType
 
fromString(String) - Static method in enum class com.vonage.client.verify2.VerificationStatus
 
fromString(String) - Static method in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
 
fromString(String) - Static method in enum class com.vonage.client.voice.CallDirection
 
fromString(String) - Static method in enum class com.vonage.client.voice.CallStatus
 
fromString(String) - Static method in enum class com.vonage.client.voice.MachineDetection
 
fromString(String) - Static method in enum class com.vonage.client.voice.ModifyCallAction
 
fromString(String) - Static method in enum class com.vonage.client.voice.ncco.RecordingFormat
 

G

GALICIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
generateJwt() - Method in class com.vonage.client.VonageClient
Generate a JWT for the application the client has been configured with.
generateToken() - Method in class com.vonage.client.auth.JWTAuthMethod
 
GEORGIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
GEORGIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
GERMAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
GERMAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
GERMAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
GERMAN_GERMANY - Enum constant in enum class com.vonage.client.verify2.Locale
 
GET - Enum constant in enum class com.vonage.client.common.HttpMethod
 
GET - Enum constant in enum class com.vonage.client.voice.ncco.EventMethod
 
getAcceptableAuthMethod(Set<Class<? extends AuthMethod>>) - Method in class com.vonage.client.auth.AuthCollection
Obtain an AuthMethod instance for a set of acceptable AuthMethod classes.
getAcceptableAuthMethods() - Method in class com.vonage.client.AbstractMethod
 
getAcceptableAuthMethods() - Method in class com.vonage.client.DynamicEndpoint
 
getAccountClient() - Method in class com.vonage.client.VonageClient
 
getAccountId() - Method in class com.vonage.client.meetings.Application
ID of the account application.
getAccountId() - Method in class com.vonage.client.meetings.Theme
Account ID.
getAccountId() - Method in class com.vonage.client.verify.VerifyDetails
 
getAccountRef() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
This is an advanced feature and requires activation via a support request before it can be used.
getAction() - Method in class com.vonage.client.messages.viber.ViberService
 
getAction() - Method in class com.vonage.client.voice.CallModifier
Deprecated.
 
getAction() - Method in class com.vonage.client.voice.ModifyCallPayload
Deprecated.
 
getAction() - Method in interface com.vonage.client.voice.ncco.Action
 
getAction() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getAction() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getAction() - Method in class com.vonage.client.voice.ncco.InputAction
 
getAction() - Method in class com.vonage.client.voice.ncco.NotifyAction
 
getAction() - Method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
 
getAction() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getAction() - Method in class com.vonage.client.voice.ncco.StreamAction
 
getAction() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getActionId() - Method in class com.vonage.client.proactiveconnect.Event
Unique identifier for the action.
getActionId() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Action ID to filter by.
getActions() - Method in class com.vonage.client.voice.ncco.Ncco
 
getActiveStatus() - Method in class com.vonage.client.insight.RealTimeData
 
getAdditionalProperties() - Method in class com.vonage.client.messages.MessageStatus
Catch-all for properties which are not mapped by this class during deserialization.
getAddress() - Method in class com.vonage.client.common.Webhook
The webhook's URL.
getAddress() - Method in class com.vonage.client.messages.whatsapp.Location
 
getAdvancedMachineDetection() - Method in class com.vonage.client.voice.Call
Premium machine detection, overrides Call.getMachineDetection() if both are set.
getAdvancedMachineDetection() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getAdvancedNumberInsight(AdvancedInsightRequest) - Method in class com.vonage.client.insight.InsightClient
Perform an Advanced Insight Request with a AdvancedInsightRequest.
getAdvancedNumberInsight(String) - Method in class com.vonage.client.insight.InsightClient
Perform an Advanced Insight Request with a number.
getAdvancedNumberInsight(String, String) - Method in class com.vonage.client.insight.InsightClient
Perform an Advanced Insight Request with a number and country.
getAlias() - Method in class com.vonage.client.proactiveconnect.ListAttribute
Alternative name to use for this attribute.
getAmount() - Method in class com.vonage.client.subaccounts.MoneyTransfer
Transfer amount.
getAmount() - Method in class com.vonage.client.verify.Psd2Request
 
getAmount() - Method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
 
getAmzAlgorithm() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
getAmzCredential() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
getAmzDate() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
getAmzSecurityToken() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
getAmzSignature() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
getAnswerMethod() - Method in class com.vonage.client.voice.Call
 
getAnswerUrl() - Method in class com.vonage.client.voice.Call
 
getApiBaseUri() - Method in class com.vonage.client.HttpConfig
 
getApiEuBaseUri() - Method in class com.vonage.client.HttpConfig
 
getApiKey() - Method in class com.vonage.client.auth.SignatureAuthMethod
 
getApiKey() - Method in class com.vonage.client.auth.TokenAuthMethod
 
getApiKey() - Method in class com.vonage.client.subaccounts.Account
Unique subaccount ID.
getAppHash() - Method in class com.vonage.client.verify2.SmsWorkflow
Android Application Hash Key for automatic code detection on a user's device.
getApplication(String) - Method in class com.vonage.client.application.ApplicationClient
Retrieve an application.
getApplicationClient() - Method in class com.vonage.client.VonageClient
 
getApplicationId() - Method in class com.vonage.client.auth.JWTAuthMethod
 
getApplicationId() - Method in class com.vonage.client.meetings.Application
ID of the application.
getApplicationId() - Method in class com.vonage.client.meetings.Theme
Unique application ID.
getApplicationIdOrApiKey() - Method in class com.vonage.client.AbstractMethod
Utility method for obtaining the Application ID or API key from the auth method.
getApplications() - Method in class com.vonage.client.application.ApplicationList
Retrieves the embedded resource contents.
getAttributes() - Method in class com.vonage.client.proactiveconnect.ContactsList
The list attributes.
getAudio() - Method in class com.vonage.client.messages.messenger.MessengerAudioRequest
 
getAudio() - Method in class com.vonage.client.messages.mms.MmsAudioRequest
 
getAudio() - Method in class com.vonage.client.messages.whatsapp.WhatsappAudioRequest
 
getAudioUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.AUDIO, returns the URL of the audio.
getAuth(Class<T>) - Method in class com.vonage.client.auth.AuthCollection
Obtain an AuthMethod of type T, if one is contained in this collection.
getAuthCollection() - Method in class com.vonage.client.HttpWrapper
 
getAuthMethod() - Method in class com.vonage.client.AbstractMethod
getAuthMethod(Class<?>[]) - Method in class com.vonage.client.AbstractMethod
Utility method for obtaining an appropriate AuthMethod for this call.
getAutoRecord() - Method in class com.vonage.client.meetings.RecordingOptions
Automatically record all sessions in this room.
getAvailableFeatures() - Method in class com.vonage.client.meetings.MeetingRoom
The available features for this meeting.
getAvailableFeatures() - Method in class com.vonage.client.meetings.UpdateRoomRequest
The available features for this meeting.
getBalance() - Method in class com.vonage.client.account.AccountClient
Obtains the current account remaining balance.
getBalance() - Method in class com.vonage.client.subaccounts.Account
Balance of the subaccount.
getBargeIn() - Method in class com.vonage.client.voice.ncco.StreamAction
 
getBargeIn() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getBasicNumberInsight(BasicInsightRequest) - Method in class com.vonage.client.insight.InsightClient
Perform a Basic Insight Request with a BasicInsightRequest.
getBasicNumberInsight(String) - Method in class com.vonage.client.insight.InsightClient
Perform a Basic Insight Request with a number.
getBasicNumberInsight(String, String) - Method in class com.vonage.client.insight.InsightClient
Perform a Basic Insight Request with a number and country.
getBeepStart() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getBeepTimeout() - Method in class com.vonage.client.voice.AdvancedMachineDetection
Maximum time in seconds Vonage should wait for a machine beep to be detected.
getBehavior() - Method in class com.vonage.client.voice.AdvancedMachineDetection
Defines how the system responds when a machine is detected.
getBinaryMessageBody() - Method in class com.vonage.client.sms.callback.messages.MO
 
getBrand() - Method in class com.vonage.client.verify.VerifyRequest
 
getBrand() - Method in class com.vonage.client.verify2.VerificationRequest
The brand that is sending the verification request.
getBrandedFavicon() - Method in class com.vonage.client.meetings.Theme
Favicon's key in storage system.
getBrandedFaviconUrl() - Method in class com.vonage.client.meetings.Theme
Favicon's link.
getBrandImageColored() - Method in class com.vonage.client.meetings.Theme
Coloured logo's key in storage system.
getBrandImageColoredUrl() - Method in class com.vonage.client.meetings.Theme
Coloured logo's link.
getBrandImageWhite() - Method in class com.vonage.client.meetings.Theme
White logo's key in storage system.
getBrandImageWhiteUrl() - Method in class com.vonage.client.meetings.Theme
White logo's link.
getBrandText() - Method in class com.vonage.client.meetings.Theme
Brand text that will appear in the application.
getBucket() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
Bucket name to upload to.
getCallback() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
getCallbackUrl() - Method in class com.vonage.client.sms.messages.Message
 
getCallbackUrls() - Method in class com.vonage.client.meetings.MeetingRoom
The callback URLs for this meeting.
getCallbackUrls() - Method in class com.vonage.client.meetings.UpdateRoomRequest
The callback URLs for this meeting.
getCallDetails(String) - Method in class com.vonage.client.voice.VoiceClient
Look up the status of a single call initiated by VoiceClient.createCall(Call).
getCallerIdentity() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getCallerName() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getCallerType() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getCallInfos() - Method in class com.vonage.client.voice.EmbeddedCalls
 
getCallOrder() - Method in enum class com.vonage.client.voice.CallOrder
 
getCallUuid() - Method in class com.vonage.client.incoming.CallEvent
 
getCapabilities() - Method in class com.vonage.client.application.Application
Your application can use multiple products.
getCaption() - Method in class com.vonage.client.messages.internal.MessagePayload
 
getCatalogId() - Method in class com.vonage.client.messages.whatsapp.Order
The ID of the catalog associated with the product from the product message being quoted or replied to using the 'Message Business' option.
getCatalogId() - Method in class com.vonage.client.messages.whatsapp.ReferredProduct
The ID of the catalog associated with the product from the product message being quoted or replied to using the 'Message Business' option.
getCategory() - Method in class com.vonage.client.messages.messenger.Messenger
 
getCategory() - Method in class com.vonage.client.messages.viber.ViberService
 
getChannel() - Method in class com.vonage.client.messages.InboundMessage
The service used to send the message.
getChannel() - Method in class com.vonage.client.messages.MessageRequest
 
getChannel() - Method in class com.vonage.client.messages.MessageStatus
The service used to send the message.
getChannel() - Method in class com.vonage.client.verify2.VerificationCallback
If VerificationCallback.getType() is CallbackType.EVENT, this will return the contact channel of the event update, null otherwise.
getChannel() - Method in class com.vonage.client.verify2.Workflow
The communication channel for this verification workflow.
getChannel() - Method in class com.vonage.client.verify2.WorkflowStatus
The workflow type.
getChannels() - Method in class com.vonage.client.users.User
The communication channels available to the user.
getChannels() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getChannelTimeout() - Method in class com.vonage.client.verify2.VerificationCallback
If VerificationCallback.getType() is CallbackType.SUMMARY, this will return the number of seconds before the current step in the verification request times out, null otherwise.
getChannelTimeout() - Method in class com.vonage.client.verify2.VerificationRequest
Specifies the wait time in seconds between attempts to delivery the verification code.
getChecks() - Method in class com.vonage.client.verify.VerifyDetails
 
getCheckUrl() - Method in class com.vonage.client.verify2.VerificationResponse
URL for Silent Auth Verify workflow completion (only present if using Silent Auth).
getClientRef() - Method in class com.vonage.client.messages.InboundMessage
The client reference will be present if set in the original outbound message.
getClientRef() - Method in class com.vonage.client.messages.MessageRequest
 
getClientRef() - Method in class com.vonage.client.messages.MessageStatus
Client reference of up to 40 characters.
getClientRef() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getClientRef() - Method in class com.vonage.client.verify2.VerificationCallback
Contains the client reference given in the original Verify request if one was provided.
getClientRef() - Method in class com.vonage.client.verify2.VerificationRequest
If the client_ref is set when the request is sent, it will be included in the callbacks.
getClientReference() - Method in class com.vonage.client.sms.messages.Message
 
getCnam() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
getCnam() - Method in class com.vonage.client.insight.StandardInsightRequest
 
getCode() - Method in class com.vonage.client.account.Country
 
getCode() - Method in class com.vonage.client.account.Network
 
getCode() - Method in enum class com.vonage.client.insight.LookupOutcome
 
getCode() - Method in class com.vonage.client.verify.CheckRequest
 
getCode() - Method in class com.vonage.client.verify.VerifyCheck
 
getCode() - Method in class com.vonage.client.verify2.VerificationRequest
Custom alphanumeric verification code to send to the user instead of the Vonage-generated one.
getCode() - Method in exception com.vonage.client.VonageApiResponseException
Name of the error code.
getCodeLength() - Method in class com.vonage.client.verify2.VerificationRequest
Length of the code to send to the user.
getCommand() - Method in class com.vonage.client.sns.request.SnsRequest
 
getCommand() - Method in class com.vonage.client.sns.response.SnsResponse
 
getCommand() - Method in class com.vonage.client.verify.ControlRequest
 
getCommand() - Method in class com.vonage.client.verify.ControlResponse
 
getConcat() - Method in class com.vonage.client.incoming.MessageEvent
 
getConcatPart() - Method in class com.vonage.client.incoming.MessageEvent
 
getConcatPartNumber() - Method in class com.vonage.client.sms.callback.messages.MO
 
getConcatRef() - Method in class com.vonage.client.incoming.MessageEvent
 
getConcatReferenceNumber() - Method in class com.vonage.client.sms.callback.messages.MO
 
getConcatTotal() - Method in class com.vonage.client.incoming.MessageEvent
 
getConcatTotalParts() - Method in class com.vonage.client.sms.callback.messages.MO
 
getConfidence() - Method in class com.vonage.client.incoming.Result
 
getConnectionTimeout() - Method in class com.vonage.client.common.Webhook
If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint.
getContent() - Method in class com.vonage.client.voice.Recording
Gets the data stream from the HTTP response.
getContentId() - Method in class com.vonage.client.sms.messages.Message
 
getContentType() - Method in interface com.vonage.client.BinaryRequest
The MIME type header for this request to use as the Content-Type.
getContentType() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
MIME type of the content.
getContentType() - Method in class com.vonage.client.users.channels.Websocket
MIME type of the content sent over the websocket.
getContentType() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
getContentType() - Method in class com.vonage.client.voice.WebSocketEndpoint
 
getContext() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getConversationsTtl() - Method in class com.vonage.client.application.capabilities.Voice
The length of time the named conversation will remain active for after creation, in hours.
getConversationUuid() - Method in class com.vonage.client.incoming.CallEvent
 
getConversationUuid() - Method in class com.vonage.client.incoming.InputEvent
 
getConversationUuid() - Method in class com.vonage.client.incoming.NotifyEvent
 
getConversationUuid() - Method in class com.vonage.client.incoming.RecordEvent
 
getConversationUuid() - Method in class com.vonage.client.voice.CallEvent
 
getConversationUuid() - Method in class com.vonage.client.voice.CallInfo
 
getConversationUuid() - Method in class com.vonage.client.voice.CallsFilter
 
getConversionClient() - Method in class com.vonage.client.VonageClient
 
getCost() - Method in class com.vonage.client.numbers.AvailableNumber
 
getCount() - Method in class com.vonage.client.account.PrefixPricingResponse
 
getCount() - Method in class com.vonage.client.numbers.ListNumbersResponse
 
getCount() - Method in class com.vonage.client.numbers.SearchNumbersResponse
 
getCount() - Method in class com.vonage.client.voice.CallInfoPage
 
getCountries() - Method in class com.vonage.client.account.PrefixPricingResponse
 
getCountry() - Method in class com.vonage.client.account.PricingResponse
 
getCountry() - Method in class com.vonage.client.insight.BaseInsightRequest
 
getCountry() - Method in class com.vonage.client.insight.CarrierDetails
 
getCountry() - Method in class com.vonage.client.numbers.AvailableNumber
 
getCountry() - Method in class com.vonage.client.numbers.CancelNumberRequest
 
getCountry() - Method in class com.vonage.client.numbers.OwnedNumber
 
getCountry() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getCountry() - Method in class com.vonage.client.subaccounts.NumberTransfer
Country the number is registered in (ISO 3166-1 alpha-2 format).
getCountry() - Method in class com.vonage.client.verify.BaseRequest
The country for the destination phone number.
getCountryCode() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getCountryCodeIso3() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getCountryName() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getCountryPrefix() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getCreated() - Method in class com.vonage.client.account.SecretResponse
 
getCreatedAt() - Method in class com.vonage.client.meetings.MeetingRoom
The time for when the room was created, expressed in ISO 8601 format.
getCreatedAt() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The date-time when the room was created, expressed in ISO 8601 format.
getCreatedAt() - Method in class com.vonage.client.proactiveconnect.ContactsList
The creation timestamp in ISO 8601 format.
getCreatedAt() - Method in class com.vonage.client.proactiveconnect.ListItem
Time this item was created, in ISO 8601 format.
getCreatedAt() - Method in class com.vonage.client.subaccounts.Account
Subaccount creation date and time.
getCreatedAt() - Method in class com.vonage.client.subaccounts.MoneyTransfer
The date and time when the transfer was executed.
getCreditLimit() - Method in class com.vonage.client.subaccounts.Account
Credit limit of the subaccount.
getCurrency() - Method in class com.vonage.client.account.Network
 
getCurrency() - Method in class com.vonage.client.account.PricingResponse
 
getCurrency() - Method in class com.vonage.client.messages.MessageStatus.Usage
The charge currency in ISO 4217 format.
getCurrency() - Method in class com.vonage.client.messages.whatsapp.ProductItem
The currency code representing the currency for this specific item.
getCurrency() - Method in class com.vonage.client.verify.CheckResponse
 
getCurrency() - Method in class com.vonage.client.verify.VerifyDetails
 
getCurrency() - Method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
 
getCurrentCarrier() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getCursor() - Method in class com.vonage.client.users.ListUsersRequest
The cursor to start returning results from, as derived from the _links section of a response.
getCustom() - Method in class com.vonage.client.messages.whatsapp.WhatsappCustomRequest
 
getCustom() - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest
 
getCustom() - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest
 
getCustom() - Method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest
 
getCustomData() - Method in class com.vonage.client.users.User
Custom key/value pairs to associate with the user.
getCustomData() - Method in class com.vonage.client.users.User.Properties
Custom key/value pairs to associate with the user.
getDashedLocale() - Method in class com.vonage.client.verify.BaseRequest
 
getData() - Method in class com.vonage.client.incoming.MessageEvent
 
getData() - Method in class com.vonage.client.proactiveconnect.Event
Custom data as key-value pairs for this event.
getData() - Method in class com.vonage.client.proactiveconnect.ListItem
Custom data as key-value pairs for this list.
getDataModified() - Method in class com.vonage.client.proactiveconnect.SyncStatus
Whether one or more list items were added, removed and/or modified since last sync.
getDatasource() - Method in class com.vonage.client.proactiveconnect.ContactsList
The list's datasource.
getDate() - Method in class com.vonage.client.verify.VerifyCheck
 
getDateEnd() - Method in class com.vonage.client.voice.CallsFilter
 
getDateFinalized() - Method in class com.vonage.client.verify.VerifyDetails
 
getDateStart() - Method in class com.vonage.client.voice.CallsFilter
 
getDateSubmitted() - Method in class com.vonage.client.verify.VerifyDetails
 
getDefaultPrice() - Method in class com.vonage.client.account.PricingResponse
 
getDefaultThemeId() - Method in class com.vonage.client.meetings.Application
ID of the default theme.
getDefaultThemeId() - Method in class com.vonage.client.meetings.UpdateApplicationRequest
 
getDeleted() - Method in class com.vonage.client.proactiveconnect.UploadListItemsResponse
Items deleted in the list.
getDeliveryReceiptUrl() - Method in class com.vonage.client.account.SettingsRequest
 
getDeliveryReceiptUrl() - Method in class com.vonage.client.account.SettingsResponse
 
getDescription() - Method in class com.vonage.client.messages.whatsapp.Reply
A description that may be added to the interactive options presented (available only on interactive lists).
getDescription() - Method in class com.vonage.client.proactiveconnect.ContactsList
The description of the resource (max 1024 characters).
getDestination() - Method in class com.vonage.client.sms.callback.messages.MO
 
getDestination() - Method in class com.vonage.client.voice.TransferCallPayload
Deprecated.
 
getDetail() - Method in class com.vonage.client.incoming.CallEvent
 
getDetail() - Method in class com.vonage.client.messages.MessageStatus.Error
Text describing the error.
getDetail() - Method in exception com.vonage.client.VonageApiResponseException
Extended description of the error, explaining the cause.
getDetailEnum() - Method in class com.vonage.client.incoming.CallEvent
 
getDetails() - Method in class com.vonage.client.proactiveconnect.SyncStatus
Details on the sync status.
getDialingPrefix() - Method in class com.vonage.client.account.PricingResponse
 
getDigits() - Method in class com.vonage.client.incoming.DtmfResult
 
getDirection() - Method in class com.vonage.client.incoming.CallEvent
 
getDirection() - Method in class com.vonage.client.voice.CallEvent
 
getDirection() - Method in class com.vonage.client.voice.CallInfo
 
getDirty() - Method in class com.vonage.client.proactiveconnect.SyncStatus
Whether the list content or metadata were modified since last sync.
getDisplayName() - Method in class com.vonage.client.account.Country
 
getDisplayName() - Method in class com.vonage.client.meetings.DialInNumber
The country name of the locale.
getDisplayName() - Method in class com.vonage.client.meetings.MeetingRoom
Name of the meeting room.
getDisplayName() - Method in class com.vonage.client.users.User
A string to be displayed as username.
getDomain() - Method in class com.vonage.client.meetings.Theme
The theme's application domain.
getDtmf() - Method in class com.vonage.client.incoming.InputEvent
 
getDtmf() - Method in class com.vonage.client.voice.ncco.InputAction
 
getDtmfAnswer() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint
Set the digits that are sent to the user as soon as the Call is answered.
getDtmfAnswer() - Method in class com.vonage.client.voice.PhoneEndpoint
Set the digits that are sent to the user as soon as the Call is answered.
getDuration() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Duration of the recording in seconds.
getDuration() - Method in class com.vonage.client.messages.viber.ViberService
 
getDuration() - Method in class com.vonage.client.voice.CallInfo
 
getEmbedded() - Method in class com.vonage.client.voice.CallInfoPage
 
getEndDate() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
ISO-8601 formatted date for when to end events filter.
getEndDate() - Method in class com.vonage.client.subaccounts.ListTransfersFilter
End of the retrieval period.
getEndedAt() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The date-time the session or recording ended, expressed in ISO 8601 format.
getEndedAt() - Method in class com.vonage.client.meetings.Recording
Recording end time, in ISO 8601 format.
getEndOnExit() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getEndOnKey() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getEndOnSilence() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getEndOnSilence() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getEndpoint() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getEndTime() - Method in class com.vonage.client.incoming.RecordEvent
 
getEndTime() - Method in class com.vonage.client.voice.CallInfo
 
getEntityId() - Method in class com.vonage.client.sms.messages.Message
 
getError() - Method in class com.vonage.client.incoming.SpeechResults
 
getError() - Method in class com.vonage.client.messages.MessageStatus
If the message encountered a problem a descriptive error will be supplied in this object.
getErrorCodeLabel() - Method in exception com.vonage.client.VonageApiResponseException
The status code description.
getErrors() - Method in class com.vonage.client.voice.ncco.PaymentPrompt
Deprecated.
 
getErrors() - Method in exception com.vonage.client.VonageApiResponseException
Additional description of problems encountered with the request.
getErrorText() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getErrorText() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getErrorText() - Method in class com.vonage.client.verify.BaseResult
Deprecated.
 
getErrorText() - Method in class com.vonage.client.verify.CheckResponse
 
getErrorText() - Method in class com.vonage.client.verify.ControlResponse
If the status is non-zero, this explains the error encountered.
getErrorText() - Method in class com.vonage.client.verify.SearchVerifyResponse
 
getErrorText() - Method in exception com.vonage.client.verify.VerifyException
 
getErrorText() - Method in class com.vonage.client.verify.VerifyResponse
 
getEstimatedPriceMessagesSent() - Method in class com.vonage.client.verify.CheckResponse
 
getEstimatedPriceMessagesSent() - Method in class com.vonage.client.verify.VerifyDetails
 
getEvent() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Type of event represented by this object.
getEventId() - Method in class com.vonage.client.verify.CheckResponse
 
getEventMethod() - Method in class com.vonage.client.voice.Call
 
getEventMethod() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getEventMethod() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getEventMethod() - Method in class com.vonage.client.voice.ncco.InputAction
 
getEventMethod() - Method in class com.vonage.client.voice.ncco.NotifyAction
 
getEventMethod() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getEventType() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getEventUrl() - Method in class com.vonage.client.voice.Call
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.InputAction
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.NotifyAction
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getExpireAfterUse() - Method in class com.vonage.client.meetings.MeetingRoom
Close the room after a session ends.
getExpireAfterUse() - Method in class com.vonage.client.meetings.UpdateRoomRequest
Close the room after a session ends.
getExpiresAt() - Method in class com.vonage.client.meetings.MeetingRoom
The time for when the room will be expired, expressed in ISO 8601 format.
getExpiresAt() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The date-time when the room will expire, expressed in ISO 8601 format.
getExpiresAt() - Method in class com.vonage.client.meetings.UpdateRoomRequest
The time for when the room will be expired, expressed in ISO 8601 format.
getExtension() - Method in class com.vonage.client.users.channels.Vbc
VBC extension.
getExtension() - Method in class com.vonage.client.voice.ncco.VbcEndpoint
The VBC extension to connect the call to.
getExtension() - Method in class com.vonage.client.voice.VbcEndpoint
The extension to call.
getFeatures() - Method in class com.vonage.client.numbers.AvailableNumber
 
getFeatures() - Method in class com.vonage.client.numbers.OwnedNumber
 
getFeatures() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getFields() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse
Fields property has to be part of the POST request's body.
getFile() - Method in class com.vonage.client.messages.messenger.MessengerFileRequest
 
getFile() - Method in class com.vonage.client.messages.viber.ViberFileRequest
 
getFile() - Method in class com.vonage.client.messages.whatsapp.WhatsappFileRequest
 
getFileSize() - Method in class com.vonage.client.messages.viber.ViberService
 
getFileUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.FILE, returns the URL of the file.
getFinalizedAt() - Method in class com.vonage.client.verify2.VerificationCallback
The date and time the verification request was completed in ISO 8601 format or null if this callback is not an event update.
getFirst() - Method in class com.vonage.client.voice.PageLinks
 
getFirstEventDate() - Method in class com.vonage.client.verify.VerifyDetails
 
getFirstName() - Method in class com.vonage.client.insight.CallerIdentity
 
getFirstName() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getFirstUrl() - Method in class com.vonage.client.common.HalLinks
The href property of first.
getFormat() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getFraudCheck() - Method in class com.vonage.client.verify2.VerificationRequest
Determines if the network level fraud check is enforced.
getFrom() - Method in class com.vonage.client.incoming.CallEvent
 
getFrom() - Method in class com.vonage.client.incoming.InputEvent
 
getFrom() - Method in class com.vonage.client.messages.InboundMessage
The number this message was sent from.
getFrom() - Method in class com.vonage.client.messages.MessageRequest
 
getFrom() - Method in class com.vonage.client.messages.MessageStatus
The 'from' number used in the outbound MessageRequest.
getFrom() - Method in class com.vonage.client.sms.messages.Message
 
getFrom() - Method in class com.vonage.client.subaccounts.NumberTransfer
Account to transfer from.
getFrom() - Method in class com.vonage.client.verify.VerifyRequest
 
getFrom() - Method in class com.vonage.client.verify2.EmailWorkflow
The e-mail address to send the verification request from, if configured.
getFrom() - Method in class com.vonage.client.verify2.WhatsappWorkflow
The number to send the verification request from, if configured.
getFrom() - Method in class com.vonage.client.voice.Call
 
getFrom() - Method in class com.vonage.client.voice.CallInfo
 
getFrom() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getFromRandomNumber() - Method in class com.vonage.client.voice.Call
 
getGuestUrl() - Method in class com.vonage.client.meetings.RoomLinks
 
getHandsetStatus() - Method in class com.vonage.client.insight.RealTimeData
 
getHeaders() - Method in class com.vonage.client.users.channels.Websocket
Custom properties to add to the header.
getHeaders() - Method in class com.vonage.client.voice.ncco.SipEndpoint
 
getHeaders() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
getHeaders() - Method in class com.vonage.client.voice.WebSocketEndpoint
Deprecated.
getHeadersMap() - Method in class com.vonage.client.voice.WebSocketEndpoint
 
getHostUrl() - Method in class com.vonage.client.meetings.RoomLinks
 
getHref() - Method in class com.vonage.client.meetings.UrlContainer
 
getHref() - Method in class com.vonage.client.voice.PageLink
 
getHttpClient() - Method in class com.vonage.client.HttpWrapper
 
getHttpConfig() - Method in class com.vonage.client.HttpWrapper
 
getHttpWrapper() - Method in class com.vonage.client.AbstractMethod
 
getId() - Method in class com.vonage.client.account.SecretResponse
 
getId() - Method in class com.vonage.client.application.Application
Unique application ID.
getId() - Method in class com.vonage.client.meetings.MeetingRoom
Identifier of the meeting room.
getId() - Method in class com.vonage.client.meetings.Recording
Identifier of the recording.
getId() - Method in class com.vonage.client.messages.whatsapp.Reply
An identifier to help identify the exact interactive message response.
getId() - Method in class com.vonage.client.messages.whatsapp.Sticker
 
getId() - Method in class com.vonage.client.proactiveconnect.ContactsList
Unique identifier for this list.
getId() - Method in class com.vonage.client.proactiveconnect.Event
Unique identifier for this item.
getId() - Method in class com.vonage.client.proactiveconnect.ListItem
Unique identifier for this item.
getId() - Method in class com.vonage.client.redact.RedactRequest
 
getId() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getId() - Method in class com.vonage.client.subaccounts.MoneyTransfer
Unique ID of the transfer.
getId() - Method in class com.vonage.client.users.BaseUser
Unique user ID.
getId() - Method in class com.vonage.client.users.channels.Messenger
Facebook Messenger ID.
getId() - Method in enum class com.vonage.client.verify.Psd2Request.Workflow
 
getId() - Method in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
getImage() - Method in class com.vonage.client.messages.messenger.MessengerImageRequest
 
getImage() - Method in class com.vonage.client.messages.mms.MmsImageRequest
 
getImage() - Method in class com.vonage.client.messages.viber.ViberImageRequest
 
getImage() - Method in class com.vonage.client.messages.whatsapp.WhatsappImageRequest
 
getImageUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.IMAGE, returns the URL of the image.
getImageUrl() - Method in class com.vonage.client.users.User
An image URL to associate with the user.
getImproveAi() - Method in class com.vonage.client.application.Application.Privacy
Whether Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
getIncomingSmsUrl() - Method in class com.vonage.client.account.SettingsRequest
 
getIncomingSmsUrl() - Method in class com.vonage.client.account.SettingsResponse
 
getIndex() - Method in class com.vonage.client.numbers.ListNumbersFilter
 
getIndex() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getInitialJoinOptions() - Method in class com.vonage.client.meetings.MeetingRoom
Options for when a participant joins a meeting.
getInitialJoinOptions() - Method in class com.vonage.client.meetings.UpdateRoomRequest
Options for when a participant joins a meeting.
getInitiatedAt() - Method in class com.vonage.client.verify2.WorkflowStatus
Date and time this workflow was initiated.
getInserted() - Method in class com.vonage.client.proactiveconnect.UploadListItemsResponse
Items inserted in the list.
getInsightClient() - Method in class com.vonage.client.VonageClient
 
getInsightStatus() - Method in enum class com.vonage.client.insight.InsightStatus
 
getInstance() - Method in class com.vonage.client.messages.MessageStatus.Error
The record id of this error's occurrence.
getInstance() - Method in exception com.vonage.client.VonageApiResponseException
Internal trace ID of the request.
getIntegrationId() - Method in class com.vonage.client.proactiveconnect.SalesforceDatasource
Integration ID defining Salesforce credential to use for this datasource.
getInternationalFormatNumber() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getInvalidCardNumber() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Errors
Deprecated.
 
getInvalidCardType() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Errors
Deprecated.
 
getInvalidExpirationDate() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Errors
Deprecated.
 
getInvalidParameters() - Method in exception com.vonage.client.VonageApiResponseException
If the request was rejected due to invalid parameters, this will return the offending parameters, sometimes along with a description of the errors.
getInvalidSecurityCode() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Errors
Deprecated.
 
getInvocationId() - Method in class com.vonage.client.proactiveconnect.Event
Unique identifier for the action invocation.
getInvocationId() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Invocation ID to filter by.
getIpAddress() - Method in class com.vonage.client.insight.AdvancedInsightRequest
Deprecated.
getIpAddress() - Method in class com.vonage.client.verify.CheckRequest
Deprecated.
This field is no longer used.
getIpAddress() - Method in class com.vonage.client.verify.VerifyCheck
Deprecated.
This field is no longer used.
getIsAvailable() - Method in class com.vonage.client.meetings.MeetingRoom
Once a room becomes unavailable, no new sessions can be created under it.
getIsChatAvailable() - Method in class com.vonage.client.meetings.AvailableFeatures
Determine if chat feature is available in the UI.
getIsHost() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Indicates if this participant is the session's host.
getIsLocaleSwitcherAvailable() - Method in class com.vonage.client.meetings.AvailableFeatures
Determine if locale switcher feature is available in the UI.
getIsRecordingAvailable() - Method in class com.vonage.client.meetings.AvailableFeatures
Determine if recording feature is available in the UI.
getIsWhiteboardAvailable() - Method in class com.vonage.client.meetings.AvailableFeatures
Determine if whiteboard feature is available in the UI.
getItemPrice() - Method in class com.vonage.client.messages.whatsapp.ProductItem
The unit price for this specific item.
getItems() - Method in class com.vonage.client.proactiveconnect.ListItemsResponse
Gets the items contained in the _embedded response.
getItemsCount() - Method in class com.vonage.client.proactiveconnect.ContactsList
The total number of list items.
getJobId() - Method in class com.vonage.client.proactiveconnect.Event
Unique identifier for the job.
getJoinApprovalLevel() - Method in class com.vonage.client.meetings.MeetingRoom
The level of approval needed to join the meeting in the room.
getJoinApprovalLevel() - Method in class com.vonage.client.meetings.UpdateRoomRequest
The level of approval needed to join the meeting in the room.
getKey() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
Logo's key in storage system.
getKey() - Method in class com.vonage.client.proactiveconnect.ListAttribute
Will be true if this attribute should be used to correlate between 2 or more lists.
getKeys() - Method in class com.vonage.client.application.Application
Cryptographic keys associated with this application.
getKeyword() - Method in class com.vonage.client.incoming.MessageEvent
 
getKeyword() - Method in class com.vonage.client.messages.sms.SmsInboundMetadata
The first word of the message sent to uppercase.
getKeyword() - Method in class com.vonage.client.sms.callback.messages.MO
 
getLanguage() - Method in class com.vonage.client.meetings.UISettings
Language setting.
getLanguage() - Method in class com.vonage.client.voice.ncco.PayAction.Voice
Deprecated.
 
getLanguage() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getLanguage() - Method in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
getLanguage() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getLanguage() - Method in class com.vonage.client.voice.TalkPayload
The Language that will be used to convert text into speech.
getLanguage() - Method in enum class com.vonage.client.voice.TextToSpeechLanguage
 
getLast() - Method in class com.vonage.client.voice.PageLinks
 
getLastEventDate() - Method in class com.vonage.client.verify.VerifyDetails
 
getLastName() - Method in class com.vonage.client.insight.CallerIdentity
 
getLastName() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getLastUrl() - Method in class com.vonage.client.common.HalLinks
The href property of last.
getLatitude() - Method in class com.vonage.client.messages.whatsapp.Location
 
getLength() - Method in class com.vonage.client.verify.BaseRequest
 
getLengthTimer() - Method in class com.vonage.client.voice.Call
 
getLevel() - Method in class com.vonage.client.voice.ncco.StreamAction
 
getLevel() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getLevel() - Method in class com.vonage.client.voice.TalkPayload
The volume level that the speech is played at, between -1 and 1.
getLimit() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getLinks() - Method in class com.vonage.client.common.HalPageResponse
The _links property in the HAL response.
getLinks() - Method in class com.vonage.client.meetings.MeetingRoom
Useful links.
getLinks() - Method in class com.vonage.client.voice.CallInfoPage
 
getList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Retrieve a list.
getListId() - Method in class com.vonage.client.proactiveconnect.ListItem
Unique identifier for this list.
getListItem(UUID, UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Retrieve a list item.
getLists() - Method in class com.vonage.client.proactiveconnect.ListListsResponse
Gets the lists contained in the _embedded response.
getLocale() - Method in class com.vonage.client.meetings.DialInNumber
The number locale.
getLocale() - Method in class com.vonage.client.messages.whatsapp.Whatsapp
 
getLocale() - Method in class com.vonage.client.verify.BaseRequest
 
getLocale() - Method in class com.vonage.client.verify2.VerificationRequest
Language for the request in ISO_639-1 format.
getLogoType() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
Logo's type.
getLongitude() - Method in class com.vonage.client.messages.whatsapp.Location
 
getLookupOutcome() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getLookupOutcomeMessage() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getLoop() - Method in class com.vonage.client.voice.ncco.StreamAction
 
getLoop() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getLoop() - Method in class com.vonage.client.voice.TalkPayload
The number of times the audio file at stream_url is repeated before the stream ends (0 for infinite).
getMachineDetection() - Method in class com.vonage.client.voice.Call
 
getMachineDetection() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getMainColor() - Method in class com.vonage.client.meetings.Theme
Main colour hex code.
getMaxApiCallsPerSecond() - Method in class com.vonage.client.account.SettingsResponse
 
getMaxDigits() - Method in class com.vonage.client.voice.ncco.DtmfSettings
 
getMaxDuration() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getMaxInboundMessagesPerSecond() - Method in class com.vonage.client.account.SettingsResponse
 
getMaxOutboundMessagesPerSecond() - Method in class com.vonage.client.account.SettingsResponse
 
getMcc() - Method in class com.vonage.client.account.Network
 
getMeetingCode() - Method in class com.vonage.client.meetings.MeetingRoom
The meeting code, which is used in the URL to join the meeting.
getMeetingsClient() - Method in class com.vonage.client.VonageClient
 
getMessage() - Method in exception com.vonage.client.auth.VonageUnacceptableAuthException
 
getMessage() - Method in exception com.vonage.client.meetings.MeetingsResponseException
 
getMessage() - Method in class com.vonage.client.voice.DtmfResponse
 
getMessage() - Method in class com.vonage.client.voice.ModifyCallResponse
 
getMessage() - Method in class com.vonage.client.voice.StreamResponse
 
getMessage() - Method in class com.vonage.client.voice.TalkResponse
 
getMessage() - Method in exception com.vonage.client.VonageApiResponseException
 
getMessageBody() - Method in class com.vonage.client.sms.callback.messages.MO
 
getMessageBody() - Method in class com.vonage.client.sms.messages.BinaryMessage
 
getMessageBody() - Method in class com.vonage.client.sms.messages.TextMessage
 
getMessageClass() - Method in class com.vonage.client.sms.messages.Message
 
getMessageClass() - Method in enum class com.vonage.client.sms.messages.Message.MessageClass
 
getMessageCount() - Method in class com.vonage.client.sms.SmsSubmissionResponse
Message count.
getMessageFrom() - Method in class com.vonage.client.messages.whatsapp.Context
The phone number of the original sender of the message being quoted.
getMessageId() - Method in class com.vonage.client.conversion.ConversionRequest
 
getMessageId() - Method in class com.vonage.client.incoming.MessageEvent
 
getMessageId() - Method in class com.vonage.client.sms.callback.messages.MO
 
getMessagePrice() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getMessages() - Method in class com.vonage.client.application.Application.Capabilities
Messages capability.
getMessages() - Method in class com.vonage.client.sms.SmsSubmissionResponse
Responses for each of the messages.
getMessagesCallbackValue() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
getMessagesClient() - Method in class com.vonage.client.VonageClient
 
getMessageStatus() - Method in enum class com.vonage.client.sms.MessageStatus
 
getMessageTimestamp() - Method in class com.vonage.client.incoming.MessageEvent
 
getMessageType() - Method in class com.vonage.client.messages.InboundMessage
The media type of the message.
getMessageType() - Method in class com.vonage.client.messages.MessageRequest
 
getMessageType() - Method in class com.vonage.client.sms.callback.messages.MO
 
getMessageUuid() - Method in class com.vonage.client.messages.InboundMessage
Unique identifier of the message that was sent.
getMessageUuid() - Method in class com.vonage.client.messages.MessageResponse
Returns the UUID of the message that was sent.
getMessageUuid() - Method in class com.vonage.client.messages.MessageStatus
Unique identifier of the message that was sent, as returned in MessageResponse.getMessageUuid().
getMessageUuid() - Method in class com.vonage.client.messages.whatsapp.Context
The UUID of the message being quoted.
getMessenger() - Method in class com.vonage.client.messages.messenger.MessengerRequest
 
getMessenger() - Method in class com.vonage.client.users.channels.Channels
Messenger channels.
getMetadata() - Method in class com.vonage.client.meetings.MeetingRoom
Free text that can be attached to a room.
getMetadataModified() - Method in class com.vonage.client.proactiveconnect.SyncStatus
Whether the list definition has been modified since last sync.
getMethod() - Method in class com.vonage.client.common.Webhook
The HTTP request method for this webhook.
getMicrophoneState() - Method in class com.vonage.client.meetings.InitialJoinOptions
The default microphone option for users in the pre-join screen of this room.
getMms() - Method in class com.vonage.client.users.channels.Channels
MMS channels.
getMnc() - Method in class com.vonage.client.account.Network
 
getMode() - Method in class com.vonage.client.voice.AdvancedMachineDetection
Detect if machine answered and sends a human or machine status in the webhook payload.
getMoHttpUrl() - Method in class com.vonage.client.numbers.OwnedNumber
 
getMoHttpUrl() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
getMoSmppSysType() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
getMsisdn() - Method in class com.vonage.client.incoming.MessageEvent
 
getMsisdn() - Method in class com.vonage.client.numbers.AvailableNumber
 
getMsisdn() - Method in class com.vonage.client.numbers.CancelNumberRequest
 
getMsisdn() - Method in class com.vonage.client.numbers.OwnedNumber
 
getMusicOnHoldUrl() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getName() - Method in class com.vonage.client.account.Country
 
getName() - Method in class com.vonage.client.account.Network
 
getName() - Method in class com.vonage.client.application.Application
Friendly identifier for your application.
getName() - Method in enum class com.vonage.client.common.Webhook.Type
 
getName() - Method in class com.vonage.client.insight.CallerIdentity
 
getName() - Method in class com.vonage.client.insight.CarrierDetails
 
getName() - Method in exception com.vonage.client.meetings.MeetingsResponseException
 
getName() - Method in class com.vonage.client.messages.viber.File
 
getName() - Method in class com.vonage.client.messages.whatsapp.Location
 
getName() - Method in class com.vonage.client.messages.whatsapp.Profile
The WhatsApp number's displayed profile name.
getName() - Method in class com.vonage.client.messages.whatsapp.Template
 
getName() - Method in class com.vonage.client.proactiveconnect.ContactsList
The name of the resource (max 255 characters).
getName() - Method in class com.vonage.client.proactiveconnect.ListAttribute
List attribute name.
getName() - Method in class com.vonage.client.subaccounts.Account
Name of the subaccount.
getName() - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest
Name of the subaccount.
getName() - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest
(OPTIONAL) Name of the subaccount.
getName() - Method in class com.vonage.client.users.BaseUser
Unique name of the user.
getName() - Method in class com.vonage.client.users.ListUsersRequest
Unique name for a user to filter by.
getName() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getNationalFormatNumber() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getNcco() - Method in class com.vonage.client.voice.Call
 
getNcco() - Method in class com.vonage.client.voice.TransferDestination
Deprecated.
 
getNetwork() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getNetwork() - Method in class com.vonage.client.verify.VerifyResponse
 
getNetwork() - Method in class com.vonage.client.voice.CallInfo
 
getNetworkCode() - Method in class com.vonage.client.insight.CarrierDetails
 
getNetworkCode() - Method in class com.vonage.client.sms.callback.messages.MO
 
getNetworks() - Method in class com.vonage.client.account.PricingResponse
 
getNetworkType() - Method in class com.vonage.client.insight.CarrierDetails
 
getNext() - Method in class com.vonage.client.voice.PageLinks
 
getNextEventWait() - Method in class com.vonage.client.verify.BaseRequest
The wait time between attempts to deliver the PIN.
getNextUrl() - Method in class com.vonage.client.common.HalLinks
The href property of next.
getNonce() - Method in class com.vonage.client.incoming.MessageEvent
 
getNumber() - Method in class com.vonage.client.insight.BaseInsightRequest
 
getNumber() - Method in class com.vonage.client.meetings.DialInNumber
The dial-in number.
getNumber() - Method in class com.vonage.client.subaccounts.NumberTransfer
The number being transferred between accounts.
getNumber() - Method in class com.vonage.client.users.channels.Whatsapp
Phone number for this channel.
getNumber() - Method in class com.vonage.client.verify.BaseRequest
 
getNumber() - Method in class com.vonage.client.verify.VerifyDetails
 
getNumber() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint
The phone number to connect to in E.164 format.
getNumber() - Method in class com.vonage.client.voice.PhoneEndpoint
The phone number to connect to in E.164 format.
getNumbers() - Method in class com.vonage.client.numbers.ListNumbersResponse
 
getNumbers() - Method in class com.vonage.client.numbers.SearchNumbersResponse
Obtain an array of matching numbers than are available to buy.
getNumbersClient() - Method in class com.vonage.client.VonageClient
 
getNumMessages() - Method in class com.vonage.client.messages.sms.SmsInboundMetadata
The number of inbound SMS messages concatenated together to comprise this message.
getOccurredAt() - Method in class com.vonage.client.proactiveconnect.Event
Date and time the event occurred in ISO 8601 format.
getOnAnswer() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint
 
getOrder() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Sort in either ascending or descending order.
getOrder() - Method in class com.vonage.client.users.ListUsersRequest
The time order to return results in.
getOrder() - Method in class com.vonage.client.voice.CallsFilter
 
getOriginalCarrier() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getPage() - Method in class com.vonage.client.application.ListApplicationRequest
 
getPage() - Method in class com.vonage.client.common.HalPageResponse
Current page.
getPageSize() - Method in class com.vonage.client.application.ListApplicationRequest
 
getPageSize() - Method in class com.vonage.client.common.HalPageResponse
Size of each page.
getPageSize() - Method in class com.vonage.client.users.ListUsersRequest
Number of records to return in the response.
getPageSize() - Method in class com.vonage.client.voice.CallInfoPage
 
getPageSize() - Method in class com.vonage.client.voice.CallsFilter
 
getParameters() - Method in class com.vonage.client.messages.whatsapp.Template
 
getParticipantId() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Unique identifier for the participant.
getParticipantName() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The participant name.
getParticipantType() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The participant type (e.g.
getPassword() - Method in class com.vonage.client.users.channels.Sip
SIP user password.
getPattern() - Method in class com.vonage.client.numbers.ListNumbersFilter
 
getPattern() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getPayee() - Method in class com.vonage.client.verify.Psd2Request
 
getPayload() - Method in class com.vonage.client.incoming.NotifyEvent
 
getPayload() - Method in class com.vonage.client.voice.ncco.NotifyAction
 
getPinCode() - Method in class com.vonage.client.verify.VerifyRequest
A custom PIN to send to the user.
getPinExpiry() - Method in class com.vonage.client.verify.BaseRequest
How long the generated verification code is valid for, in seconds.
getPolicy() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
getPolicy() - Method in class com.vonage.client.messages.whatsapp.Whatsapp
 
getPorted() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getPrefixPrice(ServiceType, String) - Method in class com.vonage.client.account.AccountClient
Retrieve the pricing for a specified prefix.
getPremium() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getPremium() - Method in class com.vonage.client.voice.TalkPayload
Whether the premium version of the specified voice style should be used if available.
getPrev() - Method in class com.vonage.client.voice.PageLinks
 
getPrevUrl() - Method in class com.vonage.client.common.HalLinks
The href property of prev.
getPrice() - Method in class com.vonage.client.account.Network
 
getPrice() - Method in class com.vonage.client.messages.MessageStatus.Usage
The amount charged for the message.
getPrice() - Method in class com.vonage.client.sms.callback.messages.MO
 
getPrice() - Method in class com.vonage.client.verify.CheckResponse
 
getPrice() - Method in class com.vonage.client.verify.VerifyDetails
 
getPrice() - Method in class com.vonage.client.voice.CallInfo
 
getPrimaryAccount() - Method in class com.vonage.client.subaccounts.ListSubaccountsResponse
Parent account.
getPrimaryAccountApiKey() - Method in class com.vonage.client.subaccounts.Account
Unique primary account ID.
getPrimaryAccountId() - Method in class com.vonage.client.subaccounts.NumberTransfer
Primary account ID for this transaction.
getPrivacy() - Method in class com.vonage.client.application.Application
Application privacy configuration.
getPrivateKey() - Method in class com.vonage.client.application.Application.Keys
The application's private key.
getProactiveConnectClient() - Method in class com.vonage.client.VonageClient
 
getProduct() - Method in class com.vonage.client.redact.RedactRequest
 
getProductItems() - Method in class com.vonage.client.messages.whatsapp.Order
 
getProductRetailerId() - Method in class com.vonage.client.messages.whatsapp.ProductItem
The ID of the specific product being ordered.
getProductRetailerId() - Method in class com.vonage.client.messages.whatsapp.ReferredProduct
The ID of the product from the product message being quoted or replied to using the 'Message Business' option.
getPrompts() - Method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
 
getProtocolId() - Method in class com.vonage.client.sms.messages.BinaryMessage
 
getProviderMessage() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getChannel() is Channel.WHATSAPP, returns the provider_message field.
getPstn() - Method in class com.vonage.client.users.channels.Channels
PSTN channels.
getPublicKey() - Method in class com.vonage.client.application.Application.Keys
The application's public key.
getQuantity() - Method in class com.vonage.client.messages.whatsapp.ProductItem
The quantity ordered for this specific item.
getQueryParameters() - Method in class com.vonage.client.sns.request.SnsPublishRequest
 
getQueryParameters() - Method in class com.vonage.client.sns.request.SnsRequest
 
getRate() - Method in class com.vonage.client.voice.CallInfo
 
getReachability() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getRealTimeData() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
getRealTimeData() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getRecipientId() - Method in class com.vonage.client.proactiveconnect.Event
String identifier of a recipient, for example their email, phone number etc.
getRecipientId() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Recipient ID to filter by.
getRecord() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getRecordIndex() - Method in class com.vonage.client.voice.CallInfoPage
 
getRecordIndex() - Method in class com.vonage.client.voice.CallsFilter
 
getRecording(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Get details of a recording.
getRecordingId() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Unique recording ID for the meeting.
getRecordingOptions() - Method in class com.vonage.client.meetings.MeetingRoom
Options for recording.
getRecordingsCallbackUrl() - Method in class com.vonage.client.meetings.CallbackUrls
Callback url for recordings events, overrides application level recordings callback URL.
getRecordingUrl() - Method in class com.vonage.client.meetings.MeetingsEventCallback
URL of the uploaded recording.
getRecordOnlyOwner() - Method in class com.vonage.client.meetings.RecordingOptions
Record only the owner screen or any share screen of the video.
getRedactClient() - Method in class com.vonage.client.VonageClient
Deprecated.
This API will be removed in the next major release.
getReference() - Method in class com.vonage.client.subaccounts.MoneyTransfer
Reference for the transfer.
getReferredProduct() - Method in class com.vonage.client.messages.whatsapp.Context
Only applies to Order messages.
getRefundPrice() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getRegion() - Method in class com.vonage.client.application.capabilities.Voice
The region which all inbound, programmable SIP and SIP connect calls will be sent to unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
getRemainingBalance() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getRemainingBalance() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getRequestId() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getRequestId() - Method in class com.vonage.client.verify.CheckRequest
This is the request_id you received in the response to the Verify request.
getRequestId() - Method in class com.vonage.client.verify.CheckResponse
 
getRequestId() - Method in class com.vonage.client.verify.ControlRequest
 
getRequestId() - Method in class com.vonage.client.verify.VerifyDetails
 
getRequestId() - Method in class com.vonage.client.verify.VerifyResponse
 
getRequestId() - Method in class com.vonage.client.verify2.VerificationCallback
The ID of the request.
getRequestId() - Method in class com.vonage.client.verify2.VerificationResponse
Returns the UUID of the request that was sent.
getRequestId() - Method in exception com.vonage.client.verify2.VerifyResponseException
The request ID, if the status code is 409 for a failed outbound request.
getRequestIds() - Method in class com.vonage.client.verify.SearchRequest
 
getRequestPrice() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getRestBaseUri() - Method in class com.vonage.client.HttpConfig
 
getResultCode() - Method in class com.vonage.client.sns.response.SnsResponse
 
getResultMessage() - Method in class com.vonage.client.sns.response.SnsResponse
 
getResults() - Method in class com.vonage.client.incoming.SpeechResults
 
getRingback() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.OnAnswer
 
getRingingTimer() - Method in class com.vonage.client.voice.Call
 
getRoaming() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getRoamingCountryCode() - Method in class com.vonage.client.insight.RoamingDetails
 
getRoamingNetworkCode() - Method in class com.vonage.client.insight.RoamingDetails
 
getRoamingNetworkName() - Method in class com.vonage.client.insight.RoamingDetails
 
getRoom(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Get details of an existing room.
getRoomId() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Meeting room's ID.
getRoomsCallbackUrl() - Method in class com.vonage.client.meetings.CallbackUrls
Callback url for rooms events, overrides application level rooms callback URL.
getRoomType() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The type of meeting room.
getRtc() - Method in class com.vonage.client.application.Application.Capabilities
RTC capability.
getRunId() - Method in class com.vonage.client.proactiveconnect.Event
Unique identifier for the run.
getRunId() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Run ID to filter by.
getRunItemId() - Method in class com.vonage.client.proactiveconnect.Event
Identifier for the item ID during a job run - this is the list item ID which is copied while taking the list snapshot.
getRunItemId() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Run item ID to filter by.
getSandbox() - Method in class com.vonage.client.verify2.SilentAuthWorkflow
Optional parameter if using the Vonage Sandbox to test Silent Auth integrations.
getSearchPattern() - Method in class com.vonage.client.numbers.ListNumbersFilter
 
getSearchPattern() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getSecret() - Method in class com.vonage.client.subaccounts.Account
API secret of the subaccount.
getSecret() - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest
Subaccount API secret.
getSecret(String) - Method in class com.vonage.client.account.AccountClient
Get information for a specific secret id associated with this account's main API key.
getSecret(String, String) - Method in class com.vonage.client.account.AccountClient
Get information for a specific secret id associated to a given API key.
getSecrets() - Method in class com.vonage.client.account.ListSecretsResponse
 
getSelf() - Method in class com.vonage.client.account.ListSecretsResponse
Deprecated.
getSelf() - Method in class com.vonage.client.account.SecretResponse
 
getSelf() - Method in class com.vonage.client.voice.PageLinks
 
getSelfUrl() - Method in class com.vonage.client.common.HalLinks
The href property of self.
getSender() - Method in class com.vonage.client.sms.callback.messages.MO
 
getSenderId() - Method in class com.vonage.client.verify.VerifyDetails
 
getSessionId() - Method in class com.vonage.client.meetings.MeetingsEventCallback
Corresponds to the underlying Video API session ID.
getSessionId() - Method in class com.vonage.client.meetings.Recording
Corresponds to the underlying Video API session ID.
getSessionId() - Method in class com.vonage.client.sms.callback.messages.MO
 
getSessionsCallbackUrl() - Method in class com.vonage.client.meetings.CallbackUrls
Callback url for sessions events, overrides application level sessions callback URL.
getShortCompanyUrl() - Method in class com.vonage.client.meetings.Theme
Company name to include in the URL.
getSignedCallbacks() - Method in class com.vonage.client.application.capabilities.Voice
Whether to use signed webhooks for this capability.
getSilentAuthUrl() - Method in class com.vonage.client.verify2.VerificationCallback
If VerificationCallback.getChannel() is Channel.SILENT_AUTH, this will return the URL for Silent Auth Verify workflow completion, null otherwise.
getSip() - Method in class com.vonage.client.users.channels.Channels
SIP channels.
getSize() - Method in class com.vonage.client.incoming.RecordEvent
 
getSize() - Method in class com.vonage.client.numbers.ListNumbersFilter
 
getSize() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getSms() - Method in class com.vonage.client.users.channels.Channels
SMS channels.
getSmsClient() - Method in class com.vonage.client.VonageClient
 
getSmsMetadata() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.SMS, returns additional information about the message.
getSmsPrice(String) - Method in class com.vonage.client.account.AccountClient
Retrieve the SMS pricing for a specified country.
getSnsBaseUri() - Method in class com.vonage.client.HttpConfig
 
getSnsClient() - Method in class com.vonage.client.VonageClient
 
getSocketTimeout() - Method in class com.vonage.client.common.Webhook
If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint.
getSoql() - Method in class com.vonage.client.proactiveconnect.SalesforceDatasource
Salesforce query defining which data to fetch from salesforce.
getSortKey() - Method in interface com.vonage.client.auth.AuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.JWTAuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.SignatureAuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.TokenAuthMethod
 
getSourceContext() - Method in class com.vonage.client.proactiveconnect.Event
The name of the segment or matcher.
getSourceContext() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
The name of the segment / matcher the item / event to filter by (exact string).
getSourceType() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Source type to filter by.
getSpeech() - Method in class com.vonage.client.incoming.InputEvent
 
getSpeech() - Method in class com.vonage.client.voice.ncco.InputAction
 
getSplit() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getStandardNumberInsight(StandardInsightRequest) - Method in class com.vonage.client.insight.InsightClient
Perform a Standard Insight Request with a StandardInsightRequest.
getStandardNumberInsight(String) - Method in class com.vonage.client.insight.InsightClient
Perform a Standard Insight Request with a number.
getStandardNumberInsight(String, String) - Method in class com.vonage.client.insight.InsightClient
Perform a Standard Insight Request with a number and country.
getStartDate() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
ISO-8601 formatted date for when to begin events filter.
getStartDate() - Method in class com.vonage.client.subaccounts.ListTransfersFilter
Start of the retrieval period.
getStartedAt() - Method in class com.vonage.client.meetings.MeetingsEventCallback
The date-time when the session started, expressed in ISO 8601 format.
getStartedAt() - Method in class com.vonage.client.meetings.Recording
Recording start time, in ISO 8601 format.
getStartOnEnter() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getStartTime() - Method in class com.vonage.client.incoming.RecordEvent
 
getStartTime() - Method in class com.vonage.client.voice.CallInfo
 
getStartTimeout() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getStatus() - Method in class com.vonage.client.incoming.CallEvent
 
getStatus() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getStatus() - Method in class com.vonage.client.insight.RoamingDetails
 
getStatus() - Method in class com.vonage.client.meetings.Recording
Status of the recording.
getStatus() - Method in class com.vonage.client.messages.MessageStatus
The status of the message.
getStatus() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getStatus() - Method in class com.vonage.client.verify.BaseResult
Deprecated.
 
getStatus() - Method in class com.vonage.client.verify.CheckResponse
 
getStatus() - Method in class com.vonage.client.verify.ControlResponse
 
getStatus() - Method in class com.vonage.client.verify.SearchVerifyResponse
 
getStatus() - Method in class com.vonage.client.verify.VerifyCheck
 
getStatus() - Method in class com.vonage.client.verify.VerifyDetails
 
getStatus() - Method in enum class com.vonage.client.verify.VerifyDetails.Status
 
getStatus() - Method in exception com.vonage.client.verify.VerifyException
 
getStatus() - Method in class com.vonage.client.verify.VerifyResponse
 
getStatus() - Method in class com.vonage.client.verify2.VerificationCallback
Current status of this request.
getStatus() - Method in class com.vonage.client.verify2.WorkflowStatus
State of the verification workflow.
getStatus() - Method in class com.vonage.client.voice.CallEvent
 
getStatus() - Method in class com.vonage.client.voice.CallInfo
 
getStatus() - Method in class com.vonage.client.voice.CallsFilter
 
getStatusCode() - Method in exception com.vonage.client.VonageApiResponseException
The API response status code, usually 4xx or 500.
getStatusMessage() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getStatusReportRequired() - Method in class com.vonage.client.sms.messages.Message
 
getSticker() - Method in class com.vonage.client.messages.whatsapp.WhatsappStickerRequest
 
getStickerUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.STICKER, returns the URL of the sticker.
getStreamUrl() - Method in class com.vonage.client.voice.ncco.StreamAction
 
getStyle() - Method in class com.vonage.client.voice.ncco.PayAction.Voice
Deprecated.
 
getStyle() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getStyle() - Method in class com.vonage.client.voice.TalkPayload
The Vocal Style to use (range, tessitura, timbre) to use in the speech.
getSubaccount() - Method in class com.vonage.client.subaccounts.ListTransfersFilter
Subaccount API key to filter by.
getSubaccount(String) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Get information about a specific subaccount.
getSubaccounts() - Method in class com.vonage.client.subaccounts.ListSubaccountsResponse
The subaccounts associated with the primary account.
getSubaccountsClient() - Method in class com.vonage.client.VonageClient
 
getSubmittedAt() - Method in class com.vonage.client.verify2.VerificationCallback
If VerificationCallback.getType() is CallbackType.SUMMARY, this will return the date-time the verification request was submitted in ISO 8601 format, null otherwise.
getSubscriberArn() - Method in class com.vonage.client.sns.response.SnsSubscribeResponse
 
getSupportedMessageTypes() - Method in enum class com.vonage.client.messages.Channel
This method is useful for determining which message types are applicable to this messaging service.
getSupportedOutboundMessageTypes() - Method in enum class com.vonage.client.messages.Channel
Similar to Channel.getSupportedMessageTypes() but excludes message types used only for inbound / webhooks.
getSuspended() - Method in class com.vonage.client.subaccounts.Account
Subaccount suspension status.
getSuspended() - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest
(OPTIONAL) Whether to suspend this subaccount.
getSyncStatus() - Method in class com.vonage.client.proactiveconnect.ContactsList
Synchronization status between the list content (items) and its datasource.
getTag() - Method in class com.vonage.client.messages.messenger.Messenger
 
getTags() - Method in class com.vonage.client.proactiveconnect.ContactsList
Up to 10 custom strings assigned with a resource - each must be between 1 and 15 characters.
getTemplate() - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest
 
getText() - Method in class com.vonage.client.incoming.MessageEvent
 
getText() - Method in class com.vonage.client.incoming.Result
 
getText() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.TEXT, returns the message text.
getText() - Method in class com.vonage.client.messages.messenger.MessengerTextRequest
 
getText() - Method in class com.vonage.client.messages.sms.SmsTextRequest
 
getText() - Method in class com.vonage.client.messages.viber.Action
 
getText() - Method in class com.vonage.client.messages.viber.ViberTextRequest
 
getText() - Method in class com.vonage.client.messages.whatsapp.WhatsappTextRequest
 
getText() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Errors.Error
Deprecated.
 
getText() - Method in class com.vonage.client.voice.ncco.PaymentPrompt
Deprecated.
 
getText() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getText() - Method in class com.vonage.client.voice.TalkPayload
A string of up to 1500 characters containing the message to be synthesized in the Call or Conversation.
getTheme(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Retrieve details of a theme by ID.
getThemeId() - Method in class com.vonage.client.meetings.MeetingRoom
ID of the theme for this room.
getThemeId() - Method in class com.vonage.client.meetings.Theme
Unique theme ID.
getThemeId() - Method in class com.vonage.client.meetings.UpdateRoomRequest
ID of the theme for this room.
getThemeName() - Method in class com.vonage.client.meetings.Theme
Theme name.
getThumbUrl() - Method in class com.vonage.client.messages.viber.Video
 
getTimeout() - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Errors
Deprecated.
 
getTimeOut() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getTimeOut() - Method in class com.vonage.client.voice.ncco.DtmfSettings
 
getTimeOut() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getTimeoutMillis() - Method in class com.vonage.client.HttpConfig
Gets the timeout setting for the underlying HTTP client configuration.
getTimeoutReason() - Method in class com.vonage.client.incoming.SpeechResults
 
getTimestamp() - Method in class com.vonage.client.conversion.ConversionRequest
 
getTimestamp() - Method in class com.vonage.client.incoming.CallEvent
 
getTimestamp() - Method in class com.vonage.client.incoming.InputEvent
 
getTimestamp() - Method in class com.vonage.client.incoming.MessageEvent
 
getTimestamp() - Method in class com.vonage.client.incoming.NotifyEvent
 
getTimestamp() - Method in class com.vonage.client.incoming.RecordEvent
 
getTimestamp() - Method in class com.vonage.client.messages.InboundMessage
The datetime of when the event occurred.
getTimestamp() - Method in class com.vonage.client.messages.MessageStatus
The datetime of when the event occurred.
getTimeStamp() - Method in class com.vonage.client.sms.callback.messages.MO
 
getTimeToLive() - Method in class com.vonage.client.sms.messages.Message
 
getTitle() - Method in class com.vonage.client.messages.MessageStatus.Error
The error code encountered when sending the message.
getTitle() - Method in class com.vonage.client.messages.whatsapp.Reply
The title displayed on the interactive option chosen.
getTitle() - Method in class com.vonage.client.sms.messages.WapPushMessage
Deprecated.
 
getTitle() - Method in exception com.vonage.client.VonageApiResponseException
Brief description / name of the error.
getTo() - Method in class com.vonage.client.incoming.CallEvent
 
getTo() - Method in class com.vonage.client.incoming.InputEvent
 
getTo() - Method in class com.vonage.client.incoming.MessageEvent
 
getTo() - Method in class com.vonage.client.messages.InboundMessage
The number this message was sent to.
getTo() - Method in class com.vonage.client.messages.MessageRequest
 
getTo() - Method in class com.vonage.client.messages.MessageStatus
The 'to' number used in the outbound MessageRequest.
getTo() - Method in class com.vonage.client.sms.messages.Message
 
getTo() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getTo() - Method in class com.vonage.client.subaccounts.NumberTransfer
Account to transfer to.
getTo() - Method in class com.vonage.client.verify2.EmailWorkflow
The email address to send the verification request to.
getTo() - Method in class com.vonage.client.verify2.Workflow
The phone number to contact with the message.
getTo() - Method in class com.vonage.client.voice.Call
 
getTo() - Method in class com.vonage.client.voice.CallInfo
 
getTotalCount() - Method in class com.vonage.client.messages.sms.SmsInboundMetadata
The number of inbound SMS messages concatenated together to comprise this message.
getTotalItems() - Method in class com.vonage.client.common.HalPageResponse
Size of this page.
getTotalPages() - Method in class com.vonage.client.common.HalPageResponse
Number of results pages.
getTraceId() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Trace ID to filter by.
getTransactionId() - Method in class com.vonage.client.sns.response.SnsPublishResponse
 
getTriggeredAt() - Method in class com.vonage.client.verify2.VerificationCallback
If VerificationCallback.getType() is CallbackType.EVENT, this will return the date-time the verification request was triggered in ISO 8601 format, null otherwise.
getTtl() - Method in class com.vonage.client.messages.viber.ViberService
 
getType() - Method in class com.vonage.client.account.Network
 
getType() - Method in class com.vonage.client.application.capabilities.Capability
The capability's type.
getType() - Method in class com.vonage.client.application.capabilities.Messages
 
getType() - Method in class com.vonage.client.application.capabilities.Rtc
 
getType() - Method in class com.vonage.client.application.capabilities.Vbc
 
getType() - Method in class com.vonage.client.application.capabilities.Voice
 
getType() - Method in class com.vonage.client.conversion.ConversionRequest
 
getType() - Method in class com.vonage.client.incoming.MessageEvent
 
getType() - Method in class com.vonage.client.insight.CallerIdentity
 
getType() - Method in class com.vonage.client.meetings.MeetingRoom
Type of room.
getType() - Method in class com.vonage.client.messages.MessageStatus.Error
The type of error encountered.
getType() - Method in class com.vonage.client.messages.viber.ViberService
 
getType() - Method in class com.vonage.client.numbers.AvailableNumber
 
getType() - Method in class com.vonage.client.numbers.OwnedNumber
 
getType() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
getType() - Method in enum class com.vonage.client.numbers.Type
 
getType() - Method in class com.vonage.client.proactiveconnect.Datasource
Name of the datasource.
getType() - Method in class com.vonage.client.proactiveconnect.Event
Classification of the event.
getType() - Method in class com.vonage.client.redact.RedactRequest
 
getType() - Method in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
 
getType() - Method in class com.vonage.client.sms.messages.Message
 
getType() - Method in class com.vonage.client.sms.messages.TextMessage
Gets the MessageType.
getType() - Method in class com.vonage.client.verify.VerifyRequest
Deprecated.
This is no longer used and will be removed in the next major release.
getType() - Method in class com.vonage.client.verify2.VerificationCallback
Type of response.
getType() - Method in class com.vonage.client.voice.AppEndpoint
 
getType() - Method in interface com.vonage.client.voice.Endpoint
Endpoint type name.
getType() - Method in class com.vonage.client.voice.ncco.AppEndpoint
 
getType() - Method in interface com.vonage.client.voice.ncco.Endpoint
 
getType() - Method in class com.vonage.client.voice.ncco.InputAction
 
getType() - Method in class com.vonage.client.voice.ncco.PaymentPrompt
Deprecated.
 
getType() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint
 
getType() - Method in class com.vonage.client.voice.ncco.SipEndpoint
 
getType() - Method in class com.vonage.client.voice.ncco.VbcEndpoint
 
getType() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
getType() - Method in class com.vonage.client.voice.PhoneEndpoint
 
getType() - Method in class com.vonage.client.voice.SipEndpoint
 
getType() - Method in class com.vonage.client.voice.TransferDestination
Deprecated.
 
getType() - Method in class com.vonage.client.voice.VbcEndpoint
 
getType() - Method in class com.vonage.client.voice.WebSocketEndpoint
 
getType() - Method in exception com.vonage.client.VonageApiResponseException
Link to the API error type.
getUdh() - Method in class com.vonage.client.incoming.MessageEvent
 
getUdh() - Method in class com.vonage.client.sms.messages.BinaryMessage
 
getUiSettings() - Method in class com.vonage.client.meetings.MeetingRoom
Settings for the user interface of this meeting.
getUnmappedProperties() - Method in class com.vonage.client.messages.InboundMessage
This is a catch-all method which encapsulates all fields in the response JSON that are not already a field in this class.
getUpdated() - Method in class com.vonage.client.proactiveconnect.UploadListItemsResponse
Items updated in the list.
getUpdatedAt() - Method in class com.vonage.client.proactiveconnect.ContactsList
The last update timestamp in ISO 8601 format.
getUpdatedAt() - Method in class com.vonage.client.proactiveconnect.ListItem
Time this item was last updated, in ISO 8601 format.
getUri() - Method in class com.vonage.client.users.channels.Sip
Full SIP URI, including number, domain and (optionally) whether TLS is used.
getUri() - Method in class com.vonage.client.users.channels.Websocket
Full URI of the websocket.
getUri() - Method in class com.vonage.client.voice.ncco.SipEndpoint
 
getUri() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
getUri() - Method in class com.vonage.client.voice.SipEndpoint
 
getUri() - Method in class com.vonage.client.voice.WebSocketEndpoint
The URI to the websocket you are streaming to.
getUrl() - Method in class com.vonage.client.incoming.RecordEvent
 
getUrl() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse
Storage system URL.
getUrl() - Method in class com.vonage.client.meetings.Recording
The URL property of the _links response.
getUrl() - Method in class com.vonage.client.messages.internal.MessagePayload
 
getUrl() - Method in class com.vonage.client.messages.viber.Action
 
getUrl() - Method in class com.vonage.client.messages.whatsapp.Sticker
 
getUrl() - Method in class com.vonage.client.sms.messages.WapPushMessage
Deprecated.
 
getUrl() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.OnAnswer
 
getUrls() - Method in class com.vonage.client.voice.TransferDestination
Deprecated.
 
getUsage() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.SMS, returns the usage information (charged incurred for the message).
getUsage() - Method in class com.vonage.client.messages.MessageStatus
Describes the cost of the message that was sent.
getUsePrimaryAccountBalance() - Method in class com.vonage.client.subaccounts.Account
Flag showing if balance is shared with primary account.
getUsePrimaryAccountBalance() - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest
Whether to use the primary account's balance.
getUsePrimaryAccountBalance() - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest
(OPTIONAL) Whether to use the primary account's balance.
getUser() - Method in class com.vonage.client.voice.AppEndpoint
The username of the user to connect to.
getUser() - Method in class com.vonage.client.voice.ncco.AppEndpoint
The user to connect to.
getUser(String) - Method in class com.vonage.client.users.UsersClient
Retrieve a user.
getUserAgent() - Method in class com.vonage.client.HttpWrapper
 
getUserDataHeader() - Method in class com.vonage.client.sms.callback.messages.MO
 
getUserDetails(BaseUser) - Method in class com.vonage.client.users.UsersClient
Convenience method that uses the metadata from the base user object to obtain all known fields about the user.
getUserDetails(List<BaseUser>) - Method in class com.vonage.client.users.UsersClient
Convenience method that uses the metadata from the base users list to obtain all known fields about the users.
getUsername() - Method in class com.vonage.client.users.channels.Sip
SIP username.
getUsers() - Method in class com.vonage.client.users.ListUsersResponse
Retrieves the embedded resource contents.
getUsersClient() - Method in class com.vonage.client.VonageClient
 
getUuid() - Method in class com.vonage.client.incoming.CallEvent
 
getUuid() - Method in class com.vonage.client.incoming.InputEvent
 
getUuid() - Method in class com.vonage.client.incoming.RecordEvent
 
getUuid() - Method in class com.vonage.client.voice.CallEvent
 
getUuid() - Method in class com.vonage.client.voice.CallInfo
 
getUuid() - Method in class com.vonage.client.voice.CallModifier
Deprecated.
 
getUuid() - Method in class com.vonage.client.voice.DtmfResponse
 
getUuid() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getUuid() - Method in class com.vonage.client.voice.StreamResponse
 
getUuid() - Method in class com.vonage.client.voice.TalkResponse
 
getValidity() - Method in class com.vonage.client.sms.messages.WapPushMessage
Deprecated.
 
getValidNumber() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getValue() - Method in class com.vonage.client.account.BalanceResponse
 
getValue() - Method in enum class com.vonage.client.numbers.SearchPattern
 
getValue() - Method in class com.vonage.client.proactiveconnect.SyncStatus
Synchronization state of the list.
getValue() - Method in enum class com.vonage.client.redact.RedactRequest.Product
 
getValue() - Method in enum class com.vonage.client.redact.RedactRequest.Type
 
getValue() - Method in class com.vonage.client.voice.servlet.NccoResponseBuilder
 
getVbc() - Method in class com.vonage.client.application.Application.Capabilities
VBC capability.
getVbc() - Method in class com.vonage.client.users.channels.Channels
VBC channels.
getVcard() - Method in class com.vonage.client.messages.mms.MmsVcardRequest
 
getVcardUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.VCARD, returns the URL of the vCard.
getVerificationRequests() - Method in class com.vonage.client.verify.SearchVerifyResponse
 
getVerify2Client() - Method in class com.vonage.client.VonageClient
 
getVerifyClient() - Method in class com.vonage.client.VonageClient
 
getVerifyStatus() - Method in enum class com.vonage.client.verify.VerifyStatus
 
getVersionedApiBaseUri(String) - Method in class com.vonage.client.HttpConfig
 
getVersionedApiEuBaseUri(String) - Method in class com.vonage.client.HttpConfig
 
getVersionedRestBaseUri(String) - Method in class com.vonage.client.HttpConfig
 
getVersionedSnsBaseUri(String) - Method in class com.vonage.client.HttpConfig
 
getViber() - Method in class com.vonage.client.users.channels.Channels
Viber channels.
getViberService() - Method in class com.vonage.client.messages.viber.ViberRequest
 
getVideo() - Method in class com.vonage.client.messages.messenger.MessengerVideoRequest
 
getVideo() - Method in class com.vonage.client.messages.mms.MmsVideoRequest
 
getVideo() - Method in class com.vonage.client.messages.viber.ViberVideoRequest
 
getVideo() - Method in class com.vonage.client.messages.whatsapp.WhatsappVideoRequest
 
getVideoUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.VIDEO, returns the URL of the video.
getVoice() - Method in class com.vonage.client.application.Application.Capabilities
Voice capability.
getVoice() - Method in class com.vonage.client.voice.ncco.PayAction
Deprecated.
 
getVoiceCallbackType() - Method in class com.vonage.client.numbers.OwnedNumber
 
getVoiceCallbackType() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
getVoiceCallbackValue() - Method in class com.vonage.client.numbers.OwnedNumber
 
getVoiceCallbackValue() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
getVoiceClient() - Method in class com.vonage.client.VonageClient
 
getVoicePrice(String) - Method in class com.vonage.client.account.AccountClient
Retrieve the voice pricing for a specified country.
getVoiceStatusCallback() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
getWebhooks() - Method in class com.vonage.client.application.capabilities.Capability
Webhooks grouped by type.
getWebsocket() - Method in class com.vonage.client.users.channels.Channels
Websocket channels.
getWhatsapp() - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest
 
getWhatsapp() - Method in class com.vonage.client.users.channels.Channels
WhatsApp channels.
getWhatsappContext() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.WHATSAPP, returns the WhatsApp message context.
getWhatsappLocation() - Method in class com.vonage.client.messages.InboundMessage
getWhatsappOrder() - Method in class com.vonage.client.messages.InboundMessage
getWhatsappProfile() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.WHATSAPP, returns information about the sender's WhatsApp profile.
getWhatsappReply() - Method in class com.vonage.client.messages.InboundMessage
getWorkflow() - Method in class com.vonage.client.verify.Psd2Request
 
getWorkflow() - Method in class com.vonage.client.verify.VerifyRequest
 
getWorkflows() - Method in class com.vonage.client.verify2.VerificationCallback
If VerificationCallback.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.
getWorkflows() - Method in class com.vonage.client.verify2.VerificationRequest
Workflows are a sequence of actions that Vonage use to reach the user you wish to verify with a PIN code.
GREEK - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
GREEK - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
GREEK - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
GREEK_GREECE - Enum constant in enum class com.vonage.client.verify2.Locale
 
GUJARATI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
GUJARATI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 

H

HalLinks - Class in com.vonage.client.common
Represents the _links section of a HAL response.
HalLinks() - Constructor for class com.vonage.client.common.HalLinks
 
HalPageResponse - Class in com.vonage.client.common
Abstract base class for responses that conform to the HAL specification.
HalPageResponse() - Constructor for class com.vonage.client.common.HalPageResponse
 
handleRequest(HttpServletRequest) - Method in class com.vonage.client.voice.servlet.AbstractAnswerServlet
Deprecated.
Handle a request for NCCO instructions from the Vonage Voice API.
handsetStatus - Variable in class com.vonage.client.insight.RealTimeData
 
HANGUP - Enum constant in enum class com.vonage.client.voice.MachineDetection
 
HANGUP - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
hasAuthMethod(Class<? extends AuthMethod>) - Method in class com.vonage.client.auth.AuthCollection
Utility method for determining whether a certain authentication method has been registered.
hashCode() - Method in class com.vonage.client.messages.MessageStatus.Error
 
hashCode() - Method in class com.vonage.client.messages.MessageStatus
 
hashCode() - Method in class com.vonage.client.messages.MessageStatus.Usage
 
hashCode() - Method in class com.vonage.client.users.BaseUser
 
hashCode() - Method in class com.vonage.client.users.channels.Channels
 
hashCode() - Method in class com.vonage.client.users.channels.Messenger
 
hashCode() - Method in class com.vonage.client.users.channels.Whatsapp
 
hashCode() - Method in class com.vonage.client.users.channels.Sip
 
hashCode() - Method in class com.vonage.client.users.channels.Vbc
 
hashCode() - Method in class com.vonage.client.users.channels.Websocket
 
hashCode() - Method in class com.vonage.client.voice.PhoneEndpoint
 
hashCode() - Method in exception com.vonage.client.VonageApiResponseException
 
hashType(HashUtil.HashType) - Method in class com.vonage.client.VonageClient.Builder
 
HashUtil - Class in com.vonage.client.auth.hashutils
Utility methods for hashing strings.
HashUtil() - Constructor for class com.vonage.client.auth.hashutils.HashUtil
 
HashUtil.HashType - Enum Class in com.vonage.client.auth.hashutils
 
HAUSA - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
HE - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Hebrew
headers(Map<String, ?>) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
 
headers(Map<String, ?>) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
headerText(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder
(OPTIONAL) Sets the message header's text field.
HEBREW - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
HEBREW - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
HEBREW - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
HEBREW_ISRAEL - Enum constant in enum class com.vonage.client.verify2.Locale
 
hexToBytes(String) - Static method in class com.vonage.client.sms.HexUtil
Converts a Hex encoded String into a byte vector.
HexUtil - Class in com.vonage.client.sms
Static helper methods for working with hex values.
HINDI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
HINDI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
HINDI - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
HINDI_INDIA - Enum constant in enum class com.vonage.client.verify2.Locale
 
HMAC_MD5 - Enum constant in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
 
HMAC_SHA1 - Enum constant in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
 
HMAC_SHA256 - Enum constant in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
 
HMAC_SHA512 - Enum constant in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
 
HmacMd5Hasher - Class in com.vonage.client.auth.hashutils
Contains utility methods that use HMAC MD-5 hashing.
HmacMd5Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacMd5Hasher
 
HmacSha1Hasher - Class in com.vonage.client.auth.hashutils
Contains utility methods that use HMAC SHA-1 hashing.
HmacSha1Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacSha1Hasher
 
HmacSha256Hasher - Class in com.vonage.client.auth.hashutils
Contains utility methods that use HMAC SHA-256 hashing.
HmacSha256Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacSha256Hasher
 
HmacSha512Hasher - Class in com.vonage.client.auth.hashutils
Contains utility methods that use HMAC SHA-512 hashing.
HmacSha512Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacSha512Hasher
 
httpClient(HttpClient) - Method in class com.vonage.client.VonageClient.Builder
Deprecated.
This method will be removed in the next major release.
httpConfig(HttpConfig) - Method in class com.vonage.client.VonageClient.Builder
 
HttpConfig - Class in com.vonage.client
 
HttpConfig.Builder - Class in com.vonage.client
 
HttpMethod - Enum Class in com.vonage.client.common
Enumeration representing various HTTP request methods used in Vonage APIs.
httpWrapper - Variable in class com.vonage.client.AbstractMethod
 
HttpWrapper - Class in com.vonage.client
Internal class that holds available authentication methods and a shared HttpClient.
HttpWrapper(AuthCollection) - Constructor for class com.vonage.client.HttpWrapper
 
HttpWrapper(AuthMethod...) - Constructor for class com.vonage.client.HttpWrapper
 
HttpWrapper(HttpConfig, AuthCollection) - Constructor for class com.vonage.client.HttpWrapper
 
HttpWrapper(HttpConfig, AuthMethod...) - Constructor for class com.vonage.client.HttpWrapper
 
HUMAN - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
HUMAN_AGENT - Enum constant in enum class com.vonage.client.messages.messenger.Tag
 
HUNGARIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
HUNGARIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
HUNGARIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
HUNGARIAN_HUNGARY - Enum constant in enum class com.vonage.client.verify2.Locale
 

I

ICELANDIC - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ICELANDIC - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
ICELANDIC_ICELAND - Enum constant in enum class com.vonage.client.verify2.Locale
 
id(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappStickerRequest.Builder
(REQUIRED if WhatsappStickerRequest.Builder.url(String) is not specified) The ID of the sticker in relation to a specific WhatsApp deployment.
image - Variable in class com.vonage.client.messages.InboundMessage
 
IMAGE - Enum constant in enum class com.vonage.client.messages.MessageType
 
imageUrl(String) - Method in class com.vonage.client.users.User.Builder
An image URL to associate with the user.
improveAi(boolean) - Method in class com.vonage.client.application.Application.Builder
Whether Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
IN_PROGRESS - Enum constant in enum class com.vonage.client.verify.VerifyDetails.Status
The search is still in progress.
INBOUND - Enum constant in enum class com.vonage.client.common.Webhook.Type
 
INBOUND - Enum constant in enum class com.vonage.client.incoming.CallDirection
 
INBOUND - Enum constant in enum class com.vonage.client.redact.RedactRequest.Type
 
INBOUND - Enum constant in enum class com.vonage.client.voice.CallDirection
 
InboundMessage - Class in com.vonage.client.messages
Convenience class representing an inbound message webhook.
InboundMessage() - Constructor for class com.vonage.client.messages.InboundMessage
 
InboundMessage.UrlWrapper - Class in com.vonage.client.messages
 
INDIAN_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
INDONESIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
INDONESIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
INDONESIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
INDONESIAN_INDONESIA - Enum constant in enum class com.vonage.client.verify2.Locale
 
INFERRED - Enum constant in enum class com.vonage.client.insight.Validity
 
INFERRED_NOT_VALID - Enum constant in enum class com.vonage.client.insight.Validity
 
initialJoinOptions(InitialJoinOptions) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Options for when a participant joins a meeting.
initialJoinOptions(InitialJoinOptions) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
InitialJoinOptions - Class in com.vonage.client.meetings
 
InitialJoinOptions() - Constructor for class com.vonage.client.meetings.InitialJoinOptions
 
InitialJoinOptions.Builder - Class in com.vonage.client.meetings
 
initiatedAt - Variable in class com.vonage.client.verify2.WorkflowStatus
 
INPUT - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
InputAction - Class in com.vonage.client.voice.ncco
An NCCO input action which allows for the collection of digits and automatic speech recognition from a person.
InputAction.Builder - Class in com.vonage.client.voice.ncco
 
InputEvent - Class in com.vonage.client.incoming
 
InputEvent() - Constructor for class com.vonage.client.incoming.InputEvent
 
InsightClient - Class in com.vonage.client.insight
A client for talking to the Vonage Number Insight API.
InsightClient(HttpWrapper) - Constructor for class com.vonage.client.insight.InsightClient
Constructor.
InsightStatus - Enum Class in com.vonage.client.insight
 
instance - Variable in exception com.vonage.client.VonageApiResponseException
 
INSTANT - Enum constant in enum class com.vonage.client.meetings.RoomType
"Instant" is active for 10 minutes until the first participant joins the room and remains active for 10 minutes after the last participant leaves.
INTERNAL_ERROR - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Server error or failure
INTERNAL_ERROR - Enum constant in enum class com.vonage.client.insight.InsightStatus
The format of the recipient address is not valid.
INTERNAL_ERROR - Enum constant in enum class com.vonage.client.sms.MessageStatus
An error has occurred in the platform whilst processing this message.
INTERNAL_ERROR - Enum constant in enum class com.vonage.client.verify.VerifyStatus
An error occurred processing this request in the Cloud Communications Platform.
intValue(Node) - Static method in class com.vonage.client.legacyutils.XmlUtil
 
INVALID - Enum constant in enum class com.vonage.client.verify.VerifyCheck.Status
 
INVALID - Enum constant in enum class com.vonage.client.verify.VerifyDetails.Status
You supplied an invalid request_id, or the data is not available.
INVALID_CALLBACK - Enum constant in enum class com.vonage.client.sms.MessageStatus
The callback URL supplied was either too long or contained illegal characters.
INVALID_CODE - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The code inserted does not match the expected value.
INVALID_CREDENTIALS - Enum constant in enum class com.vonage.client.insight.InsightStatus
The api_key or api_secret you supplied is either not valid or has been disabled.
INVALID_CREDENTIALS - Enum constant in enum class com.vonage.client.sms.MessageStatus
Your API key and/or secret are incorrect, invalid or disabled.
INVALID_CREDENTIALS - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The supplied API key or secret in the request is either invalid or disabled.
INVALID_FROM_ADDRESS - Enum constant in enum class com.vonage.client.sms.MessageStatus
You are using a non-authorized sender ID in the from field.
INVALID_MESSAGE - Enum constant in enum class com.vonage.client.sms.MessageStatus
The platform was unable to process this message, for example, an un-recognized number prefix.
INVALID_MESSAGE_CLASS - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
INVALID_NETWORK_CODE - Enum constant in enum class com.vonage.client.sms.MessageStatus
The network code supplied was either not recognized, or does not match the country of the destination address.
INVALID_NUMBER - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
number invalid
INVALID_PARAMS - Enum constant in enum class com.vonage.client.insight.InsightStatus
Your request is incomplete and missing some mandatory parameters.
INVALID_PARAMS - Enum constant in enum class com.vonage.client.sms.MessageStatus
The value of one or more parameters is invalid.
INVALID_PARAMS - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Invalid value for parameter.
INVALID_REQUEST - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The request could not be routed.
INVALID_SIGNATURE - Enum constant in enum class com.vonage.client.sms.MessageStatus
The signature supplied could not be verified.
INVALID_TTL - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
invalidCardNumber(String) - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
Adds a Timeout error.
InvalidCardNumber(String) - Constructor for class com.vonage.client.voice.ncco.PaymentPrompt.Errors.InvalidCardNumber
Deprecated.
 
invalidCardType(String) - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
Adds an InvalidCardType error.
InvalidCardType(String) - Constructor for class com.vonage.client.voice.ncco.PaymentPrompt.Errors.InvalidCardType
Deprecated.
 
invalidExpirationDate(String) - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
Adds an InvalidExpirationDate error.
InvalidExpirationDate(String) - Constructor for class com.vonage.client.voice.ncco.PaymentPrompt.Errors.InvalidExpirationDate
Deprecated.
 
invalidParameters - Variable in exception com.vonage.client.VonageApiResponseException
 
invalidSecurityCode(String) - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
Adds an InvalidSecurityCode error.
InvalidSecurityCode(String) - Constructor for class com.vonage.client.voice.ncco.PaymentPrompt.Errors.InvalidSecurityCode
Deprecated.
 
invocationId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Invocation ID to filter by.
ipAddress - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
ipAddress(String) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
Deprecated.
This parameter is deprecated as we are no longer able to retrieve reliable IP data globally from carriers.
IRISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
isAsync() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
isAutoReload() - Method in class com.vonage.client.account.BalanceResponse
 
isAvailable(boolean) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Once a room becomes unavailable, no new sessions can be created under it.
isChatAvailable(boolean) - Method in class com.vonage.client.meetings.AvailableFeatures.Builder
 
isCodeless() - Method in class com.vonage.client.verify2.VerificationRequest
Determines if the workflows defined in this request do not prompt the user for code entry.
isConcat() - Method in class com.vonage.client.sms.callback.messages.MO
 
isDefaultApiBaseUri() - Method in class com.vonage.client.HttpConfig
 
isDefaultApiEuBaseUri() - Method in class com.vonage.client.HttpConfig
 
isDefaultRestBaseUri() - Method in class com.vonage.client.HttpConfig
 
isDefaultSnsBaseUri() - Method in class com.vonage.client.HttpConfig
 
isDelivered() - Method in class com.vonage.client.conversion.ConversionRequest
 
isLocaleSwitcherAvailable(boolean) - Method in class com.vonage.client.meetings.AvailableFeatures.Builder
 
isRecordingAvailable(boolean) - Method in class com.vonage.client.meetings.AvailableFeatures.Builder
 
isSubmitOnHash() - Method in class com.vonage.client.voice.ncco.DtmfSettings
 
isTemporaryError() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
isTemporaryError() - Method in class com.vonage.client.verify.BaseResult
Deprecated.
 
isTemporaryError() - Method in enum class com.vonage.client.verify.VerifyStatus
Deprecated.
This method may be removed in a future release.
isTimedOut() - Method in class com.vonage.client.incoming.DtmfResult
 
isUnicode() - Method in class com.vonage.client.sms.messages.TextMessage
 
isWhiteboardAvailable(boolean) - Method in class com.vonage.client.meetings.AvailableFeatures.Builder
 
IT - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Italian
ITALIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ITALIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ITALIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
ITALIAN_ITALY - Enum constant in enum class com.vonage.client.verify2.Locale
 
iterator() - Method in class com.vonage.client.voice.CallInfoPage
 

J

JAPANESE - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
JAPANESE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
JAPANESE_JAPAN - Enum constant in enum class com.vonage.client.verify2.Locale
 
JAPANESE_JAPAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
JAVANESE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
joinApprovalLevel(JoinApprovalLevel) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Level of approval needed to join the meeting in the room.
joinApprovalLevel(JoinApprovalLevel) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
JoinApprovalLevel - Enum Class in com.vonage.client.meetings
Represents the level of approval needed to join the meeting in the room.
Jsonable - Interface in com.vonage.client
Indicates that a class can be serialized to and parsed from JSON.
JWTAuthMethod - Class in com.vonage.client.auth
 
JWTAuthMethod(String, byte[]) - Constructor for class com.vonage.client.auth.JWTAuthMethod
 
JWTAuthMethod(String, Path) - Constructor for class com.vonage.client.auth.JWTAuthMethod
 

K

KANNADA - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
KANNADA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
KAZAKH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
key - Variable in class com.vonage.client.proactiveconnect.ListAttribute.Builder
 
key(boolean) - Method in class com.vonage.client.proactiveconnect.ListAttribute.Builder
Set to true if this attribute should be used to correlate between 2 or more lists.
Keys() - Constructor for class com.vonage.client.application.Application.Keys
 
KHMER - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
KINYARWANDA - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
KOREAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
KOREAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
KOREAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
KYRGYZ_KYRGYZSTAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 

L

LANDLINE - Enum constant in enum class com.vonage.client.account.Network.Type
 
LANDLINE - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
LANDLINE - Enum constant in enum class com.vonage.client.numbers.Type
 
LANDLINE - Enum constant in enum class com.vonage.client.verify.VerifyRequest.LineType
 
LANDLINE_PREMIUM - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
LANDLINE_TOLL_FREE - Enum constant in enum class com.vonage.client.numbers.Type
 
LANDLINE_TOLLFREE - Enum constant in enum class com.vonage.client.account.Network.Type
 
LANDLINE_TOLLFREE - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
language(RoomLanguage) - Method in class com.vonage.client.meetings.UISettings.Builder
 
language(TextToSpeechLanguage) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
language(TextToSpeechLanguage) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
language(TextToSpeechLanguage) - Method in class com.vonage.client.voice.TalkPayload.Builder
The speech language to use.
LAO - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
LAO - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
latitude(double) - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest.Builder
(REQUIRED) Latitude of the location.
LATVIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
LATVIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
length(Integer) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
length(Integer) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
lengthTimer(int) - Method in class com.vonage.client.voice.Call.Builder
Sets the number of seconds that elapse before Vonage hangs up after the call is answered.
level(double) - Method in class com.vonage.client.voice.TalkPayload.Builder
The volume level that the speech is played.
level(Float) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
level(Float) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
limit(Integer) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Maximum length of the call in seconds.
linkNumber(String, String, String) - Method in class com.vonage.client.numbers.NumbersClient
Link a given Vonage Virtual Number to a Vonage Application with the given ID.
listAllApplications() - Method in class com.vonage.client.application.ApplicationClient
Lists the first 1000 available applications.
ListApplicationRequest - Class in com.vonage.client.application
ListApplicationRequest.Builder - Class in com.vonage.client.application
 
listApplications() - Method in class com.vonage.client.application.ApplicationClient
Lists the first page of available applications.
listApplications(ListApplicationRequest) - Method in class com.vonage.client.application.ApplicationClient
List the available applications.
ListAttribute - Class in com.vonage.client.proactiveconnect
Represents a Proactive Connect list's attributes property.
ListAttribute() - Constructor for class com.vonage.client.proactiveconnect.ListAttribute
 
ListAttribute.Builder - Class in com.vonage.client.proactiveconnect
 
listBalanceTransfers() - Method in class com.vonage.client.subaccounts.SubaccountsClient
Retrieve a list of balance transfers that have taken place for the primary account within a specified time period.
listBalanceTransfers(ListTransfersFilter) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Retrieve a list of balance transfers that have taken place for the primary account within a specified time period.
listCalls() - Method in class com.vonage.client.voice.VoiceClient
Obtain the first page of CallInfo objects, representing the most recent calls initiated by VoiceClient.createCall(Call).
listCalls(CallsFilter) - Method in class com.vonage.client.voice.VoiceClient
Obtain the first page of CallInfo objects matching the query described by filter, representing the most recent calls initiated by VoiceClient.createCall(Call).
listCreditTransfers() - Method in class com.vonage.client.subaccounts.SubaccountsClient
Retrieve a list of credit transfers that have taken place for the primary account within a specified time period.
listCreditTransfers(ListTransfersFilter) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Retrieve a list of credit transfers that have taken place for the primary account within a specified time period.
listDialNumbers() - Method in class com.vonage.client.meetings.MeetingsClient
Get numbers that can be used to dial into a meeting.
listEvents(ListEventsFilter) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Gets all events in the application matching the criteria.
ListEventsFilter - Class in com.vonage.client.proactiveconnect
Filter options for finding events using ProactiveConnectClient.listEvents(ListEventsFilter).
ListEventsFilter.Builder - Class in com.vonage.client.proactiveconnect
Builder for specifying options to filter events by.
ListItem - Class in com.vonage.client.proactiveconnect
Represents a list item in the Proactive Connect API.
ListItem() - Constructor for class com.vonage.client.proactiveconnect.ListItem
 
listItems(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Gets the first 1000 events in the application.
listItems(UUID, int, int, SortOrder) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Get all items on a particular page.
ListItemsResponse - Class in com.vonage.client.proactiveconnect
listLists() - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Gets the first 1000 lists in the application.
listLists(int, int, SortOrder) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Get all lists on a particular page.
ListListsResponse - Class in com.vonage.client.proactiveconnect
listNumbers() - Method in class com.vonage.client.numbers.NumbersClient
Get the first page of phone numbers assigned to the authenticated account.
listNumbers(ListNumbersFilter) - Method in class com.vonage.client.numbers.NumbersClient
Get a filtered set of numbers assigned to the authenticated account.
ListNumbersFilter - Class in com.vonage.client.numbers
 
ListNumbersFilter() - Constructor for class com.vonage.client.numbers.ListNumbersFilter
 
ListNumbersFilter(Integer, Integer, String, SearchPattern) - Constructor for class com.vonage.client.numbers.ListNumbersFilter
 
ListNumbersResponse - Class in com.vonage.client.numbers
Response from a request to list the numbers currently being rented buy an account.
ListNumbersResponse() - Constructor for class com.vonage.client.numbers.ListNumbersResponse
 
listPriceAllCountries(ServiceType) - Method in class com.vonage.client.account.AccountClient
 
listRecordings(String) - Method in class com.vonage.client.meetings.MeetingsClient
Get recordings of a meeting session.
listRooms() - Method in class com.vonage.client.meetings.MeetingsClient
Get all listed rooms in the application.
listSecrets() - Method in class com.vonage.client.account.AccountClient
List the ID of each secret associated with this account's main API key.
listSecrets(String) - Method in class com.vonage.client.account.AccountClient
List the ID of each secret associated to the given API key.
ListSecretsResponse - Class in com.vonage.client.account
 
ListSecretsResponse() - Constructor for class com.vonage.client.account.ListSecretsResponse
 
listSubaccounts() - Method in class com.vonage.client.subaccounts.SubaccountsClient
Retrieve all subaccounts owned by the primary account.
ListSubaccountsResponse - Class in com.vonage.client.subaccounts
Response container for SubaccountsClient.listSubaccounts().
ListSubaccountsResponse() - Constructor for class com.vonage.client.subaccounts.ListSubaccountsResponse
 
listThemes() - Method in class com.vonage.client.meetings.MeetingsClient
Get all application themes.
ListTransfersFilter - Class in com.vonage.client.subaccounts
 
ListTransfersFilter.Builder - Class in com.vonage.client.subaccounts
 
listUsers() - Method in class com.vonage.client.users.UsersClient
Lists the first 100 users in the application, from newest to oldest.
listUsers(ListUsersRequest) - Method in class com.vonage.client.users.UsersClient
Lists users in the application based on the filter criteria.
ListUsersRequest - Class in com.vonage.client.users
ListUsersRequest.Builder - Class in com.vonage.client.users
 
ListUsersRequest.SortOrder - Enum Class in com.vonage.client.users
Represents the sort order for events.
ListUsersResponse - Class in com.vonage.client.users
Paginated HAL response for UsersClient.listUsers(ListUsersRequest).
ListUsersResponse() - Constructor for class com.vonage.client.users.ListUsersResponse
 
LITHUANIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
LITHUANIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
locale - Variable in class com.vonage.client.verify2.VerificationRequest
 
locale(Locale) - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest.Builder
(REQUIRED) The BCP 47 language of the template.
locale(Locale) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) Languages that are available to use.
locale(Locale) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
locale(Locale) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
Locale - Enum Class in com.vonage.client.messages.whatsapp
Enum representing BCP-47 locales supported by WhatsApp.
Locale - Enum Class in com.vonage.client.verify2
Represents the available locales for user verification.
Location - Class in com.vonage.client.messages.whatsapp
 
LOCATION - Enum constant in enum class com.vonage.client.messages.MessageType
 
LoggingUtils - Class in com.vonage.client.logging
 
LoggingUtils() - Constructor for class com.vonage.client.logging.LoggingUtils
 
LogoType - Enum Class in com.vonage.client.meetings
Represents the type of logo returned in LogoUploadsUrlResponse.Fields.
LogoUploadsUrlResponse - Class in com.vonage.client.meetings
 
LogoUploadsUrlResponse() - Constructor for class com.vonage.client.meetings.LogoUploadsUrlResponse
 
LogoUploadsUrlResponse.Fields - Class in com.vonage.client.meetings
 
logResponse(HttpResponse) - Static method in class com.vonage.client.logging.LoggingUtils
 
LONG_TERM - Enum constant in enum class com.vonage.client.meetings.RoomType
"Long term" expires after a specific date-time.
longitude(double) - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest.Builder
(REQUIRED) Longitude of the location.
LOOKUP_NOT_RETURNED - Enum constant in enum class com.vonage.client.insight.InsightStatus
Live mobile lookup not returned.
LookupOutcome - Enum Class in com.vonage.client.insight
Enum representing whether all information about a phone number has been returned.
loop(int) - Method in class com.vonage.client.voice.TalkPayload.Builder
The number of times to repeat the message.
loop(Integer) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
loop(Integer) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 

M

MACEDONIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
MACHINE - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
MACHINE - Enum constant in enum class com.vonage.client.voice.CallStatus
 
machineDetection(MachineDetection) - Method in class com.vonage.client.voice.Call.Builder
Configure the behavior when Vonage detects that the call is answered by voicemail.
machineDetection(MachineDetection) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Configure the behavior when Vonage detects that a destination is an answerphone.
MachineDetection - Enum Class in com.vonage.client.voice
 
mainColor(String) - Method in class com.vonage.client.meetings.Theme.Builder
(REQUIRED) The main theme colour code (hex value).
makeParams() - Method in class com.vonage.client.account.SettingsRequest
 
makeParams() - Method in class com.vonage.client.application.ListApplicationRequest
 
makeParams() - Method in class com.vonage.client.conversion.ConversionRequest
 
makeParams() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
makeParams() - Method in class com.vonage.client.insight.BaseInsightRequest
 
makeParams() - Method in class com.vonage.client.numbers.CancelNumberRequest
 
makeParams() - Method in class com.vonage.client.numbers.ListNumbersFilter
 
makeParams() - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
makeParams() - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
makeParams() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
 
makeParams() - Method in interface com.vonage.client.QueryParamsRequest
 
makeParams() - Method in class com.vonage.client.sms.messages.BinaryMessage
 
makeParams() - Method in class com.vonage.client.sms.messages.Message
 
makeParams() - Method in class com.vonage.client.sms.messages.TextMessage
 
makeParams() - Method in class com.vonage.client.sms.messages.WapPushMessage
Deprecated.
 
makeParams() - Method in class com.vonage.client.sns.request.SnsRequest
 
makeParams() - Method in class com.vonage.client.subaccounts.ListTransfersFilter
 
makeParams() - Method in class com.vonage.client.users.ListUsersRequest
 
makeParams() - Method in class com.vonage.client.verify.BaseRequest
 
makeParams() - Method in class com.vonage.client.verify.CheckRequest
 
makeParams() - Method in class com.vonage.client.verify.ControlRequest
 
makeParams() - Method in class com.vonage.client.verify.Psd2Request
 
makeParams() - Method in class com.vonage.client.verify.SearchRequest
 
makeParams() - Method in class com.vonage.client.verify.VerifyRequest
 
makeRequest(RequestT) - Method in class com.vonage.client.AbstractMethod
Construct and return a RequestBuilder instance from the provided request.
makeRequest(T) - Method in class com.vonage.client.DynamicEndpoint
 
MALAY - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
MALAY - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
MALAYALAM - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
MALAYALAM - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
MANDARIN_CHINESE_SIMPLIFIED - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ManualDatasource - Class in com.vonage.client.proactiveconnect
Represents the manual datasource type for a Proactive Connect list.
ManualDatasource() - Constructor for class com.vonage.client.proactiveconnect.ManualDatasource
Creates a new manual datasource for the list.
MARATHI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
MARATHI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
MAX_ALLOWABLE_TIME_DELTA - Static variable in class com.vonage.client.auth.RequestSigning
 
MAX_DURATION - Enum constant in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
 
MD5 - Enum constant in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
 
MeetingRoom - Class in com.vonage.client.meetings
 
MeetingRoom() - Constructor for class com.vonage.client.meetings.MeetingRoom
 
MeetingRoom.Builder - Class in com.vonage.client.meetings
 
MeetingsClient - Class in com.vonage.client.meetings
 
MeetingsClient(HttpWrapper) - Constructor for class com.vonage.client.meetings.MeetingsClient
Constructor.
MeetingsEventCallback - Class in com.vonage.client.meetings
Represents a deserialized callback response webhook for event updates from the Meetings API.
MeetingsEventCallback() - Constructor for class com.vonage.client.meetings.MeetingsEventCallback
 
MeetingsResponseException - Exception in com.vonage.client.meetings
Response returned when an error is encountered (i.e.
MeetingsResponseException() - Constructor for exception com.vonage.client.meetings.MeetingsResponseException
 
Message - Class in com.vonage.client.sms.messages
Represents the details common to any message that is to be submitted to the Vonage SMS API.
Message(Message.MessageType, String, String) - Constructor for class com.vonage.client.sms.messages.Message
 
Message(Message.MessageType, String, String, boolean) - Constructor for class com.vonage.client.sms.messages.Message
Abstract type for more specific SMS message types.
This constructor exposes the full range of possible parameters and is not for general use Instead, it is accessed via super() in the constructors of various sub-classes that expose a relevant sub-set of the available parameters
MESSAGE_TAG - Enum constant in enum class com.vonage.client.messages.messenger.Category
 
MESSAGE_TOO_LONG - Enum constant in enum class com.vonage.client.sms.MessageStatus
The message length exceeds the maximum allowed.
Message.MessageClass - Enum Class in com.vonage.client.sms.messages
An enum of the valid values that may be supplied to as the message-class parameter of a rest submission.
Message.MessageType - Enum Class in com.vonage.client.sms.messages
 
MessageEvent - Class in com.vonage.client.incoming
 
MessageEvent() - Constructor for class com.vonage.client.incoming.MessageEvent
 
MessagePayload - Class in com.vonage.client.messages.internal
Container object for audio, video, image and file message payload contents.
MessagePayload(String) - Constructor for class com.vonage.client.messages.internal.MessagePayload
 
MessagePayload(String, String) - Constructor for class com.vonage.client.messages.internal.MessagePayload
 
MessageRequest - Class in com.vonage.client.messages
Abstract base class of all Messages sent via the Messages v1 API.
MessageRequest(MessageRequest.Builder<?, ?>, Channel, MessageType) - Constructor for class com.vonage.client.messages.MessageRequest
Constructor where all of this class's fields should be set.
MessageRequest.Builder<M extends MessageRequest,B extends MessageRequest.Builder<? extends M,? extends B>> - Class in com.vonage.client.messages
Mutable Builder class, designed to simulate named parameters to allow for convenient construction of MessageRequests.
MessageResponse - Class in com.vonage.client.messages
Response returned when sending a message.
MessageResponse() - Constructor for class com.vonage.client.messages.MessageResponse
Protected to prevent users from explicitly creating this object.
MessageResponseException - Exception in com.vonage.client.messages
Response returned when sending a message fails (i.e.
MessageResponseException() - Constructor for exception com.vonage.client.messages.MessageResponseException
 
Messages - Class in com.vonage.client.application.capabilities
Messages capability configuration settings.
MESSAGES - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
 
MESSAGES - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
Messages.Builder - Class in com.vonage.client.application.capabilities
 
MessagesClient - Class in com.vonage.client.messages
 
MessagesClient(HttpWrapper) - Constructor for class com.vonage.client.messages.MessagesClient
Create a new MessagesClient.
MessageStatus - Class in com.vonage.client.messages
This class represents the data of a callback which is invoked after a message has been sent.
MessageStatus - Enum Class in com.vonage.client.sms
Enum representing the error status of an SMS message.
MessageStatus() - Constructor for class com.vonage.client.messages.MessageStatus
 
MessageStatus.Error - Class in com.vonage.client.messages
Describes the error that was encountered when sending the message.
MessageStatus.Status - Enum Class in com.vonage.client.messages
 
MessageStatus.Usage - Class in com.vonage.client.messages
Describes the charge incurred for sending the message.
messageType - Variable in class com.vonage.client.messages.InboundMessage
 
MessageType - Enum Class in com.vonage.client.incoming
 
MessageType - Enum Class in com.vonage.client.messages
Represents the media type of the message.
messageUuid - Variable in class com.vonage.client.messages.InboundMessage
 
messageUuid - Variable in class com.vonage.client.messages.MessageResponse
 
messageUuid - Variable in class com.vonage.client.messages.MessageStatus
 
messenger - Variable in class com.vonage.client.messages.messenger.MessengerRequest
 
Messenger - Class in com.vonage.client.messages.messenger
 
Messenger - Class in com.vonage.client.users.channels
Represents a Facebook Messenger channel.
Messenger() - Constructor for class com.vonage.client.users.channels.Messenger
 
Messenger(String) - Constructor for class com.vonage.client.users.channels.Messenger
Creates a new Messenger channel.
MESSENGER - Enum constant in enum class com.vonage.client.messages.Channel
 
MessengerAudioRequest - Class in com.vonage.client.messages.messenger
 
MessengerAudioRequest.Builder - Class in com.vonage.client.messages.messenger
 
MessengerFileRequest - Class in com.vonage.client.messages.messenger
 
MessengerFileRequest.Builder - Class in com.vonage.client.messages.messenger
 
MessengerImageRequest - Class in com.vonage.client.messages.messenger
 
MessengerImageRequest.Builder - Class in com.vonage.client.messages.messenger
 
MessengerRequest - Class in com.vonage.client.messages.messenger
 
MessengerRequest(MessengerRequest.Builder<?, ?>, MessageType) - Constructor for class com.vonage.client.messages.messenger.MessengerRequest
 
MessengerRequest.Builder<M extends MessengerRequest,B extends MessengerRequest.Builder<? extends M,? extends B>> - Class in com.vonage.client.messages.messenger
 
MessengerTextRequest - Class in com.vonage.client.messages.messenger
 
MessengerTextRequest.Builder - Class in com.vonage.client.messages.messenger
 
MessengerVideoRequest - Class in com.vonage.client.messages.messenger
 
MessengerVideoRequest.Builder - Class in com.vonage.client.messages.messenger
 
metadata(String) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Free text that can be attached to a room.
method(HttpMethod) - Method in class com.vonage.client.common.Webhook.Builder
(REQUIRED) The HTTP request method for this webhook.
MEXICAN_SPANISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
microphoneState(MicrophoneState) - Method in class com.vonage.client.meetings.InitialJoinOptions.Builder
 
MicrophoneState - Enum Class in com.vonage.client.meetings
Set the default microphone option for users in the pre-join screen of this room.
MISSING_PARAMS - Enum constant in enum class com.vonage.client.sms.MessageStatus
Your request is missing one of the required parameters from, to, api_key, api_secret or text.
MISSING_PARAMS - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Your request is incomplete and missing the mandatory parameter(s).
Mms - Class in com.vonage.client.users.channels
Represents a Multimedia Messaging Service (MMS) channel.
Mms() - Constructor for class com.vonage.client.users.channels.Mms
 
Mms(String) - Constructor for class com.vonage.client.users.channels.Mms
Creates a new MMS channel.
MMS - Enum constant in enum class com.vonage.client.messages.Channel
 
MmsAudioRequest - Class in com.vonage.client.messages.mms
 
MmsAudioRequest.Builder - Class in com.vonage.client.messages.mms
 
MmsImageRequest - Class in com.vonage.client.messages.mms
 
MmsImageRequest.Builder - Class in com.vonage.client.messages.mms
 
MmsRequest - Class in com.vonage.client.messages.mms
 
MmsRequest(MmsRequest.Builder<?, ?>, MessageType) - Constructor for class com.vonage.client.messages.mms.MmsRequest
 
MmsRequest.Builder<M extends MmsRequest,B extends MmsRequest.Builder<? extends M,? extends B>> - Class in com.vonage.client.messages.mms
 
MmsVcardRequest - Class in com.vonage.client.messages.mms
 
MmsVcardRequest.Builder - Class in com.vonage.client.messages.mms
 
MmsVideoRequest - Class in com.vonage.client.messages.mms
 
MmsVideoRequest.Builder - Class in com.vonage.client.messages.mms
 
MO - Class in com.vonage.client.sms.callback.messages
This represents an incoming MO callback request.
MO(String, MO.MESSAGE_TYPE, String, String, BigDecimal, Date) - Constructor for class com.vonage.client.sms.callback.messages.MO
 
MO.MESSAGE_TYPE - Enum Class in com.vonage.client.sms.callback.messages
Describes the type of payload this message carries
MOBILE - Enum constant in enum class com.vonage.client.account.Network.Type
 
MOBILE - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
MOBILE - Enum constant in enum class com.vonage.client.verify.VerifyRequest.LineType
 
MOBILE_LVN - Enum constant in enum class com.vonage.client.numbers.Type
 
mode(AdvancedMachineDetection.Mode) - Method in class com.vonage.client.voice.AdvancedMachineDetection.Builder
Detect if machine answered and sends a human or machine status in the webhook payload.
modifyCall(CallModifier) - Method in class com.vonage.client.voice.VoiceClient
Deprecated.
Use VoiceClient.modifyCall(String, ModifyCallAction). This will be removed in the next major release.
modifyCall(String, ModifyCallAction) - Method in class com.vonage.client.voice.VoiceClient
Modify an ongoing call.
ModifyCallAction - Enum Class in com.vonage.client.voice
Enum representing call modification actions.
ModifyCallPayload - Class in com.vonage.client.voice
Deprecated.
Will be made package-private in next major release.
ModifyCallPayload(ModifyCallAction) - Constructor for class com.vonage.client.voice.ModifyCallPayload
Deprecated.
 
ModifyCallResponse - Class in com.vonage.client.voice
Response if a Call was successfully modified.
ModifyCallResponse() - Constructor for class com.vonage.client.voice.ModifyCallResponse
 
MoneyTransfer - Class in com.vonage.client.subaccounts
Represents a credit or balance transfer between accounts.
MoneyTransfer() - Constructor for class com.vonage.client.subaccounts.MoneyTransfer
 
MoneyTransfer(MoneyTransfer.Builder) - Constructor for class com.vonage.client.subaccounts.MoneyTransfer
 
MoneyTransfer.Builder - Class in com.vonage.client.subaccounts
 
MP3 - Enum constant in enum class com.vonage.client.voice.ncco.RecordingFormat
 
musicOnHoldUrl(String...) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
musicOnHoldUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
MUTE - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 

N

NA_EAST - Enum constant in enum class com.vonage.client.application.capabilities.Region
api-us-3.vonage.com (Virginia)
NA_WEST - Enum constant in enum class com.vonage.client.application.capabilities.Region
api-us-4.vonage.com (Oregon)
name - Variable in class com.vonage.client.messages.viber.File
 
name - Variable in class com.vonage.client.proactiveconnect.ListAttribute.Builder
 
name(String) - Method in class com.vonage.client.application.Application.Builder
Set the friendly identifier for your application.
name(String) - Method in class com.vonage.client.messages.viber.ViberFileRequest.Builder
(OPTIONAL) The name and extension of the file.
name(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest.Builder
(OPTIONAL) Name of the location.
name(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest.Builder
(REQUIRED) The name of the template.
name(String) - Method in class com.vonage.client.proactiveconnect.ListAttribute.Builder
Sets the list attribute name.
name(String) - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest.Builder
(REQUIRED) Name of the subaccount.
name(String) - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest.Builder
(OPTIONAL) Name of the subaccount.
name(String) - Method in class com.vonage.client.users.ListUsersRequest.Builder
Find user by their name.
name(String) - Method in class com.vonage.client.users.User.Builder
Unique name for a user.
name(String) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
ncco(Action...) - Method in class com.vonage.client.voice.Call.Builder
Sets the actions to take on the call.
ncco(Collection<? extends Action>) - Method in class com.vonage.client.voice.Call.Builder
Sets the actions to take on the call.
Ncco - Class in com.vonage.client.voice.ncco
Vonage Call Control Object for controlling the flow of a Voice API call.
Ncco() - Constructor for class com.vonage.client.voice.ncco.Ncco
 
Ncco(ObjectWriter) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
Ncco(ObjectWriter, Action...) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
Ncco(ObjectWriter, Collection<? extends Action>) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
Ncco(Action...) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
Ncco(Collection<Action>) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
NCCO - Enum constant in enum class com.vonage.client.voice.TransferDestination.Type
Deprecated.
 
NccoResponse - Class in com.vonage.client.voice.servlet
Encapsulates a set of NCCO objects for driving the Vonage Voice API.
NccoResponse() - Constructor for class com.vonage.client.voice.servlet.NccoResponse
 
NccoResponseBuilder - Class in com.vonage.client.voice.servlet
Provides a fluent interface for constructing instances of NccoResponse.
NccoResponseBuilder() - Constructor for class com.vonage.client.voice.servlet.NccoResponseBuilder
 
NEPALI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
Network - Class in com.vonage.client.account
 
Network() - Constructor for class com.vonage.client.account.Network
 
Network.Type - Enum Class in com.vonage.client.account
 
nextEventWait(Integer) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
nextEventWait(Integer) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
NO_DETAIL - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
no detail field present
NO_RESPONSE - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Deprecated.
This value is no longer used / returned by the API.
NON_PERMITTED_DESTINATION - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Your Vonage account is still in demo mode.
NON_WHITELISTED_DESTINATION - Enum constant in enum class com.vonage.client.sms.MessageStatus
Your Vonage account is still in demo mode.
NONE - Enum constant in enum class com.vonage.client.meetings.JoinApprovalLevel
Participants can join the meeting at any time without approval.
NORWEGIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
NORWEGIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
NORWEGIAN_BOKMAL - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
NORWEGIAN_BOKMAL - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
NORWEGIAN_BOKMAL_NORWAY - Enum constant in enum class com.vonage.client.verify2.Locale
 
NOT_PORTED - Enum constant in enum class com.vonage.client.insight.PortedStatus
 
NOT_ROAMING - Enum constant in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
 
NOT_VALID - Enum constant in enum class com.vonage.client.insight.Validity
 
NotifyAction - Class in com.vonage.client.voice.ncco
An NCCO notify action which allows for custom events to be sent to a configured webhook.
NotifyAction.Builder - Class in com.vonage.client.voice.ncco
 
NotifyEvent - Class in com.vonage.client.incoming
 
NotifyEvent() - Constructor for class com.vonage.client.incoming.NotifyEvent
 
number - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
number - Variable in class com.vonage.client.insight.BaseInsightRequest
 
number - Variable in class com.vonage.client.insight.BasicInsightRequest.Builder
 
number - Variable in class com.vonage.client.insight.StandardInsightRequest.Builder
 
number(String) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
number(String) - Method in class com.vonage.client.insight.BasicInsightRequest.Builder
 
number(String) - Method in class com.vonage.client.insight.StandardInsightRequest.Builder
 
number(String) - Method in class com.vonage.client.subaccounts.NumberTransfer.Builder
(REQUIRED) The number being transferred between accounts.
number(String) - Method in class com.vonage.client.verify.Psd2Request.Builder
(REQUIRED)
number(String) - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.Builder
 
NUMBER_BARRED - Enum constant in enum class com.vonage.client.sms.MessageStatus
The number you are trying to send messages to is blacklisted and may not receive them.
NUMBER_BARRED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The number you are trying to verify is blacklisted for verification.
NUMBER_DEACTIVATED - Enum constant in enum class com.vonage.client.sms.MessageStatus
The number you are trying to send messages to is de-activated and may not receive them.
NUMBER_INSIGHTS - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
NUMBER_OUT_OF_SERVICE - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
number is no longer available
NUMBER_UNREACHABLE - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
NumbersClient - Class in com.vonage.client.numbers
A client for accessing the Vonage API calls that manage phone numbers.
NumbersClient(HttpWrapper) - Constructor for class com.vonage.client.numbers.NumbersClient
 
NumbersResponseException - Exception in com.vonage.client.numbers
Response returned when an error is encountered (i.e.
NumbersResponseException() - Constructor for exception com.vonage.client.numbers.NumbersResponseException
 
NumberTransfer - Class in com.vonage.client.subaccounts
 
NumberTransfer() - Constructor for class com.vonage.client.subaccounts.NumberTransfer
 
NumberTransfer.Builder - Class in com.vonage.client.subaccounts
 

O

OFF - Enum constant in enum class com.vonage.client.meetings.MicrophoneState
 
OGG - Enum constant in enum class com.vonage.client.voice.ncco.RecordingFormat
 
OK - Enum constant in enum class com.vonage.client.sms.MessageStatus
A status of zero does not indicate that Vonage delivered your message.
OK - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The request was successfully accepted by Vonage.
ON - Enum constant in enum class com.vonage.client.meetings.MicrophoneState
 
onAnswer(String) - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.Builder
 
onAnswer(String, String) - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.Builder
 
order(SortOrder) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Sort in either ascending or descending order.
order(ListUsersRequest.SortOrder) - Method in class com.vonage.client.users.ListUsersRequest.Builder
The order to return the results in.
order(CallOrder) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
Order - Class in com.vonage.client.messages.whatsapp
Used for inbound product orders.
ORDER - Enum constant in enum class com.vonage.client.messages.MessageType
 
OUTBOUND - Enum constant in enum class com.vonage.client.incoming.CallDirection
 
OUTBOUND - Enum constant in enum class com.vonage.client.redact.RedactRequest.Type
 
OUTBOUND - Enum constant in enum class com.vonage.client.voice.CallDirection
 
OwnedNumber - Class in com.vonage.client.numbers
 
OwnedNumber() - Constructor for class com.vonage.client.numbers.OwnedNumber
 

P

page - Variable in class com.vonage.client.common.HalPageResponse
 
page(long) - Method in class com.vonage.client.application.ListApplicationRequest.Builder
 
PageLink - Class in com.vonage.client.voice
 
PageLink() - Constructor for class com.vonage.client.voice.PageLink
 
PageLinks - Class in com.vonage.client.voice
 
PageLinks() - Constructor for class com.vonage.client.voice.PageLinks
 
PAGER - Enum constant in enum class com.vonage.client.account.Network.Type
 
PAGER - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
pageSize - Variable in class com.vonage.client.common.HalPageResponse
 
pageSize(int) - Method in class com.vonage.client.users.ListUsersRequest.Builder
Number of records to return in the response.
pageSize(long) - Method in class com.vonage.client.application.ListApplicationRequest.Builder
 
pageSize(Integer) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
PARAM_SIGNATURE - Static variable in class com.vonage.client.auth.RequestSigning
 
PARAM_TIMESTAMP - Static variable in class com.vonage.client.auth.RequestSigning
 
parameters(List<String>) - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest.Builder
(OPTIONAL) The parameters are an array of strings, with the first being substituted for {{1}} in the template, the second being {{2}} etc.
paramValue() - Method in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
parseResponse(HttpResponse) - Method in class com.vonage.client.AbstractMethod
Construct a ResultT representing the contents of the HTTP response returned from the Vonage Voice API.
parseResponse(HttpResponse) - Method in class com.vonage.client.DynamicEndpoint
 
parseResponseFromString(String) - Method in class com.vonage.client.DynamicEndpoint
 
parseXml(String) - Method in class com.vonage.client.legacyutils.XmlParser
Parse a provided XML String and return the generated DOM Document.
parseXmlString(DocumentBuilder, String) - Static method in class com.vonage.client.legacyutils.XmlUtil
 
PARTIAL_SUCCESS - Enum constant in enum class com.vonage.client.insight.LookupOutcome
 
PARTNER_ACCOUNT_BARRED - Enum constant in enum class com.vonage.client.sms.MessageStatus
Your Vonage account has been suspended.
PARTNER_ACCOUNT_BARRED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The api_key you supplied is for an account that has been barred from submitting messages.
PARTNER_QUOTA_EXCEEDED - Enum constant in enum class com.vonage.client.insight.InsightStatus
Your account does not have sufficient credit to process this request.
PARTNER_QUOTA_EXCEEDED - Enum constant in enum class com.vonage.client.sms.MessageStatus
You do not have sufficient credit to send the message.
PARTNER_QUOTA_EXCEEDED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Your account does not have sufficient credit to process this request.
PATCH - Enum constant in enum class com.vonage.client.common.HttpMethod
 
pathGetter - Variable in class com.vonage.client.DynamicEndpoint
 
pathGetter(BiFunction<DynamicEndpoint<T, R>, T, String>) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
PAUSED - Enum constant in enum class com.vonage.client.meetings.RecordingStatus
 
PAUSED - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
PayAction - Class in com.vonage.client.voice.ncco
Deprecated.
This is no longer supported and will be removed in the next major release.
PayAction.Builder - Class in com.vonage.client.voice.ncco
Deprecated.
 
PayAction.Voice - Class in com.vonage.client.voice.ncco
Deprecated.
 
payee(String) - Method in class com.vonage.client.verify.Psd2Request.Builder
(REQUIRED)
payload(Map<String, ?>) - Method in class com.vonage.client.voice.ncco.NotifyAction.Builder
 
PaymentPrompt - Class in com.vonage.client.voice.ncco
Deprecated.
Will be removed in the next major release.
PaymentPrompt.Builder - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors.Error - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors.InvalidCardNumber - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors.InvalidCardType - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors.InvalidExpirationDate - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors.InvalidSecurityCode - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Errors.Timeout - Class in com.vonage.client.voice.ncco
Deprecated.
 
PaymentPrompt.Type - Enum Class in com.vonage.client.voice.ncco
Deprecated.
Enum representing possible values for payment prompt types.
PERSIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
PERSIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
PhoneEndpoint - Class in com.vonage.client.voice.ncco
Represents a phone endpoint used in a ConnectAction.
PhoneEndpoint - Class in com.vonage.client.voice
 
PhoneEndpoint() - Constructor for class com.vonage.client.voice.PhoneEndpoint
Deprecated.
PhoneEndpoint(String) - Constructor for class com.vonage.client.voice.PhoneEndpoint
Constructor.
PhoneEndpoint(String, String) - Constructor for class com.vonage.client.voice.PhoneEndpoint
Constructor.
PhoneEndpoint.Builder - Class in com.vonage.client.voice.ncco
 
PhoneEndpoint.OnAnswer - Class in com.vonage.client.voice.ncco
An object containing a required url key.
pinCode(String) - Method in class com.vonage.client.verify.VerifyRequest.Builder
A custom PIN to send to the user.
pinExpiry(Integer) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
pinExpiry(Integer) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
policy(Policy) - Method in class com.vonage.client.messages.whatsapp.WhatsappTemplateRequest.Builder
(OPTIONAL) Policy for resolving what language template to use.
Policy - Enum Class in com.vonage.client.messages.whatsapp
Represents the policy for resolving what language template to use.
POLISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
POLISH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
POLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
POLISH_POLAND - Enum constant in enum class com.vonage.client.verify2.Locale
 
PORTED - Enum constant in enum class com.vonage.client.insight.PortedStatus
 
PortedStatus - Enum Class in com.vonage.client.insight
Enum representing whether the user has changed carrier for the number.
PORTUGUESE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
PORTUGUESE_BR - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
PORTUGUESE_BRAZIL - Enum constant in enum class com.vonage.client.verify2.Locale
 
PORTUGUESE_BRAZIL - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
PORTUGUESE_POR - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
PORTUGUESE_PORTUGAL - Enum constant in enum class com.vonage.client.verify2.Locale
 
PORTUGUESE_PORTUGAL - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
POST - Enum constant in enum class com.vonage.client.common.HttpMethod
 
POST - Enum constant in enum class com.vonage.client.voice.ncco.EventMethod
 
POST_PURCHASE_UPDATE - Enum constant in enum class com.vonage.client.messages.messenger.Tag
 
postProcessParsedResponse(ResultT) - Method in class com.vonage.client.AbstractMethod
 
PrefixPricingResponse - Class in com.vonage.client.account
 
PrefixPricingResponse() - Constructor for class com.vonage.client.account.PrefixPricingResponse
 
premium(boolean) - Method in class com.vonage.client.voice.TalkPayload.Builder
Specify whether to use the premium version of the specified style if available.
premium(Boolean) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
PricingResponse - Class in com.vonage.client.account
 
PricingResponse() - Constructor for class com.vonage.client.account.PricingResponse
 
Privacy() - Constructor for class com.vonage.client.application.Application.Privacy
 
privateKeyContents(byte[]) - Method in class com.vonage.client.VonageClient.Builder
When setting the contents of your private key, it is also expected that VonageClient.Builder.applicationId(String) will also be set.
privateKeyContents(String) - Method in class com.vonage.client.VonageClient.Builder
When setting the contents of your private key, it is also expected that VonageClient.Builder.applicationId(String) will also be set.
privateKeyPath(String) - Method in class com.vonage.client.VonageClient.Builder
When setting the path of your private key, it is also expected that VonageClient.Builder.applicationId(String) will also be set.
privateKeyPath(Path) - Method in class com.vonage.client.VonageClient.Builder
When setting the path of your private key, it is also expected that VonageClient.Builder.applicationId(String) will also be set.
ProactiveConnectClient - Class in com.vonage.client.proactiveconnect
A client for talking to the Vonage Proactive Connect API.
ProactiveConnectClient(HttpWrapper) - Constructor for class com.vonage.client.proactiveconnect.ProactiveConnectClient
Constructor.
ProactiveConnectResponseException - Exception in com.vonage.client.proactiveconnect
Response returned when an error is encountered (i.e.
ProactiveConnectResponseException() - Constructor for exception com.vonage.client.proactiveconnect.ProactiveConnectResponseException
 
ProductItem - Class in com.vonage.client.messages.whatsapp
Used for inbound product orders.
productRetailerId(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappSingleProductRequest.Builder
(REQUIRED) A product’s unique identifier.
Profile - Class in com.vonage.client.messages.whatsapp
Used for inbound messages.
PROMOTION - Enum constant in enum class com.vonage.client.messages.viber.Category
 
prompts(Collection<PaymentPrompt>) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
Properties() - Constructor for class com.vonage.client.users.User.Properties
 
Psd2Request - Class in com.vonage.client.verify
Describes a PSD2 verify request.
Psd2Request.Builder - Class in com.vonage.client.verify
 
Psd2Request.Workflow - Enum Class in com.vonage.client.verify
Enumeration representing different verification workflows.
psd2Verify(Psd2Request) - Method in class com.vonage.client.verify.VerifyClient
Send a PSD2 verification request to a phone number with optional parameters
psd2Verify(String, Double, String) - Method in class com.vonage.client.verify.VerifyClient
Send a PSD2 compliant payment token to a user for payment authorization
psd2Verify(String, Double, String, Psd2Request.Workflow) - Method in class com.vonage.client.verify.VerifyClient
Send a PSD2 compliant payment token to a user for payment authorization with a pin verification workflow
Pstn - Class in com.vonage.client.users.channels
Represents a Public Switched Telephone Network (PSTN) channel.
Pstn() - Constructor for class com.vonage.client.users.channels.Pstn
 
Pstn(String) - Constructor for class com.vonage.client.users.channels.Pstn
Creates a new PSTN channel.
PT - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Deprecated.
Replaced by RoomLanguage.PT_BR.
PT_BR - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Brazilian Portuguese
publicKey(String) - Method in class com.vonage.client.application.Application.Builder
Sets the application's public key.
publish(SnsPublishRequest) - Method in class com.vonage.client.sns.SnsClient
 
PUNJABI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
PUT - Enum constant in enum class com.vonage.client.common.HttpMethod
 

Q

QueryParamsRequest - Interface in com.vonage.client
Indicates that a request object has query parameters.

R

Reachability - Enum Class in com.vonage.client.insight
Enum representing whether you can call number now.
REACHABLE - Enum constant in enum class com.vonage.client.insight.Reachability
 
READ - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
realTimeData - Variable in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
realTimeData(boolean) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
RealTimeData - Class in com.vonage.client.insight
Real time data about the number.
RealTimeData() - Constructor for class com.vonage.client.insight.RealTimeData
 
RECIPIENT_RESPONSE - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Recipient response
recipientId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Recipient ID to filter by.
record(Boolean) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
RecordAction - Class in com.vonage.client.voice.ncco
An NCCO record action which allows for the call to be recorded.
RecordAction.Builder - Class in com.vonage.client.voice.ncco
 
RecordEvent - Class in com.vonage.client.incoming
 
RecordEvent() - Constructor for class com.vonage.client.incoming.RecordEvent
 
recordIndex(Integer) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
Recording - Class in com.vonage.client.meetings
 
Recording - Class in com.vonage.client.voice
Represents a recording obtained from VoiceClient.downloadRecording(String).
Recording() - Constructor for class com.vonage.client.meetings.Recording
 
Recording(HttpResponse) - Constructor for class com.vonage.client.voice.Recording
 
RECORDING - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
RECORDING_ENDED - Enum constant in enum class com.vonage.client.meetings.EventType
Recording ended.
RECORDING_STARTED - Enum constant in enum class com.vonage.client.meetings.EventType
Recording started.
RECORDING_UPLOADED - Enum constant in enum class com.vonage.client.meetings.EventType
Recording uploaded.
RecordingFormat - Enum Class in com.vonage.client.voice.ncco
 
recordingOptions(RecordingOptions) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Options for recording.
RecordingOptions - Class in com.vonage.client.meetings
 
RecordingOptions() - Constructor for class com.vonage.client.meetings.RecordingOptions
 
RecordingOptions.Builder - Class in com.vonage.client.meetings
 
recordingsCallbackUrl(String) - Method in class com.vonage.client.meetings.CallbackUrls.Builder
 
RecordingStatus - Enum Class in com.vonage.client.meetings
Represents the recording state of a meeting.
recordOnlyOwner(boolean) - Method in class com.vonage.client.meetings.RecordingOptions.Builder
 
RedactClient - Class in com.vonage.client.redact
Deprecated.
This API will be removed in the next major release.
RedactClient(HttpWrapper) - Constructor for class com.vonage.client.redact.RedactClient
Deprecated.
 
RedactRequest - Class in com.vonage.client.redact
Represents a request to the Redact API.
RedactRequest(String, RedactRequest.Product) - Constructor for class com.vonage.client.redact.RedactRequest
Construct a RedactRequest object with all required fields.
RedactRequest.Product - Enum Class in com.vonage.client.redact
 
RedactRequest.Type - Enum Class in com.vonage.client.redact
 
redactTransaction(RedactRequest) - Method in class com.vonage.client.redact.RedactClient
Deprecated.
Submit a request to the Redact API to redact a transaction.
redactTransaction(String, RedactRequest.Product) - Method in class com.vonage.client.redact.RedactClient
Deprecated.
Submit a request to the Redact API to redact a transaction.
redactTransaction(String, RedactRequest.Product, RedactRequest.Type) - Method in class com.vonage.client.redact.RedactClient
Deprecated.
Submit a request to the Redact API to redact a transaction.
reference(String) - Method in class com.vonage.client.subaccounts.MoneyTransfer.Builder
(OPTIONAL) Reference for the transfer.
ReferredProduct - Class in com.vonage.client.messages.whatsapp
Contains details of a product from a product message being quoted or replied to using the 'Message Business' option.
region(Region) - Method in class com.vonage.client.application.capabilities.Voice.Builder
Selecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
Region - Enum Class in com.vonage.client.application.capabilities
Represents a Vonage region.
REJECTED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
REJECTED - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
REJECTED - Enum constant in enum class com.vonage.client.voice.CallStatus
 
removeCapability(Capability.Type) - Method in class com.vonage.client.application.Application.Builder
Remove a capability from the application.
removeWebhook(Webhook.Type) - Method in class com.vonage.client.application.capabilities.Messages.Builder
 
removeWebhook(Webhook.Type) - Method in class com.vonage.client.application.capabilities.Rtc.Builder
 
removeWebhook(Webhook.Type) - Method in class com.vonage.client.application.capabilities.Voice.Builder
 
Reply - Class in com.vonage.client.messages.whatsapp
Used for inbound interactive messages.
REPLY - Enum constant in enum class com.vonage.client.messages.MessageType
 
REQUEST_UNPARSEABLE - Enum constant in enum class com.vonage.client.insight.InsightStatus
Request unparseable.
requestId - Variable in class com.vonage.client.verify2.VerificationCallback
 
requestId - Variable in class com.vonage.client.verify2.VerificationResponse
 
requestMethod - Variable in class com.vonage.client.DynamicEndpoint
 
requestMethod(HttpMethod) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
RequestSigning - Class in com.vonage.client.auth
A helper class for generating or verifying MD5 signatures when signing REST requests for submission to Vonage.
RequestSigning() - Constructor for class com.vonage.client.auth.RequestSigning
 
RESPONSE - Enum constant in enum class com.vonage.client.messages.messenger.Category
 
responseExceptionType - Variable in class com.vonage.client.DynamicEndpoint
 
responseExceptionType(Class<? extends RuntimeException>) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
responseType - Variable in class com.vonage.client.DynamicEndpoint
 
restBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
 
RestEndpoint<T,R> - Interface in com.vonage.client
Internal interface for defining endpoints.
RESTRICTED - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Rejected By Carrier
Result - Class in com.vonage.client.incoming
 
Result() - Constructor for class com.vonage.client.incoming.Result
 
revokeSecret(String) - Method in class com.vonage.client.account.AccountClient
Revoke a secret associated with this account's main API key.
revokeSecret(String, String) - Method in class com.vonage.client.account.AccountClient
Revoke a secret associated with a specific API key.
RINGING - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
RINGING - Enum constant in enum class com.vonage.client.voice.CallStatus
 
ringingTimer(int) - Method in class com.vonage.client.voice.Call.Builder
Sets the number of seconds that elapse before Vonage hangs up after the call state changes to ‘ringing’.
ROAMING - Enum constant in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
 
RoamingDeseriazlizer - Class in com.vonage.client.insight
 
RoamingDeseriazlizer() - Constructor for class com.vonage.client.insight.RoamingDeseriazlizer
 
RoamingDeseriazlizer(Class<?>) - Constructor for class com.vonage.client.insight.RoamingDeseriazlizer
 
RoamingDetails - Class in com.vonage.client.insight
Information about the roaming status for number.
RoamingDetails(RoamingDetails.RoamingStatus, String, String, String) - Constructor for class com.vonage.client.insight.RoamingDetails
 
RoamingDetails.RoamingStatus - Enum Class in com.vonage.client.insight
Represents whether the number is outside its home carrier network, as an enum.
ROMANIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ROMANIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ROMANIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
ROMANIAN_ROMANIA - Enum constant in enum class com.vonage.client.verify2.Locale
 
ROOM_EXPIRED - Enum constant in enum class com.vonage.client.meetings.EventType
Room expired.
RoomLanguage - Enum Class in com.vonage.client.meetings
Represents the language in UISettings.
RoomLinks - Class in com.vonage.client.meetings
 
RoomLinks() - Constructor for class com.vonage.client.meetings.RoomLinks
 
roomsCallbackUrl(String) - Method in class com.vonage.client.meetings.CallbackUrls.Builder
 
RoomType - Enum Class in com.vonage.client.meetings
Represents the type of meeting room.
Rtc - Class in com.vonage.client.application.capabilities
Rtc capability configuration settings.
RTC - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
 
Rtc.Builder - Class in com.vonage.client.application.capabilities
 
RUN_ITEM_FAILED - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Run item failed
RUN_ITEM_SKIPPED - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Run item skipped
RUN_ITEM_SUBMITTED - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Run item submitted
RUN_ITEMS_EXCLUDED - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Run items excluded
RUN_ITEMS_READY - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Run items ready
RUN_ITEMS_TOTAL - Enum constant in enum class com.vonage.client.proactiveconnect.EventType
Run items total
runId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Run ID to filter by.
runItemId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Run item ID to filter by.
RUSSIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
RUSSIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
RUSSIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
RUSSIAN_RUSSIA - Enum constant in enum class com.vonage.client.verify2.Locale
 

S

SalesforceDatasource - Class in com.vonage.client.proactiveconnect
Represents the salesforce datasource type for a Proactive Connect list.
SalesforceDatasource() - Constructor for class com.vonage.client.proactiveconnect.SalesforceDatasource
 
SalesforceDatasource(String, String) - Constructor for class com.vonage.client.proactiveconnect.SalesforceDatasource
Creates a new Salesforce datasource for the list.
save(String) - Method in class com.vonage.client.voice.Recording
Saves the downloaded recording to a file.
save(Path) - Method in class com.vonage.client.voice.Recording
Saves the downloaded recording to a file.
search(String) - Method in class com.vonage.client.verify.VerifyClient
Search for a previous verification request.
search(String...) - Method in class com.vonage.client.verify.VerifyClient
Search for a previous verification request.
searchNumbers(SearchNumbersFilter) - Method in class com.vonage.client.numbers.NumbersClient
Search for available Vonage Virtual Numbers.
searchNumbers(String) - Method in class com.vonage.client.numbers.NumbersClient
Search for available Vonage Virtual Numbers.
SearchNumbersFilter - Class in com.vonage.client.numbers
This class encapsulates a request to search for available Vonage Virtual Numbers.
SearchNumbersFilter(String) - Constructor for class com.vonage.client.numbers.SearchNumbersFilter
Construct a request with the only required parameter, the country code.
SearchNumbersResponse - Class in com.vonage.client.numbers
Represents the response to a "searchNumbers" request from the Vonage API.
SearchNumbersResponse() - Constructor for class com.vonage.client.numbers.SearchNumbersResponse
 
SearchPattern - Enum Class in com.vonage.client.numbers
Provided to calls that match substrings, to indicate which part of the string should be considered a match.
SearchRequest - Class in com.vonage.client.verify
 
SearchRequest(String...) - Constructor for class com.vonage.client.verify.SearchRequest
 
searchRoomsByTheme(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Get rooms that are associated with a theme ID.
SearchVerifyResponse - Class in com.vonage.client.verify
 
secret(String) - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest.Builder
(OPTIONAL) Secret for the subaccount.
SecretResponse - Class in com.vonage.client.account
 
SecretResponse() - Constructor for class com.vonage.client.account.SecretResponse
 
SECURITY_CODE - Enum constant in enum class com.vonage.client.voice.ncco.PaymentPrompt.Type
Deprecated.
 
SEGMENTATION - Enum constant in enum class com.vonage.client.proactiveconnect.SourceType
Segmentation
sendDtmf(String, String) - Method in class com.vonage.client.voice.VoiceClient
Send DTMF codes to an ongoing call.
senderId(String) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
sendMessage(MessageRequest) - Method in class com.vonage.client.messages.MessagesClient
Sends a message.
sendVerification(VerificationRequest) - Method in class com.vonage.client.verify2.Verify2Client
Request a verification be sent to a user.
SERBIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SERBIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
ServiceType - Enum Class in com.vonage.client.account
 
SESSION_ENDED - Enum constant in enum class com.vonage.client.meetings.EventType
Session ended.
SESSION_PARTICIPANT_JOINED - Enum constant in enum class com.vonage.client.meetings.EventType
Participant joined.
SESSION_PARTICIPANT_LEFT - Enum constant in enum class com.vonage.client.meetings.EventType
Participant left.
SESSION_STARTED - Enum constant in enum class com.vonage.client.meetings.EventType
Session started.
sessionsCallbackUrl(String) - Method in class com.vonage.client.meetings.CallbackUrls.Builder
 
setAnswerMethod(String) - Method in class com.vonage.client.voice.Call
Deprecated.
setAnswerUrl(String) - Method in class com.vonage.client.voice.Call
Deprecated.
setAuthCollection(AuthCollection) - Method in class com.vonage.client.HttpWrapper
 
setBinaryData(byte[], byte[]) - Method in class com.vonage.client.sms.callback.messages.MO
 
setCallbackUrl(String) - Method in class com.vonage.client.sms.messages.Message
 
setClientReference(String) - Method in class com.vonage.client.sms.messages.Message
 
setConcatenationData(String, int, int) - Method in class com.vonage.client.sms.callback.messages.MO
 
setConfidence(String) - Method in class com.vonage.client.incoming.Result
 
setContentId(String) - Method in class com.vonage.client.sms.messages.Message
 
setContentType(String) - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
setContentType(String) - Method in class com.vonage.client.voice.WebSocketEndpoint
Deprecated.
setContext(Collection<String>) - Method in class com.vonage.client.voice.ncco.SpeechSettings
List of hints to improve recognition quality if certain words are expected from the user.
setConversationUuid(String) - Method in class com.vonage.client.incoming.NotifyEvent
 
setConversationUuid(String) - Method in class com.vonage.client.voice.CallEvent
Deprecated.
setConversationUuid(String) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setCost(String) - Method in class com.vonage.client.numbers.AvailableNumber
 
setCountry(String) - Method in class com.vonage.client.numbers.AvailableNumber
 
setCountry(String) - Method in class com.vonage.client.numbers.OwnedNumber
 
setDirection(CallDirection) - Method in class com.vonage.client.voice.CallEvent
Deprecated.
setDirection(CallDirection) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setDtmfAnswer(String) - Method in class com.vonage.client.voice.PhoneEndpoint
Deprecated.
setDuration(Integer) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setEndOnSilence(Integer) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Controlls how long the system will wait after user stops speaking to decide the input is completed.
setEndTime(Date) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setEntityId(String) - Method in class com.vonage.client.sms.messages.Message
 
setEventMethod(String) - Method in class com.vonage.client.voice.Call
Deprecated.
setEventUrl(String) - Method in class com.vonage.client.voice.Call
Deprecated.
setFeatures(String[]) - Method in class com.vonage.client.numbers.AvailableNumber
 
setFeatures(String[]) - Method in class com.vonage.client.numbers.OwnedNumber
 
setFeatures(String[]) - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
setFrom(Endpoint) - Method in class com.vonage.client.voice.Call
Deprecated.
setFrom(Endpoint) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setFromRandomNumber(Boolean) - Method in class com.vonage.client.voice.Call
setHeaders(List<NameValuePair>) - Method in class com.vonage.client.voice.WebSocketEndpoint
Deprecated.
setHttpClient(HttpClient) - Method in class com.vonage.client.HttpWrapper
 
setHttpConfig(HttpConfig) - Method in class com.vonage.client.HttpWrapper
 
setId(String) - Method in class com.vonage.client.redact.RedactRequest
 
setIndex(Integer) - Method in class com.vonage.client.numbers.ListNumbersFilter
 
setIndex(Integer) - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
setLanguage(SpeechSettings.Language) - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
setLengthTimer(Integer) - Method in class com.vonage.client.voice.Call
Deprecated.
setMachineDetection(MachineDetection) - Method in class com.vonage.client.voice.Call
Deprecated.
setMaxDigits(Integer) - Method in class com.vonage.client.voice.ncco.DtmfSettings
 
setMaxDuration(Integer) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Controls maximum speech duration from the moment user starts speaking.
setMessageClass(Message.MessageClass) - Method in class com.vonage.client.sms.messages.Message
 
setMessagesCallbackValue(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
setMoHttpUrl(String) - Method in class com.vonage.client.numbers.OwnedNumber
 
setMoHttpUrl(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
setMoSmppSysType(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
setMsisdn(String) - Method in class com.vonage.client.numbers.AvailableNumber
 
setMsisdn(String) - Method in class com.vonage.client.numbers.OwnedNumber
 
setNetwork(String) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setNetworkCode(String) - Method in class com.vonage.client.sms.callback.messages.MO
 
setNumber(String) - Method in class com.vonage.client.voice.PhoneEndpoint
Deprecated.
setPattern(String) - Method in class com.vonage.client.numbers.ListNumbersFilter
 
setPattern(String) - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
setPayload(Map<String, Object>) - Method in class com.vonage.client.incoming.NotifyEvent
 
setPrice(String) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setProduct(RedactRequest.Product) - Method in class com.vonage.client.redact.RedactRequest
 
setProtocolId(int) - Method in class com.vonage.client.sms.messages.BinaryMessage
 
setRate(String) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setResults(Collection<Result>) - Method in class com.vonage.client.incoming.SpeechResults
 
setRingingTimer(Integer) - Method in class com.vonage.client.voice.Call
Deprecated.
setSearchPattern(SearchPattern) - Method in class com.vonage.client.numbers.ListNumbersFilter
 
setSearchPattern(SearchPattern) - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
setSessionId(String) - Method in class com.vonage.client.sms.callback.messages.MO
 
setSize(Integer) - Method in class com.vonage.client.numbers.ListNumbersFilter
 
setSize(Integer) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Set the maximum number of matching results to be returned.
setStartTime(Date) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setStartTimeout(Integer) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Controls how long the system will wait for the user to start speaking.
setStatus(CallStatus) - Method in class com.vonage.client.voice.CallEvent
Deprecated.
setStatus(CallStatus) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setStatusReportRequired(boolean) - Method in class com.vonage.client.sms.messages.Message
Set the value of the 'status-report-req' parameter.
setSubmitOnHash(Boolean) - Method in class com.vonage.client.voice.ncco.DtmfSettings
 
setText(String) - Method in class com.vonage.client.incoming.Result
 
setTextData(String, String) - Method in class com.vonage.client.sms.callback.messages.MO
 
setTimeOut(Integer) - Method in class com.vonage.client.voice.ncco.DtmfSettings
 
setTimeoutReason(SpeechResults.TimeoutReason) - Method in class com.vonage.client.incoming.SpeechResults
 
setTimestamp(Date) - Method in class com.vonage.client.incoming.NotifyEvent
 
setTimeToLive(Long) - Method in class com.vonage.client.sms.messages.Message
 
SettingsRequest - Class in com.vonage.client.account
 
SettingsRequest(String, String) - Constructor for class com.vonage.client.account.SettingsRequest
 
SettingsResponse - Class in com.vonage.client.account
 
SettingsResponse() - Constructor for class com.vonage.client.account.SettingsResponse
 
setTo(Endpoint) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setTo(Endpoint[]) - Method in class com.vonage.client.voice.Call
Deprecated.
setType(Type) - Method in class com.vonage.client.numbers.SearchNumbersFilter
 
setType(RedactRequest.Type) - Method in class com.vonage.client.redact.RedactRequest
 
setType(String) - Method in class com.vonage.client.numbers.AvailableNumber
 
setType(String) - Method in class com.vonage.client.numbers.OwnedNumber
 
setUri(String) - Method in class com.vonage.client.voice.SipEndpoint
Deprecated.
setUri(String) - Method in class com.vonage.client.voice.WebSocketEndpoint
Deprecated.
setUuid(String) - Method in class com.vonage.client.voice.CallEvent
Deprecated.
setUuid(String) - Method in class com.vonage.client.voice.CallInfo
Deprecated.
setUuid(Collection<String>) - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
setValidity(Integer) - Method in class com.vonage.client.sms.messages.WapPushMessage
Deprecated.
 
setVoiceCallbackType(UpdateNumberRequest.CallbackType) - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
setVoiceCallbackType(String) - Method in class com.vonage.client.numbers.OwnedNumber
 
setVoiceCallbackValue(String) - Method in class com.vonage.client.numbers.OwnedNumber
 
setVoiceCallbackValue(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
setVoiceStatusCallback(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
 
shortCompanyUrl(String) - Method in class com.vonage.client.meetings.Theme.Builder
(OPTIONAL) The short company URL.
SIGNATURE_API_SECRET_DISALLOWED - Enum constant in enum class com.vonage.client.sms.MessageStatus
A signed request may not also present an api_secret.
SignatureAuthMethod - Class in com.vonage.client.auth
 
SignatureAuthMethod(String, String) - Constructor for class com.vonage.client.auth.SignatureAuthMethod
 
SignatureAuthMethod(String, String, HashUtil.HashType) - Constructor for class com.vonage.client.auth.SignatureAuthMethod
 
signatureSecret(String) - Method in class com.vonage.client.VonageClient.Builder
When setting a signatureSecret, it is also expected that VonageClient.Builder.apiKey(String) will also be set.
signedCallbacks(boolean) - Method in class com.vonage.client.application.capabilities.Voice.Builder
Whether to use signed webhooks.
SILENT_AUTH - Enum constant in enum class com.vonage.client.verify2.Channel
Network-based authentication (using the device).
SilentAuthWorkflow - Class in com.vonage.client.verify2
Defines properties for mobile network-based authentication.
SilentAuthWorkflow(String) - Constructor for class com.vonage.client.verify2.SilentAuthWorkflow
Constructs a new Silent Auth verification workflow.
SilentAuthWorkflow(String, boolean) - Constructor for class com.vonage.client.verify2.SilentAuthWorkflow
Constructs a new Silent Auth verification workflow.
SINHALA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
Sip - Class in com.vonage.client.users.channels
Represents a Session Initiation Protocol (SIP) channel.
Sip() - Constructor for class com.vonage.client.users.channels.Sip
 
Sip(String) - Constructor for class com.vonage.client.users.channels.Sip
 
Sip(String, String, String) - Constructor for class com.vonage.client.users.channels.Sip
 
SIP - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
SipEndpoint - Class in com.vonage.client.voice.ncco
Represents a SIP endpoint used in a ConnectAction.
SipEndpoint - Class in com.vonage.client.voice
 
SipEndpoint() - Constructor for class com.vonage.client.voice.SipEndpoint
 
SipEndpoint(String) - Constructor for class com.vonage.client.voice.SipEndpoint
 
SipEndpoint.Builder - Class in com.vonage.client.voice.ncco
 
SLOVAK - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SLOVAK - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SLOVAK - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
SLOVENIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SLOVENIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
Sms - Class in com.vonage.client.users.channels
Represents a Short Messaging Service (SMS) channel.
Sms() - Constructor for class com.vonage.client.users.channels.Sms
 
Sms(String) - Constructor for class com.vonage.client.users.channels.Sms
Creates a new SMS channel.
SMS - Enum constant in enum class com.vonage.client.account.ServiceType
 
SMS - Enum constant in enum class com.vonage.client.conversion.ConversionRequest.Type
 
SMS - Enum constant in enum class com.vonage.client.messages.Channel
 
SMS - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
SMS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
 
SMS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
SMS - Enum constant in enum class com.vonage.client.verify2.Channel
SMS text message.
SMS_SMS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
 
SMS_SMS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
SMS_SMS_TTS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
 
SMS_SMS_TTS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
SMS_TRANSIT - Enum constant in enum class com.vonage.client.account.ServiceType
 
SMS_TTS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
 
SMS_TTS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
SMS_TTS_TTS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
The default workflow.
SMS_TTS_TTS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
The default workflow.
SmsClient - Class in com.vonage.client.sms
A client for talking to the Vonage Voice API.
SmsClient(HttpWrapper) - Constructor for class com.vonage.client.sms.SmsClient
Create a new SmsClient.
SmsInboundMetadata - Class in com.vonage.client.messages.sms
Used to describe inbound SMS metadata.
smsMetadata - Variable in class com.vonage.client.messages.InboundMessage
 
SmsSubmissionResponse - Class in com.vonage.client.sms
 
SmsSubmissionResponse() - Constructor for class com.vonage.client.sms.SmsSubmissionResponse
 
SmsSubmissionResponseMessage - Class in com.vonage.client.sms
 
SmsSubmissionResponseMessage() - Constructor for class com.vonage.client.sms.SmsSubmissionResponseMessage
 
SmsTextRequest - Class in com.vonage.client.messages.sms
 
SmsTextRequest.Builder - Class in com.vonage.client.messages.sms
 
SmsWorkflow - Class in com.vonage.client.verify2
Defines workflow properties for sending a verification code to a user via SMS.
SmsWorkflow(String) - Constructor for class com.vonage.client.verify2.SmsWorkflow
Constructs a new SMS verification workflow.
SmsWorkflow(String, String) - Constructor for class com.vonage.client.verify2.SmsWorkflow
Constructs a new SMS verification workflow.
snsBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
 
SnsClient - Class in com.vonage.client.sns
A client for talking to the Vonage SNS API.
SnsClient(HttpWrapper) - Constructor for class com.vonage.client.sns.SnsClient
Constructor.
SnsPublishRequest - Class in com.vonage.client.sns.request
 
SnsPublishRequest(String, String, String, String) - Constructor for class com.vonage.client.sns.request.SnsPublishRequest
 
SnsPublishResponse - Class in com.vonage.client.sns.response
 
SnsPublishResponse(int, String, String) - Constructor for class com.vonage.client.sns.response.SnsPublishResponse
 
SnsRequest - Class in com.vonage.client.sns.request
 
SnsRequest(String, String, String) - Constructor for class com.vonage.client.sns.request.SnsRequest
 
SnsResponse - Class in com.vonage.client.sns.response
 
SnsResponse(String, int, String) - Constructor for class com.vonage.client.sns.response.SnsResponse
 
SnsSubscribeRequest - Class in com.vonage.client.sns.request
 
SnsSubscribeRequest(String, String) - Constructor for class com.vonage.client.sns.request.SnsSubscribeRequest
 
SnsSubscribeResponse - Class in com.vonage.client.sns.response
Represents the result of a publish service request to the Vonage SNS Service.
SnsSubscribeResponse(int, String, String) - Constructor for class com.vonage.client.sns.response.SnsSubscribeResponse
 
socketTimeout(int) - Method in class com.vonage.client.common.Webhook.Builder
(OPTIONAL) If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint.
SORT_KEY - Static variable in class com.vonage.client.auth.SignatureAuthMethod
 
SortOrder - Enum Class in com.vonage.client.proactiveconnect
Represents the sort order for events.
sourceContext(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
The name of the segment / matcher the item / event to filter by (exact string).
sourceType(SourceType) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Source type to filter by.
SourceType - Enum Class in com.vonage.client.proactiveconnect
Represents source types for events.
SOUTH_AFRICAN_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
SPANISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SPANISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
SPANISH_ARG - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SPANISH_ARGENTINA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_BOLIVIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_CATALAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
SPANISH_CHILE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_COLOMBIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_COSTA_RICA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_DOMINICAN_REPUBLIC - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_ECUADOR - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_EL_SALVADOR - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_GUATEMALA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_HONDURAS - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_MEX - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SPANISH_MEXICO - Enum constant in enum class com.vonage.client.verify2.Locale
 
SPANISH_MEXICO - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_NICARAGUA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_PANAMA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_PARAGUAY - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_PERU - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_PUERTO_RICO - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_SPA - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SPANISH_SPAIN - Enum constant in enum class com.vonage.client.verify2.Locale
 
SPANISH_SPAIN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_UNITED_STATES - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_URUGUAY - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SPANISH_US - Enum constant in enum class com.vonage.client.verify2.Locale
 
SPANISH_VENEZUELA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
speech(SpeechSettings) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
SpeechResults - Class in com.vonage.client.incoming
 
SpeechResults() - Constructor for class com.vonage.client.incoming.SpeechResults
 
SpeechResults.TimeoutReason - Enum Class in com.vonage.client.incoming
 
SpeechSettings - Class in com.vonage.client.voice.ncco
ASR(Automatic Speech Recognition) settings for Input Actions that will be added to a NCCO object.
SpeechSettings() - Constructor for class com.vonage.client.voice.ncco.SpeechSettings
 
SpeechSettings.Language - Enum Class in com.vonage.client.voice.ncco
 
split(SplitRecording) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
SplitRecording - Enum Class in com.vonage.client.voice.ncco
 
StandardInsightRequest - Class in com.vonage.client.insight
 
StandardInsightRequest.Builder - Class in com.vonage.client.insight
 
StandardInsightResponse - Class in com.vonage.client.insight
Response object constructed from the JSON payload returned for Standard number insight requests.
StandardInsightResponse() - Constructor for class com.vonage.client.insight.StandardInsightResponse
 
START_TIMEOUT - Enum constant in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
 
startDate(Instant) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
ISO-8601 formatted date for when to begin events filter.
startDate(Instant) - Method in class com.vonage.client.subaccounts.ListTransfersFilter.Builder
(OPTIONAL) Start of the retrieval period.
STARTED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
STARTED - Enum constant in enum class com.vonage.client.meetings.RecordingStatus
 
STARTED - Enum constant in enum class com.vonage.client.voice.CallStatus
 
startOnEnter(Boolean) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
 
STARTS_WITH - Enum constant in enum class com.vonage.client.numbers.SearchPattern
 
startStream(String, String) - Method in class com.vonage.client.voice.VoiceClient
Stream audio to an ongoing call.
startStream(String, String, int) - Method in class com.vonage.client.voice.VoiceClient
Stream audio to an ongoing call.
startStream(String, String, int, double) - Method in class com.vonage.client.voice.VoiceClient
Stream audio to an ongoing call.
startTalk(String, TalkPayload) - Method in class com.vonage.client.voice.VoiceClient
Send a synthesized speech message to an ongoing call.
startTalk(String, String) - Method in class com.vonage.client.voice.VoiceClient
startTalk(String, String, int) - Method in class com.vonage.client.voice.VoiceClient
startTalk(String, String, TextToSpeechLanguage) - Method in class com.vonage.client.voice.VoiceClient
startTalk(String, String, TextToSpeechLanguage, int) - Method in class com.vonage.client.voice.VoiceClient
startTalk(String, String, TextToSpeechLanguage, int, int) - Method in class com.vonage.client.voice.VoiceClient
status - Variable in class com.vonage.client.messages.MessageStatus
 
status - Variable in class com.vonage.client.verify2.VerificationCallback
 
status - Variable in class com.vonage.client.verify2.WorkflowStatus
 
status(CallStatus) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
STATUS - Enum constant in enum class com.vonage.client.common.Webhook.Type
 
STATUS_ALREADY_REQUESTED - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected because another verification to the same number was already requested.
STATUS_BAD_COMMAND - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_COMMS_FAILURE - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_COMMS_FAILURE - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
A network error occurred
STATUS_INTERNAL_ERROR - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_INTERNAL_ERROR - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected due to a failure within the Vonage systems.
Verify can be re-submitted after a short delay
STATUS_INVALID_ACCOUNT - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_INVALID_CODE - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
The code inserted does not match the expected value
STATUS_INVALID_CREDENTIALS - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected due to receiving invalid account api key and/or secret
STATUS_INVALID_OR_MISSING_FROM - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_INVALID_OR_MISSING_MSG - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_INVALID_OR_MISSING_MSISDN - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_INVALID_PARAMS - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected due to an illegal value in one or more elements of the submission request
STATUS_INVALID_REQUEST - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected because the Vonage service was unable to handle this request.
STATUS_MISSING_PARAMS - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected due to incomplete data in the submission request
STATUS_MISSING_TOPIC - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_NO_RESPONSE - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
There are no matching verification requests
STATUS_NUMBER_BARRED - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected because the phone number you tried to submit to has been blacklisted.
STATUS_OK - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_OK - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was successfully submitted to the Vonage service
STATUS_PARTNER_ACCOUNT_BARRED - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected because your account has been barred, or has not yet been activated
STATUS_PARTNER_QUOTA_EXCEEDED - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected because your pre-paid balance does not contain enough credit to handle this request.
Please top up your balance before re-submitting this request or subsequent requests.
STATUS_THROTTLED - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
Verify was rejected due to exceeding the maximum throughput allowed for this account.
Verify can be re-requested after a short delay
STATUS_TOO_MANY_DESTINATIONS - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
There are more than the maximum allowed number of destinations in this request
STATUS_TOPIC_NOT_FOUND - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_TOPIC_PERMISSION_FAILURE - Static variable in class com.vonage.client.sns.response.SnsResponse
 
STATUS_UNSUPPORTED_NETWORK - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
The destination number is not in a supported network
STATUS_WRONG_CODE_THROTTLED - Static variable in class com.vonage.client.verify.BaseResult
Deprecated.
A wrong code was provided too many times
statusCode - Variable in exception com.vonage.client.VonageApiResponseException
 
sticker - Variable in class com.vonage.client.messages.InboundMessage
 
Sticker - Class in com.vonage.client.messages.whatsapp
 
STICKER - Enum constant in enum class com.vonage.client.messages.MessageType
 
STOPPED - Enum constant in enum class com.vonage.client.meetings.RecordingStatus
 
stopStream(String) - Method in class com.vonage.client.voice.VoiceClient
Stop the audio being streamed into a call.
stopTalk(String) - Method in class com.vonage.client.voice.VoiceClient
Stop the message being spoken into a call.
StreamAction - Class in com.vonage.client.voice.ncco
An NCCO stream action which allows for media to be streamed to a call.
StreamAction.Builder - Class in com.vonage.client.voice.ncco
 
StreamResponse - Class in com.vonage.client.voice
Response from successfully streaming an audio file or stopping a stream to an active Call.
StreamResponse() - Constructor for class com.vonage.client.voice.StreamResponse
 
streamUrl(String...) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
streamUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
stringValue(Node) - Static method in class com.vonage.client.legacyutils.XmlUtil
 
style(int) - Method in class com.vonage.client.voice.ncco.PayAction.Builder
Deprecated.
(OPTIONAL)
style(int) - Method in class com.vonage.client.voice.TalkPayload.Builder
The vocal style (vocal range, tessitura, and timbre) to use for text-to-speech.
style(Integer) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
subaccount(String) - Method in class com.vonage.client.subaccounts.ListTransfersFilter.Builder
(OPTIONAL) Subaccount ID to include in the search.
SubaccountsClient - Class in com.vonage.client.subaccounts
 
SubaccountsClient(HttpWrapper) - Constructor for class com.vonage.client.subaccounts.SubaccountsClient
Constructor.
SubaccountsResponseException - Exception in com.vonage.client.subaccounts
Response returned when an error is encountered (i.e.
SubaccountsResponseException() - Constructor for exception com.vonage.client.subaccounts.SubaccountsResponseException
 
submitConversion(ConversionRequest.Type, String, boolean, Date) - Method in class com.vonage.client.conversion.ConversionClient
Submit a request to the Conversion API indicating whether or not a message was delivered.
submitMessage(Message) - Method in class com.vonage.client.sms.SmsClient
Send an SMS message.
SUBMITTED - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
submittedAt - Variable in class com.vonage.client.verify2.VerificationCallback
 
subscribe(SnsSubscribeRequest) - Method in class com.vonage.client.sns.SnsClient
 
SUCCESS - Enum constant in enum class com.vonage.client.insight.InsightStatus
Request accepted for delivery.
SUCCESS - Enum constant in enum class com.vonage.client.insight.LookupOutcome
 
SUCCESS - Enum constant in enum class com.vonage.client.verify.VerifyDetails.Status
Your user entered a correct verification code.
SUMMARY - Enum constant in enum class com.vonage.client.verify2.CallbackType
Used for inbound status updates for a particular request.
SUNDANESE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
suspended(boolean) - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest.Builder
(OPTIONAL) Whether to suspend this subaccount.
SWAHILI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SWAHILI_KENYA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SWAHILI_TANZANIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SWEDISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
SWEDISH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
SWEDISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
SWEDISH_SWEDEN - Enum constant in enum class com.vonage.client.verify2.Locale
 
SYNCHRONOUS - Enum constant in enum class com.vonage.client.voice.ncco.EventType
 
SyncStatus - Class in com.vonage.client.proactiveconnect
Provides info on list changes compared to the latest sync.
SyncStatus() - Constructor for class com.vonage.client.proactiveconnect.SyncStatus
 
SyncStatusValue - Enum Class in com.vonage.client.proactiveconnect
Represents the sync status values for SyncStatus.getValue().

T

tag - Variable in class com.vonage.client.messages.messenger.MessengerRequest.Builder
 
tag(Tag) - Method in class com.vonage.client.messages.messenger.MessengerRequest.Builder
(OPTIONAL, but REQUIRED if Category is Category.MESSAGE_TAG) A tag describing the type and relevance of the 1:1 communication between your app and the end user.
Tag - Enum Class in com.vonage.client.messages.messenger
Represents a Facebook Message Tag.
tags(String...) - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Sets the tags.
tags(List<String>) - Method in class com.vonage.client.proactiveconnect.ContactsList.Builder
Sets the list's tags.
TAIWANESE_MANDARIN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
TalkAction - Class in com.vonage.client.voice.ncco
An NCCO talk action which allows for synthesized speech to be sent to a call.
TalkAction.Builder - Class in com.vonage.client.voice.ncco
 
TalkPayload - Class in com.vonage.client.voice
Defines the text-to-speech properties.
TalkPayload.Builder - Class in com.vonage.client.voice
Builder for configuring properties of TalkPayload.
TalkResponse - Class in com.vonage.client.voice
Response from successfully sending a synthesized speech message or stopping a message to an active Call.
TalkResponse() - Constructor for class com.vonage.client.voice.TalkResponse
 
TAMIL - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
TAMIL_INDIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
TAMIL_MALAYSIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
TAMIL_SINGAPORE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
TAMIL_SRI_LANKA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
TEL - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
TELUGU - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
TELUGU - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
Template - Class in com.vonage.client.messages.whatsapp
 
TEMPLATE - Enum constant in enum class com.vonage.client.messages.MessageType
 
text - Variable in class com.vonage.client.messages.InboundMessage
 
text(String) - Method in class com.vonage.client.messages.messenger.MessengerTextRequest.Builder
(REQUIRED) Sets the text field.
text(String) - Method in class com.vonage.client.messages.sms.SmsTextRequest.Builder
(REQUIRED) Sets the text field.
text(String) - Method in class com.vonage.client.messages.viber.ViberTextRequest.Builder
(REQUIRED) Sets the text field.
text(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappTextRequest.Builder
(REQUIRED) Sets the text field.
text(String) - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
 
text(String) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
Text - Class in com.vonage.client.messages.internal
Convenience class for validating text messages.
Text(String, int) - Constructor for class com.vonage.client.messages.internal.Text
 
TEXT - Enum constant in enum class com.vonage.client.incoming.MessageType
 
TEXT - Enum constant in enum class com.vonage.client.messages.MessageType
 
TEXT - Enum constant in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
This is a plain text (8 bit alphabet) message
TEXT - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageType
Message is a regular TEXT SMS message
TextMessage - Class in com.vonage.client.sms.messages
Represents the details of a plain-text message that is to be submitted via the Vonage REST api.
TextMessage(String, String, String) - Constructor for class com.vonage.client.sms.messages.TextMessage
Instantiate a new text-message request.
This message will be submitted as a regular 8 bit text message
TextMessage(String, String, String, boolean) - Constructor for class com.vonage.client.sms.messages.TextMessage
Instantiate a new text-message request.
This message will be submitted as a regular 8 bit text message
TextToSpeechLanguage - Enum Class in com.vonage.client.voice
Enum representing the available TTS language options.
THAI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
THAI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
THAI - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
THAI_THAILAND - Enum constant in enum class com.vonage.client.verify2.Locale
 
Theme - Class in com.vonage.client.meetings
 
Theme() - Constructor for class com.vonage.client.meetings.Theme
 
Theme.Builder - Class in com.vonage.client.meetings
 
ThemeDomain - Enum Class in com.vonage.client.meetings
Represents the application domain for a theme.
themeId(UUID) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
ID of the theme for this room.
themeId(UUID) - Method in class com.vonage.client.meetings.UpdateRoomRequest.Builder
 
themeName(String) - Method in class com.vonage.client.meetings.Theme.Builder
(OPTIONAL) The name to give the theme (maximum 200 characters).
THROTTLED - Enum constant in enum class com.vonage.client.insight.InsightStatus
You have made more requests in the last second than are permitted by your account.
THROTTLED - Enum constant in enum class com.vonage.client.sms.MessageStatus
You are sending SMS faster than the account limit.
THROTTLED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
You are trying to send more than the maximum of 30 requests per second.
thumbUrl - Variable in class com.vonage.client.messages.viber.Video
 
thumbUrl(String) - Method in class com.vonage.client.messages.viber.ViberVideoRequest.Builder
(REQUIRED) URL to an image file (.jpg) for a thumbnail preview of the video.
timeout(String) - Method in class com.vonage.client.voice.ncco.PaymentPrompt.Builder
Deprecated.
Adds a Timeout error.
timeOut(Integer) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
 
timeOut(Integer) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
Timeout(String) - Constructor for class com.vonage.client.voice.ncco.PaymentPrompt.Errors.Timeout
Deprecated.
 
TIMEOUT - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
TIMEOUT - Enum constant in enum class com.vonage.client.voice.CallStatus
 
timeoutMillis(int) - Method in class com.vonage.client.HttpConfig.Builder
Sets the socket timeout for requests.
timestamp - Variable in class com.vonage.client.messages.InboundMessage
 
timestamp - Variable in class com.vonage.client.messages.MessageStatus
 
title - Variable in exception com.vonage.client.VonageApiResponseException
 
to - Variable in class com.vonage.client.messages.InboundMessage
 
to - Variable in class com.vonage.client.messages.MessageRequest.Builder
 
to - Variable in class com.vonage.client.messages.MessageRequest
 
to - Variable in class com.vonage.client.messages.MessageStatus
 
to - Variable in class com.vonage.client.verify2.Workflow
 
to(Endpoint...) - Method in class com.vonage.client.voice.Call.Builder
Sets the endpoints (recipients) of the call.
to(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(REQUIRED) Sets the recipient number or ID.
toByteArray() - Method in interface com.vonage.client.BinaryRequest
Serialises this request to a byte array.
toJson() - Method in interface com.vonage.client.Jsonable
 
toJson() - Method in class com.vonage.client.meetings.Theme
 
toJson() - Method in class com.vonage.client.meetings.UpdateApplicationRequest
Generates a JSON payload from this request.
toJson() - Method in class com.vonage.client.meetings.UpdateRoomRequest
Generates a JSON payload from this request.
toJson() - Method in class com.vonage.client.voice.Call
Generates a JSON payload from this request.
toJson() - Method in class com.vonage.client.voice.CallModifier
Deprecated.
 
toJson() - Method in class com.vonage.client.voice.ModifyCallPayload
Deprecated.
 
toJson() - Method in class com.vonage.client.voice.ncco.Ncco
 
toJson() - Method in class com.vonage.client.voice.servlet.NccoResponse
 
toJson() - Method in class com.vonage.client.voice.TalkPayload
Generates a JSON payload from this request.
toJson() - Method in exception com.vonage.client.VonageApiResponseException
Generates JSON from this object.
TokenAuthMethod - Class in com.vonage.client.auth
 
TokenAuthMethod(String, String) - Constructor for class com.vonage.client.auth.TokenAuthMethod
 
toLog() - Method in class com.vonage.client.voice.AppEndpoint
 
toLog() - Method in interface com.vonage.client.voice.Endpoint
Description of the endpoint.
toLog() - Method in class com.vonage.client.voice.PhoneEndpoint
 
toLog() - Method in class com.vonage.client.voice.SipEndpoint
 
toLog() - Method in class com.vonage.client.voice.VbcEndpoint
 
toLog() - Method in class com.vonage.client.voice.WebSocketEndpoint
 
TOO_MANY_BINDS - Enum constant in enum class com.vonage.client.sms.MessageStatus
The number of simultaneous connections to the platform exceeds your account allocation.
TOO_MANY_DESTINATIONS - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
TOO_MANY_DESTINATIONS - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Deprecated.
This value is no longer used / returned by the API.
topUp(String) - Method in class com.vonage.client.account.AccountClient
Top-up your account when you have enabled auto-reload in the dashboard.
toString() - Method in enum class com.vonage.client.account.Network.Type
 
toString() - Method in enum class com.vonage.client.account.ServiceType
 
toString() - Method in enum class com.vonage.client.application.capabilities.Region
 
toString() - Method in class com.vonage.client.common.E164
 
toString() - Method in class com.vonage.client.incoming.NotifyEvent
 
toString() - Method in enum class com.vonage.client.insight.CallerType
 
toString() - Method in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
toString() - Method in enum class com.vonage.client.insight.PortedStatus
 
toString() - Method in enum class com.vonage.client.insight.Reachability
 
toString() - Method in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
 
toString() - Method in enum class com.vonage.client.insight.Validity
 
toString() - Method in enum class com.vonage.client.meetings.EventType
 
toString() - Method in enum class com.vonage.client.meetings.JoinApprovalLevel
 
toString() - Method in enum class com.vonage.client.meetings.LogoType
 
toString() - Method in enum class com.vonage.client.meetings.MicrophoneState
 
toString() - Method in enum class com.vonage.client.meetings.RecordingStatus
 
toString() - Method in enum class com.vonage.client.meetings.RoomLanguage
 
toString() - Method in enum class com.vonage.client.meetings.RoomType
 
toString() - Method in enum class com.vonage.client.messages.Channel
 
toString() - Method in class com.vonage.client.messages.internal.Text
 
toString() - Method in class com.vonage.client.messages.MessageRequest
 
toString() - Method in class com.vonage.client.messages.MessageResponse
 
toString() - Method in class com.vonage.client.messages.MessageStatus.Error
 
toString() - Method in enum class com.vonage.client.messages.MessageStatus.Status
 
toString() - Method in class com.vonage.client.messages.MessageStatus
 
toString() - Method in class com.vonage.client.messages.MessageStatus.Usage
 
toString() - Method in enum class com.vonage.client.messages.MessageType
 
toString() - Method in enum class com.vonage.client.messages.messenger.Category
 
toString() - Method in enum class com.vonage.client.messages.messenger.Tag
 
toString() - Method in enum class com.vonage.client.messages.viber.Category
 
toString() - Method in enum class com.vonage.client.messages.whatsapp.Locale
 
toString() - Method in enum class com.vonage.client.messages.whatsapp.Policy
 
toString() - Method in enum class com.vonage.client.proactiveconnect.EventType
 
toString() - Method in enum class com.vonage.client.proactiveconnect.SortOrder
 
toString() - Method in enum class com.vonage.client.proactiveconnect.SourceType
 
toString() - Method in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
toString() - Method in enum class com.vonage.client.sms.messages.Message.MessageType
 
toString() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
toString() - Method in class com.vonage.client.subaccounts.NumberTransfer
 
toString() - Method in enum class com.vonage.client.users.channels.Websocket.ContentType
 
toString() - Method in enum class com.vonage.client.users.ListUsersRequest.SortOrder
 
toString() - Method in class com.vonage.client.verify.BaseRequest
 
toString() - Method in class com.vonage.client.verify.Psd2Request
 
toString() - Method in enum class com.vonage.client.verify.VerifyControlCommand
 
toString() - Method in class com.vonage.client.verify.VerifyRequest
 
toString() - Method in enum class com.vonage.client.verify2.CallbackType
 
toString() - Method in enum class com.vonage.client.verify2.Channel
 
toString() - Method in enum class com.vonage.client.verify2.Locale
 
toString() - Method in class com.vonage.client.verify2.VerificationResponse
 
toString() - Method in enum class com.vonage.client.verify2.VerificationStatus
 
toString() - Method in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
 
toString() - Method in enum class com.vonage.client.voice.CallDirection
 
toString() - Method in class com.vonage.client.voice.CallInfo
 
toString() - Method in enum class com.vonage.client.voice.CallStatus
 
toString() - Method in enum class com.vonage.client.voice.MachineDetection
 
toString() - Method in enum class com.vonage.client.voice.ModifyCallAction
 
toString() - Method in enum class com.vonage.client.voice.ncco.EventType
 
toString() - Method in enum class com.vonage.client.voice.ncco.PaymentPrompt.Type
Deprecated.
 
toString() - Method in enum class com.vonage.client.voice.ncco.RecordingFormat
 
toString() - Method in enum class com.vonage.client.voice.ncco.SplitRecording
 
toString() - Method in enum class com.vonage.client.voice.TransferDestination.Type
Deprecated.
 
totalItems - Variable in class com.vonage.client.common.HalPageResponse
 
totalPages - Variable in class com.vonage.client.common.HalPageResponse
 
traceId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Trace ID to filter by.
TRANSACTION - Enum constant in enum class com.vonage.client.messages.viber.Category
 
TRANSFER - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
transferBalance(MoneyTransfer) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Transfer balance between the primary account and one of its subaccounts.
transferCall(String, Ncco) - Static method in class com.vonage.client.voice.CallModifier
Deprecated.
 
transferCall(String, Ncco) - Method in class com.vonage.client.voice.VoiceClient
Transfer a call to a different NCCO.
transferCall(String, String) - Static method in class com.vonage.client.voice.CallModifier
Deprecated.
 
transferCall(String, String) - Method in class com.vonage.client.voice.VoiceClient
Transfer a call to a different NCCO endpoint.
TransferCallPayload - Class in com.vonage.client.voice
Deprecated.
Will be made package-private in next major release.
TransferCallPayload(Ncco) - Constructor for class com.vonage.client.voice.TransferCallPayload
Deprecated.
 
TransferCallPayload(String) - Constructor for class com.vonage.client.voice.TransferCallPayload
Deprecated.
 
transferCredit(MoneyTransfer) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Transfer credit limit between the primary account and one of its subaccounts.
TransferDestination - Class in com.vonage.client.voice
Deprecated.
Will be made package-private in next major release.
TransferDestination(TransferDestination.Type, String) - Constructor for class com.vonage.client.voice.TransferDestination
Deprecated.
 
TransferDestination(TransferDestination.Type, String, Ncco) - Constructor for class com.vonage.client.voice.TransferDestination
Deprecated.
 
TransferDestination.Type - Enum Class in com.vonage.client.voice
Deprecated.
 
transferNumber(NumberTransfer) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Transfer a number between subaccounts.
TRIGGER_NEXT_EVENT - Enum constant in enum class com.vonage.client.verify.VerifyControlCommand
 
triggeredAt - Variable in class com.vonage.client.verify2.VerificationCallback
 
ttl - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
ttl(int) - Method in class com.vonage.client.messages.viber.ViberRequest.Builder
(OPTIONAL) Sets the time-to-live of message to be delivered in seconds.
TTS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
 
TTS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
TTS_TTS - Enum constant in enum class com.vonage.client.verify.Psd2Request.Workflow
 
TTS_TTS - Enum constant in enum class com.vonage.client.verify.VerifyRequest.Workflow
 
TURKISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
TURKISH - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
TURKISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
TURKISH_TURKEY - Enum constant in enum class com.vonage.client.verify2.Locale
 
type - Variable in class com.vonage.client.proactiveconnect.Datasource
 
type - Variable in class com.vonage.client.verify2.VerificationCallback
 
type - Variable in exception com.vonage.client.VonageApiResponseException
 
type(RoomType) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Type of room.
type(VerifyRequest.LineType) - Method in class com.vonage.client.verify.VerifyRequest.Builder
Deprecated.
This is no longer used and will be removed in the next major release.
type(Collection<String>) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
 
Type - Enum Class in com.vonage.client.numbers
Enumeration representing the type of number.

U

uiSettings(UISettings) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Settings for the user interface of this meeting.
UISettings - Class in com.vonage.client.meetings
 
UISettings() - Constructor for class com.vonage.client.meetings.UISettings
 
UISettings.Builder - Class in com.vonage.client.meetings
 
UKRAINIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
UKRAINIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
UKRAINIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
UNANSWERED - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
UNAVAILABLE - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Callee is temporarily unavailable.
UNDELIVERABLE - Enum constant in enum class com.vonage.client.insight.Reachability
 
UNDELIVERABLE - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
UNEARMUFF - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
UNICODE - Enum constant in enum class com.vonage.client.incoming.MessageType
 
UNICODE - Enum constant in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
This is a unicode message
UNICODE - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageType
Message is a unicode message, for sending messages in non-latin script to a supported handset
UNITED_KINGDOM_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
UNKNOWN - Enum constant in enum class com.vonage.client.account.Network.Type
 
UNKNOWN - Enum constant in enum class com.vonage.client.common.HttpMethod
 
UNKNOWN - Enum constant in enum class com.vonage.client.common.Webhook.Type
 
UNKNOWN - Enum constant in enum class com.vonage.client.incoming.CallDirection
 
UNKNOWN - Enum constant in enum class com.vonage.client.incoming.CallStatus
 
UNKNOWN - Enum constant in enum class com.vonage.client.incoming.MessageType
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.CallerType
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.InsightStatus
Undefined or unknown value.
UNKNOWN - Enum constant in enum class com.vonage.client.insight.LookupOutcome
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.PortedStatus
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.Reachability
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
 
UNKNOWN - Enum constant in enum class com.vonage.client.insight.Validity
 
UNKNOWN - Enum constant in enum class com.vonage.client.numbers.Type
 
UNKNOWN - Enum constant in enum class com.vonage.client.sms.MessageStatus
Unknown status code.
UNKNOWN - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Undefined or unknown value.
UNKNOWN - Enum constant in enum class com.vonage.client.voice.CallDirection
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.CallStatus
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.MachineDetection
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.ncco.RecordingFormat
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
unknownProperties - Variable in class com.vonage.client.messages.InboundMessage
 
unknownProperties - Variable in class com.vonage.client.messages.MessageStatus
 
UNMAPPED_DETAIL - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
detail present, but has not been mapped to an enum yet
UNMUTE - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
UNSUPPORTED - Enum constant in enum class com.vonage.client.messages.MessageType
 
UNSUPPORTED_NETWORK - Enum constant in enum class com.vonage.client.verify.VerifyStatus
The request has been rejected.
UNSUPPORTED_PIN_CODE - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Only certain accounts have the ability to set the pin_code parameter.
UNUSED - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
Unused.
UPDATE - Enum constant in enum class com.vonage.client.messages.messenger.Category
 
updateApplication(Application) - Method in class com.vonage.client.application.ApplicationClient
Update an existing application.
updateApplication(UpdateApplicationRequest) - Method in class com.vonage.client.meetings.MeetingsClient
Update an existing application.
UpdateApplicationRequest - Class in com.vonage.client.meetings
 
UpdateApplicationRequest.Builder - Class in com.vonage.client.meetings
 
updateDeliveryReceiptUrl(String) - Method in class com.vonage.client.account.AccountClient
 
updateFromJson(String) - Method in class com.vonage.client.account.ListSecretsResponse
 
updateFromJson(String) - Method in class com.vonage.client.account.SecretResponse
 
updateFromJson(String) - Method in interface com.vonage.client.Jsonable
 
updateFromJson(String) - Method in class com.vonage.client.verify.SearchVerifyResponse
 
updateList(UUID, ContactsList) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Update an existing list.
updateListItem(UUID, UUID, Map<String, ?>) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Update an existing list item.
updateNumber(UpdateNumberRequest) - Method in class com.vonage.client.numbers.NumbersClient
Update the callbacks and/or application associations for a given Vonage Virtual Number.
UpdateNumberRequest - Class in com.vonage.client.numbers
 
UpdateNumberRequest(String, String) - Constructor for class com.vonage.client.numbers.UpdateNumberRequest
 
UpdateNumberRequest.CallbackType - Enum Class in com.vonage.client.numbers
 
updateRoom(UUID, UpdateRoomRequest) - Method in class com.vonage.client.meetings.MeetingsClient
Update an existing room.
UpdateRoomRequest - Class in com.vonage.client.meetings
 
UpdateRoomRequest.Builder - Class in com.vonage.client.meetings
 
updateSettings(SettingsRequest) - Method in class com.vonage.client.account.AccountClient
 
updateSmsIncomingUrl(String) - Method in class com.vonage.client.account.AccountClient
 
updateSubaccount(UpdateSubaccountRequest) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Change one or more properties of a subaccount.
UpdateSubaccountRequest - Class in com.vonage.client.subaccounts
 
UpdateSubaccountRequest.Builder - Class in com.vonage.client.subaccounts
 
updateTheme(UUID, Theme) - Method in class com.vonage.client.meetings.MeetingsClient
Update an existing theme.
updateThemeLogo(UUID, LogoType, Path) - Method in class com.vonage.client.meetings.MeetingsClient
Upload a logo image and associates it with a theme.
updateUser(String, User) - Method in class com.vonage.client.users.UsersClient
Update an existing user.
UPLOADED - Enum constant in enum class com.vonage.client.meetings.RecordingStatus
 
uploadListItems(UUID, Path) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Import list items from a CSV file.
UploadListItemsResponse - Class in com.vonage.client.proactiveconnect
Results from list upload.
UploadListItemsResponse() - Constructor for class com.vonage.client.proactiveconnect.UploadListItemsResponse
 
URDU - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
URDU_INDIA - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
URDU_PAKISTAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
uri(String) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
 
uri(String) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
uri(URI) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
 
uri(URI) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
url - Variable in class com.vonage.client.messages.InboundMessage.UrlWrapper
 
url - Variable in class com.vonage.client.messages.internal.MessagePayload
 
url(String) - Method in class com.vonage.client.messages.messenger.MessengerAudioRequest.Builder
(REQUIRED) Sets the URL of the audio attachment.
url(String) - Method in class com.vonage.client.messages.messenger.MessengerFileRequest.Builder
(REQUIRED) Sets the URL of the file attachment.
url(String) - Method in class com.vonage.client.messages.messenger.MessengerImageRequest.Builder
(REQUIRED) Sets the URL of the image attachment.
url(String) - Method in class com.vonage.client.messages.messenger.MessengerVideoRequest.Builder
(REQUIRED) Sets the URL of the video attachment.
url(String) - Method in class com.vonage.client.messages.mms.MmsAudioRequest.Builder
(REQUIRED) Sets the URL of the audio attachment.
url(String) - Method in class com.vonage.client.messages.mms.MmsImageRequest.Builder
(REQUIRED) Sets the URL of the image attachment.
url(String) - Method in class com.vonage.client.messages.mms.MmsRequest.Builder
 
url(String) - Method in class com.vonage.client.messages.mms.MmsVcardRequest.Builder
(REQUIRED) Sets the URL of the vCard attachment.
url(String) - Method in class com.vonage.client.messages.mms.MmsVideoRequest.Builder
(REQUIRED) Sets the URL of the video attachment.
url(String) - Method in class com.vonage.client.messages.viber.ViberFileRequest.Builder
(REQUIRED) The URL for the file attachment or the path for the location of the file attachment.
url(String) - Method in class com.vonage.client.messages.viber.ViberImageRequest.Builder
(REQUIRED) Sets the URL of the image attachment.
url(String) - Method in class com.vonage.client.messages.viber.ViberVideoRequest.Builder
(REQUIRED) Sets the URL of the video attachment.
url(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappAudioRequest.Builder
(REQUIRED) Sets the URL of the audio attachment.
url(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappFileRequest.Builder
(REQUIRED) Sets the URL of the file attachment.
url(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappImageRequest.Builder
(REQUIRED) Sets the URL of the image attachment.
url(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappStickerRequest.Builder
(REQUIRED if WhatsappStickerRequest.Builder.id(String) is not specified) The publicly accessible URL of the sticker image.
url(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappVideoRequest.Builder
(REQUIRED) Sets the URL of the video attachment.
UrlContainer - Class in com.vonage.client.meetings
 
UrlContainer() - Constructor for class com.vonage.client.meetings.UrlContainer
 
UrlWrapper() - Constructor for class com.vonage.client.messages.InboundMessage.UrlWrapper
 
usage - Variable in class com.vonage.client.messages.InboundMessage
 
usage - Variable in class com.vonage.client.messages.MessageStatus
 
Usage() - Constructor for class com.vonage.client.messages.MessageStatus.Usage
 
usePrimaryAccountBalance(boolean) - Method in class com.vonage.client.subaccounts.CreateSubaccountRequest.Builder
(OPTIONAL) Whether to use the primary account's balance.
usePrimaryAccountBalance(boolean) - Method in class com.vonage.client.subaccounts.UpdateSubaccountRequest.Builder
(OPTIONAL) Whether to use the primary account's balance.
user(String) - Method in class com.vonage.client.voice.ncco.AppEndpoint.Builder
 
User - Class in com.vonage.client.users
Represents a Vonage User (both request and response).
USER_REJECTED - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
User rejected.
User.Builder - Class in com.vonage.client.users
 
User.Properties - Class in com.vonage.client.users
Represents the "properties" field of a User object.
useRegularEndpoint() - Method in class com.vonage.client.messages.MessagesClient
Calling this method will make the client use the regular endpoint returned by HttpConfig.getApiBaseUri(), which is the default behaviour.
UsersClient - Class in com.vonage.client.users
A client for talking to the Vonage Users API.
UsersClient(HttpWrapper) - Constructor for class com.vonage.client.users.UsersClient
 
UsersResponseException - Exception in com.vonage.client.users
Response returned when an error is encountered (i.e.
UsersResponseException() - Constructor for exception com.vonage.client.users.UsersResponseException
 
useSandboxEndpoint() - Method in class com.vonage.client.messages.MessagesClient
Calling this method will make the client use the sandbox endpoint, which will enable you to use the Messages Sandbox.
UZBEK - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 

V

VALID - Enum constant in enum class com.vonage.client.insight.Validity
 
VALID - Enum constant in enum class com.vonage.client.verify.VerifyCheck.Status
 
validateCaptionLength(int) - Method in class com.vonage.client.messages.internal.MessagePayload
 
validateClientReference(String) - Method in class com.vonage.client.messages.MessageRequest
Validates and possibly sanitizes the client reference.
validateExtension(String, String...) - Static method in class com.vonage.client.messages.internal.MessagePayload
 
validateFileExtensions() - Method in class com.vonage.client.messages.viber.File
 
validateFileExtensions() - Method in class com.vonage.client.messages.viber.Video
 
validateSenderAndRecipient(String, String) - Method in class com.vonage.client.messages.MessageRequest
This method is used to validate the format of sender and recipient fields.
validateSenderAndRecipient(String, String) - Method in class com.vonage.client.messages.messenger.MessengerRequest
 
validateSenderAndRecipient(String, String) - Method in class com.vonage.client.messages.viber.ViberRequest
 
validateSenderAndRecipient(String, String) - Method in class com.vonage.client.messages.whatsapp.WhatsappRequest
 
validateUrlExtension(String...) - Method in class com.vonage.client.messages.internal.MessagePayload
 
validateUrlLength(int, int) - Method in class com.vonage.client.messages.internal.MessagePayload
 
Validity - Enum Class in com.vonage.client.insight
Enum representing the existence of a number.
valueOf(String) - Static method in enum class com.vonage.client.account.Network.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.account.ServiceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.application.capabilities.Capability.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.application.capabilities.Region
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.common.HttpMethod
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.common.Webhook.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.conversion.ConversionRequest.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.CallDirection
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.CallStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.CallStatusDetail
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.MessageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.CallerType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.CarrierDetails.NetworkType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.InsightStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.LookupOutcome
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.PortedStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.Reachability
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.insight.Validity
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.EventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.JoinApprovalLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.LogoType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.MicrophoneState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.RecordingStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.RoomLanguage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.RoomType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.meetings.ThemeDomain
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.Channel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.MessageStatus.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.MessageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.messenger.Category
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.messenger.Tag
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.viber.Category
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.whatsapp.Locale
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.whatsapp.Policy
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numbers.SearchPattern
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numbers.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.proactiveconnect.EventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.proactiveconnect.SortOrder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.proactiveconnect.SourceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.proactiveconnect.SyncStatusValue
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.redact.RedactRequest.Product
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.redact.RedactRequest.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.sms.messages.Message.MessageClass
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.sms.messages.Message.MessageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.sms.MessageStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.users.channels.Websocket.ContentType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.users.ListUsersRequest.SortOrder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.Psd2Request.Workflow
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.VerifyCheck.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.VerifyControlCommand
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.VerifyDetails.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.VerifyRequest.LineType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.VerifyRequest.Workflow
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify.VerifyStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify2.CallbackType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify2.Channel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify2.Locale
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.verify2.VerificationStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.CallDirection
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.CallOrder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.CallStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.MachineDetection
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ModifyCallAction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ncco.EventMethod
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ncco.EventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ncco.PaymentPrompt.Type
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ncco.RecordingFormat
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.ncco.SplitRecording
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.TextToSpeechLanguage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.TransferDestination.Type
Deprecated.
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.vonage.client.account.Network.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.account.ServiceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.application.capabilities.Capability.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.application.capabilities.Region
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.common.HttpMethod
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.common.Webhook.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.conversion.ConversionRequest.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.incoming.CallDirection
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.incoming.CallStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.incoming.CallStatusDetail
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.incoming.MessageType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.CallerType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.CarrierDetails.NetworkType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.InsightStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.LookupOutcome
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.PortedStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.Reachability
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.RoamingDetails.RoamingStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.insight.Validity
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.EventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.JoinApprovalLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.LogoType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.MicrophoneState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.RecordingStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.RoomLanguage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.RoomType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.meetings.ThemeDomain
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.Channel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.MessageStatus.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.MessageType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.messenger.Category
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.messenger.Tag
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.viber.Category
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.whatsapp.Locale
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.messages.whatsapp.Policy
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.numbers.SearchPattern
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.numbers.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.proactiveconnect.EventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.proactiveconnect.SortOrder
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.proactiveconnect.SourceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.proactiveconnect.SyncStatusValue
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.redact.RedactRequest.Product
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.redact.RedactRequest.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.sms.messages.Message.MessageClass
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.sms.messages.Message.MessageType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.sms.MessageStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.users.channels.Websocket.ContentType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.users.ListUsersRequest.SortOrder
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.Psd2Request.Workflow
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.VerifyCheck.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.VerifyControlCommand
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.VerifyDetails.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.VerifyRequest.LineType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.VerifyRequest.Workflow
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify.VerifyStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify2.CallbackType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify2.Channel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify2.Locale
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.verify2.VerificationStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.CallDirection
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.CallOrder
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.CallStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.MachineDetection
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ModifyCallAction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ncco.EventMethod
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ncco.EventType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ncco.PaymentPrompt.Type
Deprecated.
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ncco.RecordingFormat
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.ncco.SplitRecording
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.TextToSpeechLanguage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vonage.client.voice.TransferDestination.Type
Deprecated.
Returns an array containing the constants of this enum class, in the order they are declared.
Vbc - Class in com.vonage.client.application.capabilities
VBC capability configuration settings.
Vbc - Class in com.vonage.client.users.channels
Represents a Vonage Business Cloud (VBC) channel.
Vbc() - Constructor for class com.vonage.client.users.channels.Vbc
 
Vbc(int) - Constructor for class com.vonage.client.users.channels.Vbc
Creates a new VBC channel.
VBC - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
 
VBC - Enum constant in enum class com.vonage.client.meetings.ThemeDomain
 
Vbc.Builder - Class in com.vonage.client.application.capabilities
 
VbcEndpoint - Class in com.vonage.client.voice.ncco
Represents a VBC endpoint used in a ConnectAction.
VbcEndpoint - Class in com.vonage.client.voice
Represents a VBC call type.
VbcEndpoint() - Constructor for class com.vonage.client.voice.VbcEndpoint
 
VbcEndpoint(String) - Constructor for class com.vonage.client.voice.VbcEndpoint
 
VbcEndpoint.Builder - Class in com.vonage.client.voice.ncco
 
vcard - Variable in class com.vonage.client.messages.InboundMessage
 
VCARD - Enum constant in enum class com.vonage.client.messages.MessageType
 
VCP - Enum constant in enum class com.vonage.client.meetings.ThemeDomain
 
VerificationCallback - Class in com.vonage.client.verify2
Webhook for verification status updates and events.
VerificationCallback() - Constructor for class com.vonage.client.verify2.VerificationCallback
 
VerificationRequest - Class in com.vonage.client.verify2
Defines properties for a verify request to be sent to the user.
VerificationRequest.Builder - Class in com.vonage.client.verify2
 
VerificationResponse - Class in com.vonage.client.verify2
Metadata about an outbound verification request.
VerificationResponse() - Constructor for class com.vonage.client.verify2.VerificationResponse
Protected to prevent users from explicitly creating this object.
VerificationStatus - Enum Class in com.vonage.client.verify2
Represents the status of an event or update in VerificationCallback.getStatus().
verify(VerifyRequest) - Method in class com.vonage.client.verify.VerifyClient
Send a verification request to a phone number.
verify(String, String) - Method in class com.vonage.client.verify.VerifyClient
Send a verification request to a phone number.
verify(String, String, VerifyRequest.Workflow) - Method in class com.vonage.client.verify.VerifyClient
Send a verification request to a phone number with a pin verification workflow
verify(String, String, String) - Method in class com.vonage.client.verify.VerifyClient
Send a verification request to a phone number.
verify(String, String, String, int, Locale) - Method in class com.vonage.client.verify.VerifyClient
Send a verification request to a phone number.
verify(String, String, String, int, Locale, VerifyRequest.LineType) - Method in class com.vonage.client.verify.VerifyClient
Send a verification request to a phone number.
VERIFY - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
VERIFY_SDK - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
Verify2Client - Class in com.vonage.client.verify2
 
Verify2Client(HttpWrapper) - Constructor for class com.vonage.client.verify2.Verify2Client
Create a new Verify2Client.
VerifyCheck - Class in com.vonage.client.verify
 
VerifyCheck(Date, String, VerifyCheck.Status, String) - Constructor for class com.vonage.client.verify.VerifyCheck
 
VerifyCheck.Status - Enum Class in com.vonage.client.verify
 
VerifyClient - Class in com.vonage.client.verify
A client for talking to the Vonage Verify API.
VerifyClient(HttpWrapper) - Constructor for class com.vonage.client.verify.VerifyClient
Constructor.
VerifyControlCommand - Enum Class in com.vonage.client.verify
Enum representing the control command.
VerifyDetails - Class in com.vonage.client.verify
 
VerifyDetails() - Constructor for class com.vonage.client.verify.VerifyDetails
 
VerifyDetails.Status - Enum Class in com.vonage.client.verify
 
VerifyException - Exception in com.vonage.client.verify
 
VerifyException(String, String) - Constructor for exception com.vonage.client.verify.VerifyException
 
VerifyRequest - Class in com.vonage.client.verify
Describes a Verify request.
VerifyRequest(VerifyRequest.Builder) - Constructor for class com.vonage.client.verify.VerifyRequest
 
VerifyRequest.Builder - Class in com.vonage.client.verify
Builder to create a Two Factor Authentication request
VerifyRequest.LineType - Enum Class in com.vonage.client.verify
Types of phone line to be specified for VerifyRequest.type.
VerifyRequest.Workflow - Enum Class in com.vonage.client.verify
Enumeration representing different verification workflows.
verifyRequestSignature(String, InputStream, Map<String, String[]>, String, long) - Static method in class com.vonage.client.auth.RequestSigning
Verifies the signature in an HttpServletRequest.
verifyRequestSignature(String, InputStream, Map<String, String[]>, String, long, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
Verifies the signature in an HttpServletRequest.
verifyRequestSignature(HttpServletRequest, String) - Static method in class com.vonage.client.auth.RequestSigning
Deprecated.
This method will be removed in a future release due to the dependency on javax.servlet.
verifyRequestSignature(HttpServletRequest, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
Deprecated.
This method will be removed in a future release due to the dependency on javax.servlet.
VerifyResponse - Class in com.vonage.client.verify
 
VerifyResponse(VerifyStatus) - Constructor for class com.vonage.client.verify.VerifyResponse
 
VerifyResponseException - Exception in com.vonage.client.verify2
Response returned when verification fails (i.e.
VerifyResponseException() - Constructor for exception com.vonage.client.verify2.VerifyResponseException
 
VerifyStatus - Enum Class in com.vonage.client.verify
 
Viber - Class in com.vonage.client.users.channels
Represents a Viber channel.
Viber() - Constructor for class com.vonage.client.users.channels.Viber
 
Viber(String) - Constructor for class com.vonage.client.users.channels.Viber
Creates a new Viber channel.
VIBER - Enum constant in enum class com.vonage.client.messages.Channel
 
ViberFileRequest - Class in com.vonage.client.messages.viber
 
ViberFileRequest.Builder - Class in com.vonage.client.messages.viber
 
ViberImageRequest - Class in com.vonage.client.messages.viber
 
ViberImageRequest.Builder - Class in com.vonage.client.messages.viber
 
ViberRequest - Class in com.vonage.client.messages.viber
 
ViberRequest(ViberRequest.Builder<?, ?>, MessageType) - Constructor for class com.vonage.client.messages.viber.ViberRequest
 
ViberRequest.Builder<M extends ViberRequest,B extends ViberRequest.Builder<? extends M,? extends B>> - Class in com.vonage.client.messages.viber
 
viberService - Variable in class com.vonage.client.messages.viber.ViberRequest
 
ViberService - Class in com.vonage.client.messages.viber
 
ViberTextRequest - Class in com.vonage.client.messages.viber
 
ViberTextRequest.Builder - Class in com.vonage.client.messages.viber
 
viberType - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
viberType(String) - Method in class com.vonage.client.messages.viber.ViberRequest.Builder
(OPTIONAL) Viber-specific type definition.
ViberVideoRequest - Class in com.vonage.client.messages.viber
 
ViberVideoRequest.Builder - Class in com.vonage.client.messages.viber
 
video - Variable in class com.vonage.client.messages.InboundMessage
 
Video - Class in com.vonage.client.messages.viber
 
Video(String, String, String) - Constructor for class com.vonage.client.messages.viber.Video
 
VIDEO - Enum constant in enum class com.vonage.client.messages.MessageType
 
VIETNAMESE - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
VIETNAMESE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
VIETNAMESE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
VIETNAMESE_VIETNAM - Enum constant in enum class com.vonage.client.verify2.Locale
 
VIRTUAL - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
Voice - Class in com.vonage.client.application.capabilities
Voice capability configuration settings.
Voice(TextToSpeechLanguage, Integer) - Constructor for class com.vonage.client.voice.ncco.PayAction.Voice
Deprecated.
 
VOICE - Enum constant in enum class com.vonage.client.account.ServiceType
 
VOICE - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
 
VOICE - Enum constant in enum class com.vonage.client.conversion.ConversionRequest.Type
 
VOICE - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
VOICE - Enum constant in enum class com.vonage.client.verify2.Channel
Telephone voice call.
Voice.Builder - Class in com.vonage.client.application.capabilities
 
VoiceClient - Class in com.vonage.client.voice
A client for talking to the Vonage Voice API.
VoiceClient(HttpWrapper) - Constructor for class com.vonage.client.voice.VoiceClient
Constructor.
VoiceWorkflow - Class in com.vonage.client.verify2
Defines workflow properties for sending a verification code to a user over a voice call.
VoiceWorkflow(String) - Constructor for class com.vonage.client.verify2.VoiceWorkflow
Constructs a new Voice verification workflow.
VonageApiResponseException - Exception in com.vonage.client
Base class for exceptions which represent an error API response conforming to RFC 7807 standard.
VonageApiResponseException() - Constructor for exception com.vonage.client.VonageApiResponseException
 
VonageApiResponseException(String) - Constructor for exception com.vonage.client.VonageApiResponseException
 
VonageApiResponseException(String, Throwable) - Constructor for exception com.vonage.client.VonageApiResponseException
 
VonageApiResponseException(Throwable) - Constructor for exception com.vonage.client.VonageApiResponseException
 
VonageAuthException - Exception in com.vonage.client.auth
 
VonageAuthException() - Constructor for exception com.vonage.client.auth.VonageAuthException
 
VonageAuthException(String) - Constructor for exception com.vonage.client.auth.VonageAuthException
 
VonageAuthException(String, Throwable) - Constructor for exception com.vonage.client.auth.VonageAuthException
 
VonageAuthException(Throwable) - Constructor for exception com.vonage.client.auth.VonageAuthException
 
VonageBadRequestException - Exception in com.vonage.client
 
VonageBadRequestException() - Constructor for exception com.vonage.client.VonageBadRequestException
 
VonageBadRequestException(String) - Constructor for exception com.vonage.client.VonageBadRequestException
 
VonageBadRequestException(String, Throwable) - Constructor for exception com.vonage.client.VonageBadRequestException
 
VonageBadRequestException(Throwable) - Constructor for exception com.vonage.client.VonageBadRequestException
 
VonageCallbackRequestValidationException - Exception in com.vonage.client.sms.callback
 
VonageCallbackRequestValidationException() - Constructor for exception com.vonage.client.sms.callback.VonageCallbackRequestValidationException
 
VonageCallbackRequestValidationException(String) - Constructor for exception com.vonage.client.sms.callback.VonageCallbackRequestValidationException
 
VonageCallbackRequestValidationException(String, Throwable) - Constructor for exception com.vonage.client.sms.callback.VonageCallbackRequestValidationException
 
VonageCallbackRequestValidationException(Throwable) - Constructor for exception com.vonage.client.sms.callback.VonageCallbackRequestValidationException
 
VonageClient - Class in com.vonage.client
Top-level Vonage API client object.
VonageClient.Builder - Class in com.vonage.client
 
VonageClientCreationException - Exception in com.vonage.client
Indicates that there was a failure during VonageClient creation.
VonageClientCreationException(String, Throwable) - Constructor for exception com.vonage.client.VonageClientCreationException
 
VonageClientException - Exception in com.vonage.client
 
VonageClientException() - Constructor for exception com.vonage.client.VonageClientException
 
VonageClientException(String) - Constructor for exception com.vonage.client.VonageClientException
 
VonageClientException(String, Throwable) - Constructor for exception com.vonage.client.VonageClientException
 
VonageClientException(Throwable) - Constructor for exception com.vonage.client.VonageClientException
 
VonageMethodFailedException - Exception in com.vonage.client
 
VonageMethodFailedException() - Constructor for exception com.vonage.client.VonageMethodFailedException
 
VonageMethodFailedException(String) - Constructor for exception com.vonage.client.VonageMethodFailedException
 
VonageMethodFailedException(String, Throwable) - Constructor for exception com.vonage.client.VonageMethodFailedException
 
VonageMethodFailedException(Throwable) - Constructor for exception com.vonage.client.VonageMethodFailedException
 
VonageResponseParseException - Exception in com.vonage.client
An exception that indicates the contents of an HttpResponse could not be parsed.
VonageResponseParseException(String) - Constructor for exception com.vonage.client.VonageResponseParseException
 
VonageResponseParseException(String, Throwable) - Constructor for exception com.vonage.client.VonageResponseParseException
 
VonageUnableToReadPrivateKeyException - Exception in com.vonage.client
 
VonageUnableToReadPrivateKeyException(String, Throwable) - Constructor for exception com.vonage.client.VonageUnableToReadPrivateKeyException
 
VonageUnacceptableAuthException - Exception in com.vonage.client.auth
 
VonageUnacceptableAuthException(Collection<AuthMethod>, Collection<Class<? extends AuthMethod>>) - Constructor for exception com.vonage.client.auth.VonageUnacceptableAuthException
 
VonageUnexpectedException - Exception in com.vonage.client
VonageUnexpectedException indicates an exception that should not happen in an ideal world.
VonageUnexpectedException() - Constructor for exception com.vonage.client.VonageUnexpectedException
 
VonageUnexpectedException(String) - Constructor for exception com.vonage.client.VonageUnexpectedException
 
VonageUnexpectedException(String, Throwable) - Constructor for exception com.vonage.client.VonageUnexpectedException
 
VonageUnexpectedException(Throwable) - Constructor for exception com.vonage.client.VonageUnexpectedException
 
VXML - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 

W

WAIT_FOR_COMPLETION - Enum constant in enum class com.vonage.client.verify.VerifyStatus
For cancel: Either you have not waited at least 30 seconds after sending a Verify request before cancelling or Verify has made too many attempts to deliver the verification code for this request, and you must now wait for the process to complete.
WAPPUSH - Enum constant in enum class com.vonage.client.sms.messages.Message.MessageType
Message is a wap-push message to send a browsable / downloadable url to the handset
WapPushMessage - Class in com.vonage.client.sms.messages
Deprecated.
Will be removed in the next major release.
WapPushMessage(String, String, String, String) - Constructor for class com.vonage.client.sms.messages.WapPushMessage
Deprecated.
Instantiate a new wap-push message request, to submit a browsable / downloadable URL to the handset
WAV - Enum constant in enum class com.vonage.client.voice.ncco.RecordingFormat
 
Webhook - Class in com.vonage.client.common
Represents the "webhooks" field used in Application capabilities.
Webhook() - Constructor for class com.vonage.client.common.Webhook
 
Webhook(String, HttpMethod) - Constructor for class com.vonage.client.common.Webhook
 
Webhook.Builder - Class in com.vonage.client.common
Builder for configuring Webhook object.
Webhook.Type - Enum Class in com.vonage.client.common
Represents the webhook URL type.
webhooks - Variable in class com.vonage.client.application.capabilities.Capability
 
Websocket - Class in com.vonage.client.users.channels
Represents a Websocket channel.
Websocket() - Constructor for class com.vonage.client.users.channels.Websocket
 
Websocket(String) - Constructor for class com.vonage.client.users.channels.Websocket
 
Websocket(String, Websocket.ContentType, Map<String, ?>) - Constructor for class com.vonage.client.users.channels.Websocket
 
Websocket.ContentType - Enum Class in com.vonage.client.users.channels
Represents the possible content types for a Websocket.
WebSocketEndpoint - Class in com.vonage.client.voice.ncco
Represents a web socket endpoint used in a ConnectAction.
WebSocketEndpoint - Class in com.vonage.client.voice
 
WebSocketEndpoint() - Constructor for class com.vonage.client.voice.WebSocketEndpoint
 
WebSocketEndpoint(String, String, List<NameValuePair>) - Constructor for class com.vonage.client.voice.WebSocketEndpoint
Deprecated.
WebSocketEndpoint(String, String, Map<String, Object>) - Constructor for class com.vonage.client.voice.WebSocketEndpoint
 
WebSocketEndpoint.Builder - Class in com.vonage.client.voice.ncco
 
WELSH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
WELSH_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
WELSH_UK - Enum constant in enum class com.vonage.client.verify2.Locale
 
Whatsapp - Class in com.vonage.client.messages.whatsapp
 
Whatsapp - Class in com.vonage.client.users.channels
Represents a WhatsApp channel.
Whatsapp() - Constructor for class com.vonage.client.users.channels.Whatsapp
 
Whatsapp(String) - Constructor for class com.vonage.client.users.channels.Whatsapp
Creates a new Whatsapp channel.
WHATSAPP - Enum constant in enum class com.vonage.client.messages.Channel
 
WHATSAPP - Enum constant in enum class com.vonage.client.verify2.Channel
WhatsApp text message.
WHATSAPP_INTERACTIVE - Enum constant in enum class com.vonage.client.verify2.Channel
WhatsApp Yes/No prompt message (codeless).
WhatsappAudioRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappAudioRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappCodelessWorkflow - Class in com.vonage.client.verify2
Defines properties for sending a verification code to a user over WhatsApp using an interaction prompt, where the user selects "Yes" or "No" to verify.
WhatsappCodelessWorkflow(String) - Constructor for class com.vonage.client.verify2.WhatsappCodelessWorkflow
Constructs a new WhatsApp interactive verification workflow.
whatsappContext - Variable in class com.vonage.client.messages.InboundMessage
 
WhatsappCustomRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappCustomRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappFileRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappFileRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappImageRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappImageRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
whatsappLocation - Variable in class com.vonage.client.messages.InboundMessage
 
WhatsappLocationRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappLocationRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappMultiProductRequest - Class in com.vonage.client.messages.whatsapp
WhatsappMultiProductRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
whatsappOrder - Variable in class com.vonage.client.messages.InboundMessage
 
whatsappProfile - Variable in class com.vonage.client.messages.InboundMessage
 
whatsappReply - Variable in class com.vonage.client.messages.InboundMessage
 
WhatsappRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappRequest(WhatsappRequest.Builder<?, ?>, MessageType) - Constructor for class com.vonage.client.messages.whatsapp.WhatsappRequest
 
WhatsappRequest.Builder<M extends WhatsappRequest,B extends WhatsappRequest.Builder<? extends M,? extends B>> - Class in com.vonage.client.messages.whatsapp
 
WhatsappSingleProductRequest - Class in com.vonage.client.messages.whatsapp
WhatsappSingleProductRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappStickerRequest - Class in com.vonage.client.messages.whatsapp
See the documentation for more information on sending stickers.
WhatsappStickerRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappTemplateRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappTemplateRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappTextRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappTextRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappVideoRequest - Class in com.vonage.client.messages.whatsapp
 
WhatsappVideoRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
WhatsappWorkflow - Class in com.vonage.client.verify2
Defines properties for sending a verification code to a user over a WhatsApp message.
WhatsappWorkflow(String) - Constructor for class com.vonage.client.verify2.WhatsappWorkflow
Constructs a new WhatsApp verification workflow.
WhatsappWorkflow(String, String) - Constructor for class com.vonage.client.verify2.WhatsappWorkflow
Constructs a new WhatsApp verification workflow with a custom sender number.
WHITE - Enum constant in enum class com.vonage.client.meetings.LogoType
 
withDeliveryReceiptUrl(String) - Static method in class com.vonage.client.account.SettingsRequest
 
withIncomingSmsUrl(String) - Static method in class com.vonage.client.account.SettingsRequest
 
withNumber(String) - Static method in class com.vonage.client.insight.AdvancedInsightRequest
Construct an AdvancedInsightRequest with a number.
withNumber(String) - Static method in class com.vonage.client.insight.BasicInsightRequest
Construct a BasicInsightRequest with a number.
withNumber(String) - Static method in class com.vonage.client.insight.StandardInsightRequest
Construct a StandardInsightRequest with a number.
withNumberAndCountry(String, String) - Static method in class com.vonage.client.insight.AdvancedInsightRequest
Construct a AdvancedInsightRequest with a number and country.
withNumberAndCountry(String, String) - Static method in class com.vonage.client.insight.BasicInsightRequest
Construct a BasicInsightRequest with a number and country.
withNumberAndCountry(String, String) - Static method in class com.vonage.client.insight.StandardInsightRequest
Construct a StandardInsightRequest with a number and country.
workflow(Psd2Request.Workflow) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
workflow(VerifyRequest.Workflow) - Method in class com.vonage.client.verify.VerifyRequest.Builder
Set the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
Workflow - Class in com.vonage.client.verify2
Base workflow.
Workflow(Channel, String) - Constructor for class com.vonage.client.verify2.Workflow
 
Workflow(Channel, String, String) - Constructor for class com.vonage.client.verify2.Workflow
 
WORKFLOW - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
workflows - Variable in class com.vonage.client.verify2.VerificationCallback
 
workflows - Variable in class com.vonage.client.verify2.VerificationRequest
 
workflows(List<Workflow>) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(REQUIRED if VerificationRequest.Builder.addWorkflow(Workflow)) has not been called.
WorkflowStatus - Class in com.vonage.client.verify2
Describes the status of a workflow.
WorkflowStatus() - Constructor for class com.vonage.client.verify2.WorkflowStatus
 
wrapper(HttpWrapper) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
WRONG_CODE_THROTTLED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
You can run Verify check on a specific request_id up to three times unless a new verification code is generated.

X

XmlParser - Class in com.vonage.client.legacyutils
 
XmlParser() - Constructor for class com.vonage.client.legacyutils.XmlParser
 
XmlUtil - Class in com.vonage.client.legacyutils
 
XmlUtil() - Constructor for class com.vonage.client.legacyutils.XmlUtil
 

Y

YUE_CHINESE_CHINA - Enum constant in enum class com.vonage.client.verify2.Locale
 

Z

ZH_CN - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Chinese (Mainland)
ZH_TW - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Chinese (Taiwan)
ZULU - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
ZULU - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form