Index

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

A

ABSENT - Enum constant in enum class com.vonage.client.insight.Reachability
 
AbstractAuthMethod - Class in com.vonage.client.auth
Base class for all AuthMethod implementations.
AbstractAuthMethod() - Constructor for class com.vonage.client.auth.AbstractAuthMethod
 
AbstractHasher - Class in com.vonage.client.auth.hashutils
Deprecated.
This class will be made package-private in the next major release.
AbstractHasher() - Constructor for class com.vonage.client.auth.hashutils.AbstractHasher
Deprecated.
 
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
 
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 Class in com.vonage.client.account
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
AccountResponseException() - Constructor for exception class com.vonage.client.account.AccountResponseException
 
ackInboundMessage(String, ApiRegion) - Method in class com.vonage.client.messages.MessagesClient
Marks an inbound message as "read".
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
 
ACTIVE - Enum constant in enum class com.vonage.client.conversations.ConversationStatus
 
ACTIVE - Enum constant in enum class com.vonage.client.video.ProjectStatus
Active
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.
addArchiveStream(String, String) - Method in class com.vonage.client.video.VideoClient
Adds a stream to a composed archive that was started with the streamMode set to StreamMode.MANUAL.
addArchiveStream(String, String, Boolean, Boolean) - Method in class com.vonage.client.video.VideoClient
Adds a stream to a composed archive.
addBroadcastStream(String, String) - Method in class com.vonage.client.video.VideoClient
Adds a stream to a live broadcast that was started with the streamMode set to StreamMode.MANUAL.
addBroadcastStream(String, String, Boolean, Boolean) - Method in class com.vonage.client.video.VideoClient
Adds a stream to a live broadcast that was started with the streamMode set to StreamMode.MANUAL.
addCanHear(String...) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
Convenience method for adding a leg ID to the canHear collection.
addCanSpeak(String...) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
Convenience method for adding a leg ID to the canSpeak collection.
addCapability(Capability) - Method in class com.vonage.client.application.Application.Builder
Add a capability for the application.
addClaims(Jwt.Builder) - Method in class com.vonage.client.video.TokenOptions
 
addDtmfListener(String, String) - Method in class com.vonage.client.voice.VoiceClient
Register a listener for asynchronous DTMF events sent by a caller to an InputAction NCCO action, when the InputAction.Builder.mode(InputMode) is InputMode.ASYNCHRONOUS.
addHeader(String, String) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) Define a custom header to be added to the SIP INVITE request initiated from Vonage to your SIP platform.
addHeaders(Map<String, String>) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) Define custom headers (i.e. those starting with "X-") to be added to the SIP INVITE request initiated from Vonage to your SIP platform.
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
Deprecated.
(REQUIRED) The webhook's URL.
address(String) - Method in class com.vonage.client.conversations.Location.Builder
Full address.
address(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappLocationRequest.Builder
(OPTIONAL) Address of the location.
addRtmpStream(Rtmp) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL, but REQUIRED if HLS is unspecified) You can specify up to five target RTMP streams (or just one).
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.Verify.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
Builder for specifying the Advanced Machine Detection properties.
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
 
AFRIKAANS - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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.
ALLOW - Enum constant in enum class com.vonage.client.numberinsight2.RiskRecommendation
 
ALREADY_REQUESTED - Enum constant in enum class com.vonage.client.verify.VerifyStatus
Concurrent verifications to the same number are not allowed.
ALWAYS - Enum constant in enum class com.vonage.client.video.ArchiveMode
The session is archived automatically (as soon as there are clients connected to the session).
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(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
Deprecated.
 
ANSWERED - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
ANSWERED - Enum constant in enum class com.vonage.client.voice.CallStatus
The call was answered.
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.
AnswerWebhook - Class in com.vonage.client.voice
Maps the fields for data sent to the answer_url configured in your voice application.
AnswerWebhook() - Constructor for class com.vonage.client.voice.AnswerWebhook
 
ANYWHERE - Enum constant in enum class com.vonage.client.numbers.SearchPattern
Search for numbers that contain the pattern.
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)
API_AP - Enum constant in enum class com.vonage.client.ApiRegion
The region for the Vonage API in Asia Pacific.
API_EU - Enum constant in enum class com.vonage.client.ApiRegion
The region for the Vonage API in Europe.
API_US - Enum constant in enum class com.vonage.client.ApiRegion
The region for the Vonage API in the US.
apiBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
Replaces the URI used in "api" endpoints.
apiEuBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
Replaces the base URI used in "api-eu" endpoints.
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.
ApiKeyAuthMethod - Interface in com.vonage.client.auth
Signifies that the auth method has an API key.
ApiKeyHeaderAuthMethod - Class in com.vonage.client.auth
API key and secret in the header.
ApiKeyHeaderAuthMethod(String, String) - Constructor for class com.vonage.client.auth.ApiKeyHeaderAuthMethod
 
ApiKeyQueryParamsAuthMethod - Class in com.vonage.client.auth
API key and secret in query parameters.
ApiKeyQueryParamsAuthMethod(String, String) - Constructor for class com.vonage.client.auth.ApiKeyQueryParamsAuthMethod
 
ApiRegion - Enum Class in com.vonage.client
Enum representing the different regions that the Vonage API can be accessed from.
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.common.ChannelType
 
APP - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
APP - Enum constant in enum class com.vonage.client.voice.EndpointType
 
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
 
appendUserAgent(String) - Method in class com.vonage.client.HttpConfig.Builder
Appends a custom string to the default User-Agent header.
appHash(String) - Method in class com.vonage.client.verify2.SmsWorkflow.Builder
(OPTIONAL) Android Application Hash Key for automatic code detection on a user's device.
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 - Variable in class com.vonage.client.video.StreamComposition
 
applicationId(String) - Method in class com.vonage.client.conversations.Callback.Builder
Vonage Application ID.
applicationId(String) - Method in class com.vonage.client.numbers.ListNumbersFilter.Builder
Set this to only return numbers assigned to a specific application.
applicationId(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the application that will handle inbound traffic to this number.
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.
applicationId(UUID) - Method in class com.vonage.client.numbers.ListNumbersFilter.Builder
Set this to only return numbers assigned to a specific application.
applicationId(UUID) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the application that will handle inbound traffic to this number.
applicationId(UUID) - Method in class com.vonage.client.VonageClient.Builder
Set the application ID for this client.
ApplicationList - Class in com.vonage.client.application
ApplicationList() - Constructor for class com.vonage.client.application.ApplicationList
 
ApplicationResponseException - Exception Class in com.vonage.client.application
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
ApplicationResponseException() - Constructor for exception class com.vonage.client.application.ApplicationResponseException
 
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_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
 
Archive - Class in com.vonage.client.video
Represents an archive of a video session.
Archive() - Constructor for class com.vonage.client.video.Archive
 
Archive(Archive.Builder) - Constructor for class com.vonage.client.video.Archive
 
Archive.Builder - Class in com.vonage.client.video
Used to construct an Archive object.
archiveMode(ArchiveMode) - Method in class com.vonage.client.video.CreateSessionRequest.Builder
Call this method to determine whether the session will be automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL).
ArchiveMode - Enum Class in com.vonage.client.video
Defines values for the archiveMode parameter of the CreateSessionRequest.Builder.archiveMode(ArchiveMode archiveMode) method.
ArchiveStatus - Enum Class in com.vonage.client.video
Defines values returned by the Archive.getStatus() method.
ARMENIAN - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
asBasicHeader() - Method in class com.vonage.client.auth.ApiKeyQueryParamsAuthMethod
Converts this to a BasicAuthMethod.
ASC - Enum constant in enum class com.vonage.client.proactiveconnect.SortOrder
Deprecated.
Ascending
ASC - Enum constant in enum class com.vonage.client.users.ListUsersRequest.SortOrder
Ascending
ASCENDING - Enum constant in enum class com.vonage.client.common.SortOrder
Ascending (asc)
ASCENDING - Enum constant in enum class com.vonage.client.voice.CallOrder
Deprecated.
 
asQueryParams() - Method in class com.vonage.client.auth.ApiKeyHeaderAuthMethod
Deprecated.
This will be removed in a future release.
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
 
ASYNCHRONOUS - Enum constant in enum class com.vonage.client.voice.ncco.InputMode
Process input asynchronously.
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(boolean) - Method in class com.vonage.client.conversations.MemberMedia.Builder
 
AUDIO - Enum constant in enum class com.vonage.client.common.MessageType
 
AUDIO - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
AUDIO_ASR_DONE - Enum constant in enum class com.vonage.client.conversations.EventType
Automatic speech recognition has finished.
AUDIO_ASR_RECORD_DONE - Enum constant in enum class com.vonage.client.conversations.EventType
Automatic speech recognition of recording has finished.
AUDIO_DTMF - Enum constant in enum class com.vonage.client.conversations.EventType
Play DTMF audio.
AUDIO_EARMUFF_OFF - Enum constant in enum class com.vonage.client.conversations.EventType
Unearmuff audio, i.e. the receiver will be able to hear it.
AUDIO_EARMUFF_ON - Enum constant in enum class com.vonage.client.conversations.EventType
Earmuff audio, i.e. the receiver won't be able to hear it.
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.
AUDIO_MUTE_OFF - Enum constant in enum class com.vonage.client.conversations.EventType
Unmute audio, i.e. the producer will be able to be heard by others.
AUDIO_MUTE_ON - Enum constant in enum class com.vonage.client.conversations.EventType
Mute audio, i.e. the producer won't be able to be heard by others.
AUDIO_PLAY - Enum constant in enum class com.vonage.client.conversations.EventType
Play audio.
AUDIO_PLAY_DONE - Enum constant in enum class com.vonage.client.conversations.EventType
Playing audio has finished.
AUDIO_PLAY_STOP - Enum constant in enum class com.vonage.client.conversations.EventType
Stop the audio currently playing.
AUDIO_RECORD - Enum constant in enum class com.vonage.client.conversations.EventType
Record the audio.
AUDIO_RECORD_DONE - Enum constant in enum class com.vonage.client.conversations.EventType
Audio recording has finished.
AUDIO_RECORD_STOP - Enum constant in enum class com.vonage.client.conversations.EventType
Stop current recording of audio.
AUDIO_SAY - Enum constant in enum class com.vonage.client.conversations.EventType
Use text-to-speech to say the given text.
AUDIO_SAY_DONE - Enum constant in enum class com.vonage.client.conversations.EventType
Playing text-to-speech has finished.
AUDIO_SAY_STOP - Enum constant in enum class com.vonage.client.conversations.EventType
Stop the currently playing text-to-speech.
AUDIO_SPEAKING_OFF - Enum constant in enum class com.vonage.client.conversations.EventType
Disable speaking.
AUDIO_SPEAKING_ON - Enum constant in enum class com.vonage.client.conversations.EventType
Enable speaking.
AudioEarmuffOffEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_EARMUFF_OFF event.
AudioEarmuffOffEvent.Builder - Class in com.vonage.client.conversations
 
AudioEarmuffOnEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_EARMUFF_ON event.
AudioEarmuffOnEvent.Builder - Class in com.vonage.client.conversations
 
audioEnabled(boolean) - Method in class com.vonage.client.conversations.MemberMedia.Builder
 
AudioMuteOffEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_MUTE_OFF event.
AudioMuteOffEvent.Builder - Class in com.vonage.client.conversations
 
AudioMuteOnEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_MUTE_ON event.
AudioMuteOnEvent.Builder - Class in com.vonage.client.conversations
 
AudioPlayDoneEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_PLAY_DONE event.
AudioPlayEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_PLAY event.
AudioPlayEvent.Builder - Class in com.vonage.client.conversations
 
AudioPlayStopEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_PLAY_STOP event.
AudioPlayStopEvent.Builder - Class in com.vonage.client.conversations
 
audioRate(Websocket.AudioRate) - Method in class com.vonage.client.video.ConnectRequest.Builder
A number representing the audio sampling rate in Hz.
AudioRecordEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_RECORD event.
AudioRecordEvent.Builder - Class in com.vonage.client.conversations
Builder for setting the Audio Record event parameters.
AudioRecordStopEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_RECORD_STOP event.
AudioRecordStopEvent.Builder - Class in com.vonage.client.conversations
 
AudioSayDoneEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_SAY_DONE event.
AudioSayEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_SAY event.
AudioSayEvent.Builder - Class in com.vonage.client.conversations
 
AudioSayStopEvent - Class in com.vonage.client.conversations
Represents an EventType.AUDIO_SAY_STOP event.
AudioSayStopEvent.Builder - Class in com.vonage.client.conversations
 
AUSTRALIAN_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
AUSTRIAN_GERMAN - 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
 
AuthCollection(UUID, byte[], String, String, HashUtil.HashType, String) - Constructor for class com.vonage.client.auth.AuthCollection
 
AUTHENTICATION - Enum constant in enum class com.vonage.client.messages.whatsapp.ConversationType
 
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
 
AuthRequest - Class in com.vonage.client.auth.camara
Base request query parameters for the intermediate three-legged OAuth2 check network authentication.
AuthRequest(String, FraudPreventionDetectionScope) - Constructor for class com.vonage.client.auth.camara.AuthRequest
Creates the base auth request parameters.
AUTO - Enum constant in enum class com.vonage.client.messages.sms.EncodingType
 
AUTO - Enum constant in enum class com.vonage.client.video.StreamMode
Streams will be automatically included in the archive or broadcast.
autoRecord(boolean) - Method in class com.vonage.client.meetings.RecordingOptions.Builder
 
AVAILABLE - Enum constant in enum class com.vonage.client.messages.whatsapp.ContextStatus
 
AVAILABLE - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive file is available for download from the cloud.
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
Represents a number that is available to buy.
AvailableNumber() - Constructor for class com.vonage.client.numbers.AvailableNumber
Deprecated.
This will be made package-private in a future release.
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

BackendAuthRequest - Class in com.vonage.client.auth.camara
Back-End auth request parameters for the first step in an OAuth2 three-legged check workflow.
BackendAuthRequest(String, FraudPreventionDetectionScope) - Constructor for class com.vonage.client.auth.camara.BackendAuthRequest
Creates the parameters for a Back-End Authorization OIDC request.
BackendAuthResponse - Class in com.vonage.client.auth.camara
Represents the response from the first step in an OAuth2 three-legged workflow.
BAD_NUMBER - Enum constant in enum class com.vonage.client.insight.Reachability
 
BalanceResponse - Class in com.vonage.client.account
Response data for the AccountClient.getBalance() method.
BalanceResponse() - Constructor for class com.vonage.client.account.BalanceResponse
 
bargeIn(Boolean) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
bargeIn(Boolean) - Method in class com.vonage.client.voice.ncco.TalkAction.Builder
 
BaseConversation - Class in com.vonage.client.conversations
Represents the main attributes of a conversation.
BaseConversation() - Constructor for class com.vonage.client.conversations.BaseConversation
 
BaseInsightRequest - Class in com.vonage.client.insight
 
BaseInsightRequest(String, String) - Constructor for class com.vonage.client.insight.BaseInsightRequest
 
BaseMember - Class in com.vonage.client.conversations
Represents the basic conversation member attributes, as returned from ListMembersResponse.getMembers().
BaseMember() - Constructor for class com.vonage.client.conversations.BaseMember
 
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
 
baseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
Replaces the base URI used in all requests with the specified parameter.
baseUri(URI) - Method in class com.vonage.client.HttpConfig.Builder
Replaces the base URI used in all requests with the specified parameter.
BaseUser - Class in com.vonage.client.users
Represents the main attributes of a User.
BaseUser() - Constructor for class com.vonage.client.users.BaseUser
 
BaseUser(String, String) - Constructor for class com.vonage.client.users.BaseUser
Creates a BaseUser with the ID and name fields as specified.
BasicAuthMethod - Class in com.vonage.client.auth
Base class for auth methods which use the Authorization: Basic header.
BasicAuthMethod() - Constructor for class com.vonage.client.auth.BasicAuthMethod
 
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
 
BASQUE - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
BASQUE - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
BearerAuthMethod - Class in com.vonage.client.auth
Base class for auth methods which use the Authorization: Bearer header.
BearerAuthMethod() - Constructor for class com.vonage.client.auth.BearerAuthMethod
 
BEEP_START - Enum constant in enum class com.vonage.client.voice.MachineDetectionStatus
The beginning of the voice mail beep.
BEEP_TIMEOUT - Enum constant in enum class com.vonage.client.voice.MachineDetectionStatus
Beep wasn't received after waiting for the designated period.
beepStart(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether to set the beep_start flag.
beepStart(Boolean) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
beepStop(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether to set the beep_stop flag.
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.
BELGIAN_DUTCH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
BENGALI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
BENGALI - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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
 
BEST_FIT - Enum constant in enum class com.vonage.client.video.ScreenLayoutType
Best fit
BINARY - Enum constant in enum class com.vonage.client.incoming.MessageType
Deprecated.
 
BINARY - Enum constant in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
Deprecated.
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
BINARY - Enum constant in enum class com.vonage.client.sms.MessageType
 
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. for uploads).
BLACKLISTED - Enum constant in enum class com.vonage.client.insight.Reachability
 
BLOCK - Enum constant in enum class com.vonage.client.numberinsight2.RiskRecommendation
 
body(Map<String, ?>) - Method in class com.vonage.client.conversations.GenericEvent.Builder
Custom data send in the body.
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
 
Broadcast - Class in com.vonage.client.video
Represents properties of a live-streaming broadcast.
Broadcast() - Constructor for class com.vonage.client.video.Broadcast
 
Broadcast(Broadcast.Builder) - Constructor for class com.vonage.client.video.Broadcast
 
Broadcast.Builder - Class in com.vonage.client.video
Used to construct a Broadcast object.
BroadcastStatus - Enum Class in com.vonage.client.video
Defines values returned by the Broadcast.getStatus() method.
BroadcastUrls - Class in com.vonage.client.video
Container for details about the HLS and RTMP broadcasts.
BroadcastUrls() - Constructor for class com.vonage.client.video.BroadcastUrls
 
build() - Method in class com.vonage.client.application.Application.Builder
Builds the Application object.
build() - Method in class com.vonage.client.application.capabilities.Capability.Builder
Constructs the capability with this builder's properties.
build() - Method in class com.vonage.client.application.capabilities.Messages.Builder
Builds the Messages object.
build() - Method in class com.vonage.client.application.capabilities.NetworkApis.Builder
Builds the NetworkApis 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.Verify.Builder
Builds the Verify object with this builder's properties.
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.HalFilterRequest.Builder
Builds the filter request.
build() - Method in class com.vonage.client.common.Webhook.Builder
Deprecated.
Builds the Webhook object.
build() - Method in class com.vonage.client.conversations.AudioEarmuffOffEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioEarmuffOnEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioMuteOffEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioMuteOnEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioPlayEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioPlayStopEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioRecordStopEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
 
build() - Method in class com.vonage.client.conversations.AudioSayStopEvent.Builder
 
build() - Method in class com.vonage.client.conversations.Callback.Builder
Builds the Callback.
build() - Method in class com.vonage.client.conversations.Conversation.Builder
Builds the Conversation.
build() - Method in class com.vonage.client.conversations.ConversationProperties.Builder
build() - Method in class com.vonage.client.conversations.CustomEvent.Builder
 
build() - Method in class com.vonage.client.conversations.EphemeralEvent.Builder
 
build() - Method in class com.vonage.client.conversations.Event.Builder
Builds the EventWithBody.
build() - Method in class com.vonage.client.conversations.ListConversationsRequest.Builder
build() - Method in class com.vonage.client.conversations.ListEventsRequest.Builder
Builds the ListEventsRequest.
build() - Method in class com.vonage.client.conversations.ListMembersRequest.Builder
Builds the ListMembersRequest.
build() - Method in class com.vonage.client.conversations.ListUserConversationsRequest.Builder
build() - Method in class com.vonage.client.conversations.Location.Builder
Builds the Location.
build() - Method in class com.vonage.client.conversations.Member.Builder
Builds the Member.
build() - Method in class com.vonage.client.conversations.MemberMedia.Builder
Builds the MemberMedia.
build() - Method in class com.vonage.client.conversations.MessageDeliveredEvent.Builder
 
build() - Method in class com.vonage.client.conversations.MessageEvent.Builder
 
build() - Method in class com.vonage.client.conversations.MessageRejectedEvent.Builder
 
build() - Method in class com.vonage.client.conversations.MessageSeenEvent.Builder
 
build() - Method in class com.vonage.client.conversations.MessageSubmittedEvent.Builder
 
build() - Method in class com.vonage.client.conversations.MessageUndeliverableEvent.Builder
 
build() - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
build() - Method in class com.vonage.client.DynamicEndpoint.Builder
 
build() - Method in class com.vonage.client.HttpConfig.Builder
Builds the HttpConfig.
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.rcs.RcsCustomRequest.Builder
 
build() - Method in class com.vonage.client.messages.rcs.RcsFileRequest.Builder
 
build() - Method in class com.vonage.client.messages.rcs.RcsImageRequest.Builder
 
build() - Method in class com.vonage.client.messages.rcs.RcsTextRequest.Builder
 
build() - Method in class com.vonage.client.messages.rcs.RcsVideoRequest.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.WhatsappReactionRequest.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.numbers.ListNumbersFilter.Builder
 
build() - Method in class com.vonage.client.numbers.SearchNumbersFilter.Builder
 
build() - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Builds the UpdateNumberRequest.
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.SilentAuthWorkflow.Builder
 
build() - Method in class com.vonage.client.verify2.SmsWorkflow.Builder
 
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.verify2.Workflow.Builder
Builds the workflow.
build() - Method in class com.vonage.client.video.Archive.Builder
Builds the Archive object with this builder's settings.
build() - Method in class com.vonage.client.video.Broadcast.Builder
Builds the Broadcast object with this builder's settings.
build() - Method in class com.vonage.client.video.CaptionsRequest.Builder
Builds the StartCaptionsRequest object.
build() - Method in class com.vonage.client.video.ConnectRequest.Builder
Builds the ConnectRequest object.
build() - Method in class com.vonage.client.video.CreateSessionRequest.Builder
Builds the CreateSessionRequest object.
build() - Method in class com.vonage.client.video.Hls.Builder
Builds the HLS object with the selected settings.
build() - Method in class com.vonage.client.video.ListStreamCompositionsRequest.Builder
Builds the ListStreamCompositionsRequest with this builder's settings.
build() - Method in class com.vonage.client.video.RenderRequest.Builder
Builds the RenderRequest with this builder's properties.
build() - Method in class com.vonage.client.video.Rtmp.Builder
Constructs a Rtmp instance with this builder's properties.
build() - Method in class com.vonage.client.video.SessionStream.Builder
Constructs an instance of SessionStream.
build() - Method in class com.vonage.client.video.SignalRequest.Builder
Builds the SignalRequest.
build() - Method in class com.vonage.client.video.SipDialRequest.Builder
Builds the SipDialRequest object with this builder's settings.
build() - Method in class com.vonage.client.video.StreamCompositionLayout.Builder
build() - Method in class com.vonage.client.video.TokenOptions.Builder
Builds the TokenOptions object.
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
Builds the Conversation NCCO action.
build() - Method in class com.vonage.client.voice.ncco.DtmfSettings.Builder
Builds the DtmfSettings with this builder's properties.
build() - Method in class com.vonage.client.voice.ncco.InputAction.Builder
Builds the InputAction.
build() - Method in class com.vonage.client.voice.ncco.NotifyAction.Builder
Builds the NotifyAction.
build() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.Builder
 
build() - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
Builds the RecordAction.
build() - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
Builds the SIP endpoint.
build() - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Builds the SpeechSettings object with this builder's properties.
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.TranscriptionSettings.Builder
Builds the TranscriptionSettings object.
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
Builds the client with this builder's parameters.
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.NetworkApis
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.Verify
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
Deprecated.
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioEarmuffOffEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioEarmuffOnEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioMuteOffEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioMuteOnEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioPlayEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioPlayStopEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioRecordEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioRecordStopEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioSayEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.AudioSayStopEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.Callback
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.Conversation
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.ConversationProperties
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.CustomEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.EphemeralEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.ListConversationsRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.ListEventsRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.ListMembersRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.ListUserConversationsRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.Location
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.Member
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.MemberMedia
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.MessageDeliveredEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.MessageRejectedEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.MessageSeenEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.MessageSubmittedEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.MessageUndeliverableEvent
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.conversations.UpdateMemberRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.HttpConfig
Entrypoint for creating a custom 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.rcs.RcsCustomRequest
 
builder() - Static method in class com.vonage.client.messages.rcs.RcsFileRequest
 
builder() - Static method in class com.vonage.client.messages.rcs.RcsImageRequest
 
builder() - Static method in class com.vonage.client.messages.rcs.RcsTextRequest
 
builder() - Static method in class com.vonage.client.messages.rcs.RcsVideoRequest
 
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.WhatsappReactionRequest
 
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.numbers.ListNumbersFilter
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.numbers.SearchNumbersFilter
Entrypoint for constructing an instance of this class.
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.video.CaptionsRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.video.ConnectRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.video.CreateSessionRequest
Instantiates a Builder, used to construct this object.
builder() - Static method in class com.vonage.client.video.Hls
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.video.ListStreamCompositionsRequest
Instantiates a Builder, used to construct this object.
builder() - Static method in class com.vonage.client.video.RenderRequest
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.video.Rtmp
Entrypoint for creating an instance of this class.
builder() - Static method in class com.vonage.client.video.SignalRequest
Entry point for constructing an instance of SignalRequest.
builder() - Static method in class com.vonage.client.video.SipDialRequest
Instantiates a Builder, used to construct this object.
builder() - Static method in class com.vonage.client.video.TokenOptions
Entry point for constructing an instance of TokenOptions.
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.DtmfSettings
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.ncco.InputAction
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.ncco.RecordAction
Entrypoint for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.ncco.SpeechSettings
Entry point for constructing an instance of this class.
builder() - Static method in class com.vonage.client.voice.ncco.TranscriptionSettings
Entrypoint for constructing an instance of this class.
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(MessageType) - Static method in class com.vonage.client.conversations.MessageEvent
Entry point for constructing an instance of this class.
builder(ScreenLayoutType) - Static method in class com.vonage.client.video.StreamCompositionLayout
Entry point for constructing an object.
builder(Endpoint...) - Static method in class com.vonage.client.voice.ncco.ConnectAction
Entry point for constructing an instance of this class.
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.verify2.SilentAuthWorkflow
Entrypoint for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.verify2.SmsWorkflow
Entrypoint for constructing an instance of this class.
builder(String) - Static method in class com.vonage.client.video.Archive
Instantiates a Builder, used to construct this object.
builder(String) - Static method in class com.vonage.client.video.Broadcast
Instantiates a Builder, used to construct this object.
builder(String) - Static method in class com.vonage.client.video.SessionStream
Entry point for building an instance of .
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
Entrypoint for constructing an instance of this class.
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.numbers.UpdateNumberRequest
Entrypoint for constructing an instance of this class.
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.Capability.Builder
 
Builder() - Constructor for class com.vonage.client.application.capabilities.Messages.Builder
 
Builder() - Constructor for class com.vonage.client.application.capabilities.Rtc.Builder
Deprecated.
Use Rtc.builder() instead. This constructor will be made private in a future release.
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
Deprecated.
Builder() - Constructor for class com.vonage.client.common.HalFilterRequest.Builder
 
Builder() - Constructor for class com.vonage.client.HttpConfig.Builder
Deprecated.
Will be made private in the next major version.
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.rcs.RcsRequest.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.video.RenderRequest.Builder
 
Builder() - Constructor for class com.vonage.client.video.SipDialRequest.Builder
 
Builder() - Constructor for class com.vonage.client.video.StreamComposition.Builder
 
Builder() - Constructor for class com.vonage.client.VonageClient.Builder
 
Builder(Application) - Constructor for class com.vonage.client.application.Application.Builder
 
Builder(EventType) - Constructor for class com.vonage.client.conversations.Event.Builder
Construct a new builder for a given event type.
Builder(Channel) - Constructor for class com.vonage.client.verify2.Workflow.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) - Constructor for class com.vonage.client.video.SessionStream.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
Deprecated.
 
buildOidcUrl() - Method in class com.vonage.client.auth.camara.FrontendAuthRequest
 
buildOidcUrl(BackendAuthRequest) - Method in class com.vonage.client.auth.camara.NetworkAuthClient
 
buildUri(String, Map<String, ?>) - Static method in class com.vonage.client.DynamicEndpoint
 
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
 
BULGARIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
BUSINESS - Enum constant in enum class com.vonage.client.insight.CallerType
 
BUSY - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
BUSY - Enum constant in enum class com.vonage.client.voice.CallStatus
The destination is on the line with another caller.
button - Variable in class com.vonage.client.messages.InboundMessage
 
Button - Class in com.vonage.client.messages
Used for inbound Button messages.
BUTTON - Enum constant in enum class com.vonage.client.common.MessageType
 
BUTTON - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
buyNumber(String, String) - Method in class com.vonage.client.numbers.NumbersClient
Start renting a Vonage Virtual Number.
buyNumber(String, String, String) - Method in class com.vonage.client.numbers.NumbersClient
Start renting a Vonage Virtual Number.

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
Deprecated.
Calculates hash for string. assume string is UTF-8 encoded
calculate(String, HashUtil.HashType) - Static method in class com.vonage.client.auth.hashutils.HashUtil
Deprecated.
This will be removed in the next major release.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.AbstractHasher
Deprecated.
Calculates hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacMd5Hasher
Deprecated.
Calculates HMAC MD-5 hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha1Hasher
Deprecated.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha256Hasher
Deprecated.
Calculates HMAC SHA-256 hash for string.
calculate(String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha512Hasher
Deprecated.
Calculates HMAC SHA-512 hash for string.
calculate(String, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.hashutils.HashUtil
Deprecated.
This will be removed in the next major release.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.AbstractHasher
Deprecated.
Calculates hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacMd5Hasher
Deprecated.
Calculates HMAC MD-5 hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha1Hasher
Deprecated.
Calculates HMAC SHA-1 hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha256Hasher
Deprecated.
Calculates HMAC SHA-256 hash for string.
calculate(String, String, String) - Method in class com.vonage.client.auth.hashutils.HmacSha512Hasher
Deprecated.
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(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(Callback) - Method in class com.vonage.client.conversations.Conversation.Builder
Specifies callback parameters for webhooks.
callback(String) - Method in class com.vonage.client.insight.AdvancedInsightRequest.Builder
 
Callback - Class in com.vonage.client.conversations
Callback properties for a Conversation.
Callback.Builder - Class in com.vonage.client.conversations
Builder for creating Callback settings.
Callback.Params - Class in com.vonage.client.conversations
 
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
Deprecated.
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
Deprecated.
CallEvent - Class in com.vonage.client.voice
Represents metadata about a call.
CallEvent() - Constructor for class com.vonage.client.incoming.CallEvent
Deprecated.
 
CallEvent() - Constructor for class com.vonage.client.voice.CallEvent
 
CallInfo - Class in com.vonage.client.voice
CallInfo holds the information related to a call.
CallInfoPage - Class in com.vonage.client.voice
 
CallInfoPage() - Constructor for class com.vonage.client.voice.CallInfoPage
 
CallOrder - Enum Class in com.vonage.client.voice
Deprecated.
Replaced by SortOrder.
CallsFilter - Class in com.vonage.client.voice
CallsFilter.Builder - Class in com.vonage.client.voice
 
CallStatus - Enum Class in com.vonage.client.incoming
Deprecated.
CallStatus - Enum Class in com.vonage.client.voice
Describes the status of the call, and also the event in EventWebhook.getStatus().
CallStatusDetail - Enum Class in com.vonage.client.incoming
Deprecated.
CallStatusDetail - Enum Class in com.vonage.client.voice
Represents the detail field in EventWebhook.getDetail().
CamaraResponseException - Exception Class in com.vonage.client.camara
Response returned when a network request fails (i.e. returns a non-2xx status code).
CamaraResponseException() - Constructor for exception class com.vonage.client.camara.CamaraResponseException
 
CAMERA - Enum constant in enum class com.vonage.client.video.VideoType
Uses the camera as the video source.
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
Deprecated.
 
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
An outgoing call is cancelled by the originator before being answered.
cancelNumber(String, String) - Method in class com.vonage.client.numbers.NumbersClient
Stop renting a Vonage Virtual Number.
cancelNumber(String, String, String) - Method in class com.vonage.client.numbers.NumbersClient
Stop renting a Vonage Virtual Number.
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.
canHear(Collection<String>) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
A collection of leg UUIDs that this participant can hear.
CANNOT_ROUTE - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Cannot route to the number.
CANNOT_ROUTE - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
Cannot route to the number.
canSpeak(Collection<String>) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
A collection of leg UUIDs that this participant can be heard by.
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(Capability.Builder<?, ?>) - Constructor for class com.vonage.client.application.capabilities.Capability
 
Capability.Builder<C,B> - Class in com.vonage.client.application.capabilities
 
Capability.Type - Enum Class in com.vonage.client.application.capabilities
Represents the API this capability relates to.
caption - Variable in class com.vonage.client.messages.InboundMessage.UrlWrapperWithCaption
 
caption - Variable in class com.vonage.client.messages.internal.MessagePayload
 
caption(String) - Method in interface com.vonage.client.messages.CaptionMediaMessageRequest.Builder
Sets the media's caption text.
caption(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(OPTIONAL) Additional text to accompany the media.
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.MmsVcardRequest.Builder
(OPTIONAL) Additional text to accompany the vCard.
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.
CaptionMediaMessageRequest - Interface in com.vonage.client.messages
Convenience interface to indicate that a media message may have a caption.
CaptionMediaMessageRequest.Builder<B> - Interface in com.vonage.client.messages
Interface for builders with a media URL and caption.
CaptionsRequest - Class in com.vonage.client.video
Defines the captioning properties used in VideoClient.startCaptions(CaptionsRequest).
CaptionsRequest.Builder - Class in com.vonage.client.video
Builder for defining the fields in a StartCaptionsRequest object.
CaptionsResponse - Class in com.vonage.client.video
Represents the response from VideoClient.startCaptions(CaptionsRequest).
CARRIER_TIMEOUT - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Carrier timed out.
CARRIER_TIMEOUT - Enum constant in enum class com.vonage.client.voice.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.Builder
 
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(int) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Number of channels for the recording.
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.
channelType(ChannelType) - Method in class com.vonage.client.conversations.Member.Builder
(REQUIRED) Top-level channel type.
ChannelType - Enum Class in com.vonage.client.common
Represents the various available channel types.
check(CheckRequest) - Method in class com.vonage.client.verify.VerifyClient
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_SIM_SWAP - Enum constant in enum class com.vonage.client.auth.camara.FraudPreventionDetectionScope
 
CheckRequest - Class in com.vonage.client.verify
Deprecated.
This will be made package-private in the next major release.
CheckRequest(String, String) - Constructor for class com.vonage.client.verify.CheckRequest
Deprecated.
Creates a new CheckRequest.
CheckResponse - Class in com.vonage.client.verify
 
CheckResponse(VerifyStatus) - Constructor for class com.vonage.client.verify.CheckResponse
 
checkSimSwap(String) - Method in class com.vonage.client.camara.simswap.SimSwapClient
Check if SIM swap has been performed within the last 240 hours for the given phone number.
checkSimSwap(String, int) - Method in class com.vonage.client.camara.simswap.SimSwapClient
Check if SIM swap has been performed during the specified past period for the given phone number.
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_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_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
CLEARING - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
clearList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Delete all items in a list.
clientRef - Variable in class com.vonage.client.messages.InboundMessage
 
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 class com.vonage.client.VonageApiResponseException
 
code(String) - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
Reason code for leaving.
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).
COLOMBIAN_SPANISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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.camara - package com.vonage.client.auth.camara
This package contains classes to support usage of the Vonage Network Auth API.
com.vonage.client.auth.hashutils - package com.vonage.client.auth.hashutils
 
com.vonage.client.camara - package com.vonage.client.camara
This package contains classes and subpackages to support usage of the Vonage Network APIs.
com.vonage.client.camara.numberverification - package com.vonage.client.camara.numberverification
This package contains classes to support usage of the Number Verification API.
com.vonage.client.camara.simswap - package com.vonage.client.camara.simswap
This package contains classes to support usage of the SIM Swap API.
com.vonage.client.common - package com.vonage.client.common
 
com.vonage.client.conversations - package com.vonage.client.conversations
Implementation of the Conversation API.
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.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.rcs - package com.vonage.client.messages.rcs
 
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.numberinsight2 - package com.vonage.client.numberinsight2
Implementation of the Number Insight v2 API.
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
This package contains classes and sub-packages to support usage of the Vonage SMS API.
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.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.video - package com.vonage.client.video
This package contains classes to support usage of the Video 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.
COMMS_FAILURE - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
compareTo(AuthMethod) - Method in interface com.vonage.client.auth.AuthMethod
 
COMPLETED - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
COMPLETED - Enum constant in enum class com.vonage.client.numberinsight2.FraudScoreStatus
 
COMPLETED - Enum constant in enum class com.vonage.client.numberinsight2.SimSwapStatus
 
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
The call has finished.
COMPOSED - Enum constant in enum class com.vonage.client.video.OutputMode
All streams in the archive are recorded to a single (composed) file.
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
 
CONNECTING - Enum constant in enum class com.vonage.client.video.RtmpStatus
The Vonage video platform is in the process of connecting to the remote RTMP server.
connectionTimeout(int) - Method in class com.vonage.client.common.Webhook.Builder
Deprecated.
(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.
ConnectRequest - Class in com.vonage.client.video
Defines properties used for Audio Connector.
ConnectRequest.Builder - Class in com.vonage.client.video
Builder for defining the fields in a ConnectRequest object.
ConnectResponse - Class in com.vonage.client.video
Represents the response from VideoClient.startCaptions(CaptionsRequest).
connectToWebsocket(ConnectRequest) - Method in class com.vonage.client.video.VideoClient
Send audio from a Vonage Video API session to a WebSocket.
constructSignatureForRequestParameters(List<NameValuePair>, String) - Static method in class com.vonage.client.auth.RequestSigning
constructSignatureForRequestParameters(List<NameValuePair>, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
constructSignatureForRequestParameters(Map<String, String>, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
CONSUMER - Enum constant in enum class com.vonage.client.insight.CallerType
 
CONTACT - Enum constant in enum class com.vonage.client.common.MessageType
 
CONTACT - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
ContactsList - Class in com.vonage.client.proactiveconnect
Represents a Proactive Connect list.
ContactsList.Builder - Class in com.vonage.client.proactiveconnect
 
content - Variable in class com.vonage.client.messages.InboundMessage
 
Content - Class in com.vonage.client.messages.mms
Represents file attachments in InboundMessage.getContent().
Content() - Constructor for class com.vonage.client.messages.mms.Content
 
contentId(String) - Method in class com.vonage.client.messages.sms.SmsTextRequest.Builder
(OPTIONAL) A string parameter that satisfies regulatory requirements when sending an SMS to specific countries.
contentId(String) - Method in class com.vonage.client.verify2.SmsWorkflow.Builder
(OPTIONAL) The TemplateID for SMS delivery using Indian Carriers.
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(String...) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Hints to improve recognition quality if certain words are expected from the user.
context(Collection<String>) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Hints to improve recognition quality if certain words are expected from the user.
Context - Class in com.vonage.client.messages.whatsapp
This is only present for the Inbound Message where the user is quoting another message.
contextMessageId(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappRequest.Builder
(REQUIRED for replies and reaction messages) An optional context used for quoting/replying to a specific message in a conversation.
ContextStatus - Enum Class in com.vonage.client.messages.whatsapp
Represents the WhatsApp context_status field in InboundMessage.
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 - Class in com.vonage.client.conversations
Represents a Conversation (request and response).
Conversation() - Constructor for class com.vonage.client.conversations.Conversation
 
CONVERSATION - Enum constant in enum class com.vonage.client.voice.ncco.SplitRecording
 
CONVERSATION_UPDATED - Enum constant in enum class com.vonage.client.conversations.EventType
Conversation details have been updated.
Conversation.Builder - Class in com.vonage.client.conversations
Builder for creating or updating a Conversation.
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
Builder for specifying the properties of a Conversation NCCO.
conversationId(String) - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
(REQUIRED) Unique conversation identifier.
ConversationProperties - Class in com.vonage.client.conversations
Additional properties for a Conversation.
ConversationProperties.Builder - Class in com.vonage.client.conversations
 
ConversationsClient - Class in com.vonage.client.conversations
A client for communicating with the Vonage Conversations API.
ConversationsClient(HttpWrapper) - Constructor for class com.vonage.client.conversations.ConversationsClient
Constructor.
ConversationsResponseException - Exception Class in com.vonage.client.conversations
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
ConversationsResponseException() - Constructor for exception class com.vonage.client.conversations.ConversationsResponseException
 
ConversationStatus - Enum Class in com.vonage.client.conversations
Represents the status of a Conversation.
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. 0 means infinite.
ConversationTimestamp - Class in com.vonage.client.conversations
Represents the timestamps in BaseConversation.getTimestamp().
ConversationTimestamp() - Constructor for class com.vonage.client.conversations.ConversationTimestamp
 
ConversationType - Enum Class in com.vonage.client.messages.whatsapp
Represents the conversation category as returned by MessageStatus.getWhatsappConversationType().
ConversationUpdatedEvent - Class in com.vonage.client.conversations
Represents a EventType.CONVERSATION_UPDATED event.
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
Deprecated.
This class will be made package-private in the next major release.
ConversionRequest(ConversionRequest.Type, String, boolean, Date) - Constructor for class com.vonage.client.conversion.ConversionRequest
Deprecated.
 
ConversionRequest.Type - Enum Class in com.vonage.client.conversion
Deprecated.
This enum will be moved to its own class in the next major release.
count(int) - Method in class com.vonage.client.video.ListStreamCompositionsRequest.Builder
Set a count query parameter to limit the number of composition to be returned.
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
Groups the country details in PricingResponse.
Country() - Constructor for class com.vonage.client.account.Country
 
createApplication(Application) - Method in class com.vonage.client.application.ApplicationClient
Create a new application.
createArchive(Archive) - Method in class com.vonage.client.video.VideoClient
Create a new archive.
createBroadcast(Broadcast) - Method in class com.vonage.client.video.VideoClient
Start a new live streaming broadcast.
createCall(Call) - Method in class com.vonage.client.voice.VoiceClient
Begin a call to a phone number.
createConversation(Conversation) - Method in class com.vonage.client.conversations.ConversationsClient
Creates a new Conversation within the application.
CREATED - Enum constant in enum class com.vonage.client.conversations.OrderBy
 
createdAt - Variable in class com.vonage.client.video.StreamComposition
 
createDefaultObjectMapper() - Static method in interface com.vonage.client.Jsonable
Convenience method for creating an ObjectMapper with standard settings.
createEvent(String, E) - Method in class com.vonage.client.conversations.ConversationsClient
Creates a new Event for the specified conversation.
createHttpClient() - Method in class com.vonage.client.HttpWrapper
 
createJsonObjectMapper() - Method in class com.vonage.client.JsonableBaseObject
Provides a mechanism for overriding the Jackson configuration options for this class.
createList(ContactsList) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Create a new list.
createListItem(UUID, Map<String, ?>) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Create a new list item.
createMember(String, Member) - Method in class com.vonage.client.conversations.ConversationsClient
Creates a new Member for the specified conversation.
createRoom(MeetingRoom) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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.
createSession() - Method in class com.vonage.client.video.VideoClient
Generate a new session, using default properties.
createSession(CreateSessionRequest) - Method in class com.vonage.client.video.VideoClient
Generate a new session.
CreateSessionRequest - Class in com.vonage.client.video
Defines the properties used to create a new video session.
CreateSessionRequest.Builder - Class in com.vonage.client.video
Builder for constructing CreateSessionRequest.
CreateSessionResponse - Class in com.vonage.client.video
 
CreateSessionResponse() - Constructor for class com.vonage.client.video.CreateSessionResponse
 
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
 
createTemplate(String) - Method in class com.vonage.client.verify2.Verify2Client
Create a new custom template.
createTemplateFragment(UUID, TemplateFragment) - Method in class com.vonage.client.verify2.Verify2Client
Create a new template fragment.
createTheme(Theme) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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
 
cursor - Variable in class com.vonage.client.common.HalFilterRequest.Builder
 
cursor - Variable in class com.vonage.client.common.HalFilterRequest
 
cursor(String) - Method in class com.vonage.client.common.HalFilterRequest.Builder
The cursor to start returning results from.
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 - Variable in class com.vonage.client.messages.MessageRequest
 
custom(Map<String, ?>) - Method in class com.vonage.client.messages.MessageRequest.Builder
(REQUIRED) Custom payload.
custom(Map<String, ?>) - Method in class com.vonage.client.messages.rcs.RcsCustomRequest.Builder
A custom payload.
custom(Map<String, ?>) - 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.common.MessageType
 
CUSTOM - Enum constant in enum class com.vonage.client.conversations.EventType
Custom event.
CUSTOM - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
CUSTOM - Enum constant in enum class com.vonage.client.video.ScreenLayoutType
Custom (uses stylesheet)
CUSTOM - Enum constant in enum class com.vonage.client.video.VideoType
Published by a web client using an HTML VideoTrack element as the video source.
CUSTOM_SORT_KEY - Enum constant in enum class com.vonage.client.conversations.OrderBy
 
customData(Map<String, ?>) - Method in class com.vonage.client.users.User.Builder
Arbitrary freeform data to associate with the user.
customData(Map<String, Object>) - Method in class com.vonage.client.conversations.ConversationProperties.Builder
Custom key-value pairs to be included with conversation data.
CUSTOMER_FEEDBACK - Enum constant in enum class com.vonage.client.messages.messenger.Tag
 
CustomEvent - Class in com.vonage.client.conversations
Represents a Custom event.
CustomEvent.Builder - Class in com.vonage.client.conversations
 
customSortKey(String) - Method in class com.vonage.client.conversations.ConversationProperties.Builder
Custom sort key.
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
 

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
 
data(String) - Method in class com.vonage.client.video.SignalRequest.Builder
(REQUIRED) Payload that is being sent to the client.
data(String) - Method in class com.vonage.client.video.TokenOptions.Builder
A string containing connection metadata describing the end-user.
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
DE_DE - Enum constant in enum class com.vonage.client.video.Language
German
DECLINED - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Call rejected by callee.
DECLINED - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
Call rejected by callee.
DEFAULT - Enum constant in enum class com.vonage.client.meetings.MicrophoneState
 
DEFAULT - Enum constant in enum class com.vonage.client.voice.AdvancedMachineDetection.Mode
Asynchronously start processing NCCO actions during the detection phase.
defaultConfig() - Static method in class com.vonage.client.HttpConfig
Creates a standard 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.
deleteArchive(String) - Method in class com.vonage.client.video.VideoClient
Deletes an archive.
deleteConversation(String) - Method in class com.vonage.client.conversations.ConversationsClient
Delete an existing conversation by ID.
DELETED - Enum constant in enum class com.vonage.client.conversations.ConversationStatus
 
DELETED - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive file has been deleted.
deleteEvent(String, int) - Method in class com.vonage.client.conversations.ConversationsClient
Deletes an event.
deleteList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Delete a list.
deleteListItem(UUID, UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Delete a list item.
deleteRecording(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
Delete a recording.
deleteTemplate(UUID) - Method in class com.vonage.client.verify2.Verify2Client
Delete a template.
deleteTemplateFragment(UUID, UUID) - Method in class com.vonage.client.verify2.Verify2Client
Delete a template fragment.
deleteTheme(UUID, boolean) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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
Deprecated.
Descending
DESC - Enum constant in enum class com.vonage.client.users.ListUsersRequest.SortOrder
Descending
DESCENDING - Enum constant in enum class com.vonage.client.common.SortOrder
Descending (desc)
DESCENDING - Enum constant in enum class com.vonage.client.voice.CallOrder
Deprecated.
 
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 class 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.
detectSpeech(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether speech detection is enabled.
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
 
DISCONNECTED - Enum constant in enum class com.vonage.client.voice.CallStatus
If the WebSocket connection is terminated from the application side for any reason, then the disconnected event callback will be sent.
displayName(String) - Method in class com.vonage.client.conversations.Conversation.Builder
The public facing name of the conversation.
displayName(String) - Method in class com.vonage.client.users.User.Builder
Set the display name for the user.
downloadListItems(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Download all items in a list in CSV format.
downloadListItems(UUID, Path) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Download all items in a list in CSV format.
downloadRecordingRaw(String) - Method in class com.vonage.client.voice.VoiceClient
Download a recording.
dtmf() - Method in class com.vonage.client.voice.ncco.InputAction.Builder
Enables DTMF with the default settings.
dtmf(DtmfSettings) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
Enable DTMF input with the provided settings.
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
Deprecated.
DtmfResult - Class in com.vonage.client.voice
Represents the DTMF event results in EventWebhook.getDtmf().
DtmfResult() - Constructor for class com.vonage.client.incoming.DtmfResult
Deprecated.
 
DtmfResult() - Constructor for class com.vonage.client.voice.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
Deprecated.
Use DtmfSettings.builder(). This will be made package-private in the next major release.
DtmfSettings.Builder - Class in com.vonage.client.voice.ncco
Builder for specifying DTMF settings.
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
 
dvr() - Method in class com.vonage.client.video.Hls
Whether DVR functionality — rewinding, pausing, and resuming — is enabled in players that support it.
dvr(boolean) - Method in class com.vonage.client.video.Hls.Builder
Whether to enable DVR functionality — rewinding, pausing, and resuming — in players that support it (true), or not (false, the default).
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
 
e2ee(boolean) - Method in class com.vonage.client.video.CreateSessionRequest.Builder
Call this method to enable end-to-end encryption for the session.
EARMUFF - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
earmuffCall(String) - Method in class com.vonage.client.voice.VoiceClient
Modify a call with the ModifyCallAction.EARMUFF action.
earmuffed(boolean) - Method in class com.vonage.client.conversations.MemberMedia.Builder
 
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
EN_AU - Enum constant in enum class com.vonage.client.video.Language
Australian English
EN_GB - Enum constant in enum class com.vonage.client.video.Language
British English
EN_US - Enum constant in enum class com.vonage.client.video.Language
American English
encodingType(EncodingType) - Method in class com.vonage.client.messages.sms.SmsTextRequest.Builder
(OPTIONAL) The encoding type to use for the message.
EncodingType - Enum Class in com.vonage.client.messages.sms
Represents the encoding type for an SMS text message.
END_ON_SILENCE_TIMEOUT - Enum constant in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
Deprecated.
 
END_ON_SILENCE_TIMEOUT - Enum constant in enum class com.vonage.client.voice.SpeechTimeoutReason
 
endDate - Variable in class com.vonage.client.common.HalFilterRequest.Builder
 
endDate - Variable in class com.vonage.client.common.HalFilterRequest
 
endDate(Instant) - Method in class com.vonage.client.common.HalFilterRequest.Builder
Filter records that occurred before this point in time.
endDate(Instant) - Method in class com.vonage.client.conversations.ListConversationsRequest.Builder
 
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.
endId(int) - Method in class com.vonage.client.conversations.ListEventsRequest.Builder
The ID to stop returning events at.
endOnExit(Boolean) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
For moderated conversations, set to true in the moderator NCCO so the conversation is ended when the moderator hangs up.
endOnKey(Character) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
endOnSilence(double) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Controls how long the system will wait after user stops speaking to decide the input is completed.
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
Deprecated.
This will be removed in the next major release.
Endpoint - Interface in com.vonage.client.voice
 
Endpoint - Interface in com.vonage.client.voice.ncco
An endpoint for a ConnectAction to connect to.
EndpointType - Enum Class in com.vonage.client.voice
Represents the various types of call endpoints supported by the Voice API.
ENDS_WITH - Enum constant in enum class com.vonage.client.numbers.SearchPattern
Search for numbers that end with the pattern.
ENGLISH - Enum constant in enum class com.vonage.client.messages.whatsapp.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.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_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
 
ENTERPRISE - Enum constant in enum class com.vonage.client.video.ProjectEnvironment
 
entityId(String) - Method in class com.vonage.client.messages.sms.SmsTextRequest.Builder
(OPTIONAL) A string parameter that satisfies regulatory requirements when sending an SMS to specific countries.
entityId(String) - Method in class com.vonage.client.verify2.SmsWorkflow.Builder
(OPTIONAL) PEID field required for SMS delivery using Indian Carriers.
EPHEMERAL - Enum constant in enum class com.vonage.client.conversations.EventType
Ephemeral (temporary) event.
EphemeralEvent - Class in com.vonage.client.conversations
Represents an Ephemeral event.
EphemeralEvent.Builder - Class in com.vonage.client.conversations
 
equals(Object) - Method in class com.vonage.client.auth.AbstractAuthMethod
 
equals(Object) - Method in class com.vonage.client.JsonableBaseObject
 
equals(Object) - Method in exception class com.vonage.client.VonageApiResponseException
 
error - Variable in class com.vonage.client.messages.MessageStatus
 
Error() - Constructor for class com.vonage.client.messages.MessageStatus.Error
 
ERROR - Enum constant in enum class com.vonage.client.video.RtmpStatus
There is an error in the Vonage video platform.
errorCode - Variable in exception class com.vonage.client.VonageApiResponseException
 
errorCodeLabel - Variable in exception class com.vonage.client.VonageApiResponseException
 
errors - Variable in exception class 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.conversations
Events are actions that occur within a conversation.
Event - Class in com.vonage.client.proactiveconnect
Represents an event in the Proactive Connect API.
Event() - Constructor for class com.vonage.client.conversations.Event
 
Event() - Constructor for class com.vonage.client.proactiveconnect.Event
 
EVENT - Enum constant in enum class com.vonage.client.common.Webhook.Type
Deprecated.
 
EVENT - Enum constant in enum class com.vonage.client.verify2.CallbackType
Used for miscellaneous event updates.
EVENT_DELETE - Enum constant in enum class com.vonage.client.conversations.EventType
Event has been deleted.
EVENT_HANDLER - Enum constant in enum class com.vonage.client.proactiveconnect.SourceType
Event handler
Event.Builder<E,B> - Class in com.vonage.client.conversations
Builder for constructing an event request's parameters.
EventDeleteEvent - Class in com.vonage.client.conversations
Represents a EventType.EVENT_DELETE event.
eventId(int) - Method in class com.vonage.client.conversations.MessageDeliveredEvent.Builder
ID of the event.
eventId(int) - Method in class com.vonage.client.conversations.MessageRejectedEvent.Builder
ID of the event.
eventId(int) - Method in class com.vonage.client.conversations.MessageSeenEvent.Builder
ID of the event.
eventId(int) - Method in class com.vonage.client.conversations.MessageSubmittedEvent.Builder
ID of the event.
eventId(int) - Method in class com.vonage.client.conversations.MessageUndeliverableEvent.Builder
ID of the event.
eventMask(String) - Method in class com.vonage.client.conversations.Callback.Builder
Callback event mask.
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
Set the HTTP method used to make the request to eventUrl.
eventMethod(EventMethod) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
The HTTP method used to send event information to event_url The default value is POST.
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(EventMethod) - Method in class com.vonage.client.voice.ncco.TranscriptionSettings.Builder
The HTTP method Vonage uses to make the request to eventUrl.
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.conversations.ListEventsRequest.Builder
The type of event to search for.
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.conversations
Represents the possible types of events in Event.getType().
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.InputAction.Builder
Vonage sends the digits pressed by the callee to this URL after timeOut pause inactivity or when # is pressed.
eventUrl(String) - Method in class com.vonage.client.voice.ncco.TranscriptionSettings.Builder
The URL to the webhook endpoint that is called asynchronously when a transcription is finished.
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
Set the URL to the webhook endpoint Vonage calls asynchronously on each of the Call States.
eventUrl(String...) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
Deprecated.
This will be removed in a future release. Use InputAction.Builder.eventUrl(String) instead.
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(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
Deprecated.
This will be removed in the next major release.
eventUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
Deprecated.
This will be removed in a future release. Use InputAction.Builder.eventUrl(String) instead.
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
 
EventWebhook - Class in com.vonage.client.voice
Represents all call events sent to the event_url webhook configured in your Voice application settings.
EventWebhook() - Constructor for class com.vonage.client.voice.EventWebhook
 
excludeDeletedEvents(boolean) - Method in class com.vonage.client.conversations.ListEventsRequest.Builder
Whether to exclude deleted events from the results.
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
 
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.
EXPIRED - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive file is no longer available in the cloud.
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
 
expiryLength(Duration) - Method in class com.vonage.client.video.TokenOptions.Builder
Sets the expiration time for the token.
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
Deprecated.
 
FAILED - Enum constant in enum class com.vonage.client.insight.LookupOutcome
 
FAILED - Enum constant in enum class com.vonage.client.numberinsight2.SimSwapStatus
 
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.video.ArchiveStatus
The recording of the archive failed.
FAILED - Enum constant in enum class com.vonage.client.video.RenderStatus
An error occurred and the Experience Composer could not proceed.
FAILED - Enum constant in enum class com.vonage.client.voice.CallStatus
The outgoing call could not be connected.
FALLBACK_ANSWER - Enum constant in enum class com.vonage.client.common.Webhook.Type
Deprecated.
 
FAVICON - Enum constant in enum class com.vonage.client.meetings.LogoType
 
Feature - Enum Class in com.vonage.client.numbers
Represents the capabilities of a phone number.
features(Feature...) - Method in class com.vonage.client.numbers.SearchNumbersFilter.Builder
Set this parameter to find numbers that have one or more features.
FETCHING - Enum constant in enum class com.vonage.client.proactiveconnect.SyncStatusValue
 
fetchList(UUID) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Fetch and replace all items from datasource.
FHD_LANDSCAPE - Enum constant in enum class com.vonage.client.video.Resolution
1080p landscape (1920x1080)
FHD_PORTRAIT - Enum constant in enum class com.vonage.client.video.Resolution
1080p portrait (1080x1920)
Fields() - Constructor for class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
 
file - Variable in class com.vonage.client.messages.InboundMessage
 
FILE - Enum constant in enum class com.vonage.client.common.MessageType
 
FILE - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
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
 
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
 
FLAG - Enum constant in enum class com.vonage.client.numberinsight2.RiskRecommendation
 
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.
forceDisconnect(String, String) - Method in class com.vonage.client.video.VideoClient
Force a client to disconnect from a session.
format(RecordingFormat) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
format(String) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
File format for the recording.
formatTimestamp(Instant) - Method in class com.vonage.client.conversations.ListConversationsRequest
 
formatTimestamp(Instant) - Method in class com.vonage.client.conversations.ListEventsRequest
 
formatTimestamp(Instant) - Method in class com.vonage.client.conversations.ListMembersRequest
 
formatTimestamp(Instant) - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
FR - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
French
FR_FR - Enum constant in enum class com.vonage.client.video.Language
French
FragmentChannel - Enum Class in com.vonage.client.verify2
Represents the template channel type in a TemplateFragment.
FRAUD_SCORE - Enum constant in enum class com.vonage.client.numberinsight2.Insight
 
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.
fraudCheck(String, Insight, Insight...) - Method in class com.vonage.client.numberinsight2.NumberInsight2Client
Make fraud check requests with a phone number by looking up fraud score and/or by checking SIM swap status.
FraudCheckResponse - Class in com.vonage.client.numberinsight2
FraudCheckResponse() - Constructor for class com.vonage.client.numberinsight2.FraudCheckResponse
 
FraudPreventionDetectionScope - Enum Class in com.vonage.client.auth.camara
 
FraudScore - Class in com.vonage.client.numberinsight2
Represents the fraud score insight results in FraudCheckResponse.getFraudScore().
FraudScore() - Constructor for class com.vonage.client.numberinsight2.FraudScore
 
FraudScoreStatus - Enum Class in com.vonage.client.numberinsight2
Represents the status in FraudScore.getStatus().
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.voice.ncco.SpeechSettings.Language
 
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
 
from - Variable in class com.vonage.client.messages.MessageStatus
 
from - Variable in class com.vonage.client.verify2.Workflow.Builder
 
from - Variable in class com.vonage.client.verify2.Workflow
 
from(String) - Method in class com.vonage.client.conversations.Event.Builder
Member ID this event was sent from.
from(String) - Method in class com.vonage.client.conversations.Member.Builder
(OPTIONAL) TODO document this
from(String) - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
TODO document this
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.verify2.SmsWorkflow.Builder
(OPTIONAL) The number or ID to send the SMS from.
from(String) - Method in class com.vonage.client.verify2.Workflow.Builder
 
from(String) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) The number or string that will be sent to the final SIP number as the caller.
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.
fromChannel(Channel) - Method in class com.vonage.client.conversations.Member.Builder
(OPTIONAL) Concrete channel to use when sending messages.
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(int) - Static method in enum class com.vonage.client.video.Websocket.AudioRate
Converts an integer sampling value into the appropriate enum representation.
fromInt(Integer) - Static method in enum class com.vonage.client.insight.LookupOutcome
 
fromJson(Class<E>, String) - Static method in exception class com.vonage.client.VonageApiResponseException
 
fromJson(String) - Static method in exception class 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
Deprecated.
fromJson(String) - Static method in class com.vonage.client.account.ListSecretsResponse
Deprecated.
fromJson(String) - Static method in class com.vonage.client.account.PrefixPricingResponse
Deprecated.
 
fromJson(String) - Static method in class com.vonage.client.account.PricingResponse
Deprecated.
This will be removed in the next major release.
fromJson(String) - Static method in class com.vonage.client.account.SecretResponse
Deprecated.
fromJson(String) - Static method in class com.vonage.client.account.SettingsResponse
Deprecated.
fromJson(String) - Static method in class com.vonage.client.application.Application
 
fromJson(String) - Static method in class com.vonage.client.application.ApplicationList
Deprecated.
fromJson(String) - Static method in exception class com.vonage.client.application.ApplicationResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception class com.vonage.client.auth.camara.NetworkAuthResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception class com.vonage.client.camara.CamaraResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception class com.vonage.client.conversations.ConversationsResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
fromJson(String) - Static method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
fromJson(String) - Static method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
fromJson(String) - Static method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
fromJson(String) - Static method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
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 class 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 class 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.numberinsight2.FraudCheckResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception class com.vonage.client.numberinsight2.NumberInsight2ResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.numbers.ListNumbersResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception class 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
Creates an instance of this class from a JSON payload.
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 class 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 exception class com.vonage.client.redact.RedactResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.sms.MessageEvent
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 class 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 class 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 class com.vonage.client.verify2.VerifyResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.video.Archive
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.video.Broadcast
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.video.CreateSessionResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.video.GetStreamResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.video.ProjectDetails
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.video.SipDialResponse
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in exception class com.vonage.client.video.VideoResponseException
Creates an instance of this class from a JSON payload.
fromJson(String) - Static method in class com.vonage.client.voice.AnswerWebhook
Constructs an instance, populating this class's fields from the JSON string.
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
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.EventWebhook
Constructs an instance, populating this class's fields from the JSON string.
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) - Static method in exception class com.vonage.client.voice.VoiceResponseException
Creates an instance of this class from a JSON payload.
fromJson(String, J...) - Static method in interface com.vonage.client.Jsonable
Delegates to Jsonable.fromJson(String, Class), using the type varargs for inferring the class.
fromJson(String, Class<? extends J>) - Static method in interface com.vonage.client.Jsonable
Creates a new instance of the designated Jsonable class, calling its no-args constructor followed by Jsonable.updateFromJson(String).
fromName(String) - Static method in enum class com.vonage.client.common.Webhook.Type
Deprecated.
 
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
Converts a string representation of the network type to an enum.
fromString(String) - Static method in enum class com.vonage.client.ApiRegion
Converts a string representation of a region to the corresponding enum value.
fromString(String) - Static method in enum class com.vonage.client.application.capabilities.Region
 
fromString(String) - Static method in enum class com.vonage.client.common.ChannelType
 
fromString(String) - Static method in enum class com.vonage.client.common.HttpMethod
 
fromString(String) - Static method in enum class com.vonage.client.common.MessageType
 
fromString(String) - Static method in enum class com.vonage.client.common.SortOrder
 
fromString(String) - Static method in enum class com.vonage.client.conversations.ConversationStatus
 
fromString(String) - Static method in enum class com.vonage.client.conversations.EventType
 
fromString(String) - Static method in enum class com.vonage.client.conversations.MemberState
 
fromString(String) - Static method in enum class com.vonage.client.incoming.CallDirection
Deprecated.
 
fromString(String) - Static method in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
fromString(String) - Static method in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
 
fromString(String) - Static method in enum class com.vonage.client.incoming.MessageType
Deprecated.
 
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
Deprecated.
 
fromString(String) - Static method in enum class com.vonage.client.messages.sms.EncodingType
 
fromString(String) - Static method in enum class com.vonage.client.messages.whatsapp.ContextStatus
 
fromString(String) - Static method in enum class com.vonage.client.messages.whatsapp.ConversationType
 
fromString(String) - Static method in enum class com.vonage.client.messages.whatsapp.Reaction.Action
 
fromString(String) - Static method in enum class com.vonage.client.numberinsight2.PhoneType
 
fromString(String) - Static method in enum class com.vonage.client.numbers.Feature
Converts the string representation of the feature to its enum value.
fromString(String) - Static method in enum class com.vonage.client.numbers.Type
Creates an instance of this enum from its serialized string representation.
fromString(String) - Static method in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
Creates the enum from its string representation.
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.sms.MessageType
 
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.FragmentChannel
Parse a channel from a string.
fromString(String) - Static method in enum class com.vonage.client.verify2.VerificationStatus
 
fromString(String) - Static method in enum class com.vonage.client.video.ArchiveStatus
 
fromString(String) - Static method in enum class com.vonage.client.video.BroadcastStatus
 
fromString(String) - Static method in enum class com.vonage.client.video.Language
 
fromString(String) - Static method in enum class com.vonage.client.video.OutputMode
 
fromString(String) - Static method in enum class com.vonage.client.video.ProjectEnvironment
 
fromString(String) - Static method in enum class com.vonage.client.video.ProjectStatus
 
fromString(String) - Static method in enum class com.vonage.client.video.RenderStatus
 
fromString(String) - Static method in enum class com.vonage.client.video.Resolution
 
fromString(String) - Static method in enum class com.vonage.client.video.RtmpStatus
 
fromString(String) - Static method in enum class com.vonage.client.video.ScreenLayoutType
 
fromString(String) - Static method in enum class com.vonage.client.video.StreamMode
 
fromString(String) - Static method in enum class com.vonage.client.video.VideoType
 
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.CallStatusDetail
 
fromString(String) - Static method in enum class com.vonage.client.voice.EndpointType
 
fromString(String) - Static method in enum class com.vonage.client.voice.MachineDetection
 
fromString(String) - Static method in enum class com.vonage.client.voice.MachineDetectionStatus
 
fromString(String) - Static method in enum class com.vonage.client.voice.ModifyCallAction
 
fromString(String) - Static method in enum class com.vonage.client.voice.ncco.InputMode
 
fromString(String) - Static method in enum class com.vonage.client.voice.ncco.RecordingFormat
 
fromString(String) - Static method in enum class com.vonage.client.voice.SipHeader
Converts a SIP header string to a known enum.
fromString(String) - Static method in enum class com.vonage.client.voice.SpeechTimeoutReason
 
FrontendAuthRequest - Class in com.vonage.client.auth.camara
Front-End auth request parameters for the first step in an OAuth2 three-legged check workflow.
FrontendAuthRequest(String, URI, UUID, String) - Constructor for class com.vonage.client.auth.camara.FrontendAuthRequest
Creates the parameters for a Front-End Authorization OIDC request.

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
 
generateToken(String) - Method in class com.vonage.client.video.VideoClient
Generates a signed JSON Web Token which can be passed to the client, using the default token options.
generateToken(String, TokenOptions) - Method in class com.vonage.client.video.VideoClient
Generates a signed JSON Web Token which can be passed to the client.
GenericEvent - Class in com.vonage.client.conversations
 
GenericEvent.Builder<E,B> - Class in com.vonage.client.conversations
 
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
 
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
 
getAccessToken() - Method in class com.vonage.client.auth.camara.TokenResponse
 
getAccountClient() - Method in class com.vonage.client.VonageClient
Returns the Account API client.
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.messages.whatsapp.Reaction
The action to take.
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.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
Deprecated.
The webhook's URL.
getAddress() - Method in class com.vonage.client.conversations.Location
Full location address.
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
 
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.ApiKeyQueryParamsAuthMethod
 
getApiKey() - Method in class com.vonage.client.auth.SignatureAuthMethod
 
getApiKey() - Method in interface com.vonage.client.auth.ApiKeyAuthMethod
 
getApiKey() - Method in class com.vonage.client.auth.ApiKeyHeaderAuthMethod
 
getApiKey() - Method in class com.vonage.client.HttpWrapper
Returns the API key if it was set when creating the client.
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.
getAppId() - Method in class com.vonage.client.numbers.OwnedNumber
ID of the application linked to this number, if applicable.
getApplication(String) - Method in class com.vonage.client.application.ApplicationClient
Retrieve an application.
getApplicationClient() - Method in class com.vonage.client.VonageClient
Returns the Application API client.
getApplicationId() - Method in class com.vonage.client.auth.JWTAuthMethod
 
getApplicationId() - Method in class com.vonage.client.conversations.Callback.Params
Vonage Application ID.
getApplicationId() - Method in class com.vonage.client.HttpWrapper
Returns the application ID if it was set when creating the client.
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.
getApplicationId() - Method in class com.vonage.client.numbers.ListNumbersFilter
Application to return the numbers for.
getApplicationId() - Method in class com.vonage.client.numbers.UpdateNumberRequest
ID of the application that will handle inbound traffic to this number.
getApplicationId() - Method in class com.vonage.client.video.CreateSessionResponse
 
getApplicationId() - Method in class com.vonage.client.video.ProjectDetails
 
getApplicationId() - Method in class com.vonage.client.video.RenderResponse
Vonage Application ID.
getApplicationId() - Method in class com.vonage.client.video.StreamComposition
Vonage video application ID (as used to create the client).
getApplications() - Method in class com.vonage.client.application.ApplicationList
Retrieves the embedded resource contents.
getArchive(String) - Method in class com.vonage.client.video.VideoClient
Retrieve information about a specific archive.
getArchiveMode() - Method in class com.vonage.client.video.CreateSessionRequest
Defines whether the session will be automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL).
getAttributes() - Method in class com.vonage.client.proactiveconnect.ContactsList
The list attributes.
getAudio() - Method in class com.vonage.client.conversations.MemberMedia
Whether the media has audio.
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
 
getAudioRate() - Method in enum class com.vonage.client.video.Websocket.AudioRate
Converts the enum to an integer value representing the bitrate (Hz).
getAudioRate() - Method in class com.vonage.client.video.Websocket
Audio sampling rate in Hz.
getAudioSettings() - Method in class com.vonage.client.conversations.MemberMedia
Audio-related properties.
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
Gets the authentication settings used by the client.
getAuthMethod() - Method in class com.vonage.client.AbstractMethod
Gets the highest priority available authentication method according to its sort key.
getAuthParams(RequestQueryParams) - Method in class com.vonage.client.auth.ApiKeyQueryParamsAuthMethod
 
getAuthParams(RequestQueryParams) - Method in interface com.vonage.client.auth.QueryParamsAuthMethod
Gets the auth parameters to be included in the query string.
getAuthParams(RequestQueryParams) - Method in class com.vonage.client.auth.SignatureAuthMethod
 
getAuthReqId() - Method in class com.vonage.client.auth.camara.BackendAuthResponse
ID of the authentication request.
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.
getBasicToken() - Method in class com.vonage.client.auth.ApiKeyHeaderAuthMethod
 
getBasicToken() - Method in class com.vonage.client.auth.BasicAuthMethod
 
getBearerToken() - Method in class com.vonage.client.auth.BearerAuthMethod
 
getBearerToken() - Method in class com.vonage.client.auth.camara.NetworkAuthMethod
 
getBearerToken() - Method in class com.vonage.client.auth.JWTAuthMethod
 
getBeepStart() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether to enable beep start.
getBeepStart() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getBeepStop() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether to enable beep stop.
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
Deprecated.
 
getBody() - Method in class com.vonage.client.conversations.GenericEvent
Custom event data as key-value pairs.
getBody() - Method in class com.vonage.client.messages.whatsapp.Referral
Body text of the referring advertisement or post.
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.
getBroadcast(String) - Method in class com.vonage.client.video.VideoClient
Get Information about a Broadcast that is in progress.
getBroadcastUrls() - Method in class com.vonage.client.video.Broadcast
Details on the HLS and RTMP broadcast streams.
getBucket() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
Bucket name to upload to.
getButton() - Method in class com.vonage.client.messages.InboundMessage
getCallback() - Method in class com.vonage.client.conversations.Conversation
Specifies callback parameters for webhooks.
getCallback() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
getCallbackUrl() - Method in class com.vonage.client.sms.messages.Message
 
getCallbackUrl() - Method in class com.vonage.client.video.RenderResponse
Callback URL for Experience Composer events (if one was set).
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
Deprecated.
 
getCallUuid() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getCallUuid() - Method in class com.vonage.client.voice.EventWebhook
Unique identifier for the call event.
getCamaraBaseUri() - Method in class com.vonage.client.camara.NetworkApiClient
 
getCamaraToken(TokenRequest) - Method in class com.vonage.client.auth.camara.NetworkAuthClient
Obtains a new access token for a Back-End auth request.
getCanHear() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getCanSpeak() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
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
 
getCaptionsId() - Method in class com.vonage.client.video.CaptionsResponse
Unique identifier for the audio captioning session.
getCarrier() - Method in class com.vonage.client.numberinsight2.Phone
Name of the network carrier, if Insight.FRAUD_SCORE was requested.
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.conversations.Member
Channel details for this membership.
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.TemplateFragment
Channel type for the template.
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.conversations.AudioRecordEvent
Number of channels for the recording.
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).
getClickId() - Method in class com.vonage.client.messages.whatsapp.Referral
The click ID of the advertisement or post.
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
 
getClientVersion() - Method in class com.vonage.client.HttpWrapper
Gets the SDK version.
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
Two-letter country code.
getCode() - Method in class com.vonage.client.account.Network
Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.
getCode() - Method in class com.vonage.client.conversations.UpdateMemberRequest
Reason code for leaving.
getCode() - Method in enum class com.vonage.client.insight.LookupOutcome
 
getCode() - Method in class com.vonage.client.verify.CheckRequest
Deprecated.
PIN code entered by the user.
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 class 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.verify.ControlRequest
 
getCommand() - Method in class com.vonage.client.verify.ControlResponse
 
getConcat() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getConcat() - Method in class com.vonage.client.sms.MessageEvent
Whether the message exceeded the maximum-permitted length of a single message.
getConcatPart() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getConcatPart() - Method in class com.vonage.client.sms.MessageEvent
The number of this part in the message.
getConcatPartNumber() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
getConcatRef() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getConcatRef() - Method in class com.vonage.client.sms.MessageEvent
The transaction reference.
getConcatReferenceNumber() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
getConcatTotal() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getConcatTotal() - Method in class com.vonage.client.sms.MessageEvent
The number of parts in this concatenated message.
getConcatTotalParts() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
getConcreteClass(ChannelType) - Static method in class com.vonage.client.users.channels.Channel
Finds the corresponding subclass of Channel based on the enum's value.
getConfidence() - Method in class com.vonage.client.incoming.Result
Deprecated.
This will be converted to a Double in a future release.
getConfidence() - Method in class com.vonage.client.voice.SpeechTranscript
The confidence estimate between 0.0 and 1.0.
getConnectionId() - Method in class com.vonage.client.video.ConnectResponse
The connection ID for the Audio Connector WebSocket connection in the Vonage Video session.
getConnectionId() - Method in class com.vonage.client.video.SipDialResponse
The video connection ID for the SIP call's connection in the video session.
getConnectionTimeout() - Method in class com.vonage.client.common.Webhook
Deprecated.
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.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.MMS, returns a list of one or more objects representing image, audio, video, vCard, or file attachments.
getContentId() - Method in class com.vonage.client.messages.sms.OutboundSettings
 
getContentId() - Method in class com.vonage.client.sms.messages.Message
 
getContentId() - Method in class com.vonage.client.verify2.SmsWorkflow
Optional value corresponding to a TemplateID for SMS delivery using Indian Carriers.
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.messages.whatsapp.WhatsappRequest
 
getContext() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getConversation() - Method in class com.vonage.client.conversations.ConversationUpdatedEvent
Basic details of the updated conversation.
getConversation(String) - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve a conversation by its ID.
getConversationId() - Method in class com.vonage.client.conversations.Member
Unique identifier for this member's conversation.
getConversationId() - Method in class com.vonage.client.conversations.UpdateMemberRequest
Unique Conversation identifier.
getConversations() - Method in class com.vonage.client.conversations.ListConversationsResponse
Gets the conversations contained in the _embedded response.
getConversations() - Method in class com.vonage.client.conversations.ListUserConversationsResponse
Gets the conversations contained in the _embedded response.
getConversationsClient() - Method in class com.vonage.client.VonageClient
Returns the Conversations v1 client.
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. 0 means infinite.
getConversationUuid() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getConversationUuid() - Method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
getConversationUuid() - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
getConversationUuid() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
getConversationUuid() - Method in class com.vonage.client.voice.AnswerWebhook
Unique identifier for this conversation.
getConversationUuid() - Method in class com.vonage.client.voice.CallEvent
The unique identifier for the conversation this call leg is part of.
getConversationUuid() - Method in class com.vonage.client.voice.CallInfo
 
getConversationUuid() - Method in class com.vonage.client.voice.CallsFilter
 
getConversationUuid() - Method in class com.vonage.client.voice.EventWebhook
Unique identifier for the conversation.
getConversationUuidFrom() - Method in class com.vonage.client.voice.EventWebhook
Conversation ID that the leg was originally in.
getConversationUuidTo() - Method in class com.vonage.client.voice.EventWebhook
Conversation ID that the leg was transferred to.
getConversionClient() - Method in class com.vonage.client.VonageClient
Returns the Conversion API client.
getCost() - Method in class com.vonage.client.numbers.AvailableNumber
The monthly rental cost for this number, in Euros.
getCount() - Method in class com.vonage.client.account.PrefixPricingResponse
Deprecated.
 
getCount() - Method in class com.vonage.client.numbers.ListNumbersResponse
Total amount of numbers owned by the account.
getCount() - Method in class com.vonage.client.numbers.SearchNumbersResponse
Total amount of numbers available in the pool.
getCount() - Method in class com.vonage.client.video.ListStreamCompositionsRequest
The number of compositions to retrieve starting at offset.
getCount() - Method in class com.vonage.client.voice.CallInfoPage
 
getCountries() - Method in class com.vonage.client.account.PrefixPricingResponse
Deprecated.
 
getCountry() - Method in class com.vonage.client.account.PricingResponse
Details of the country this pricing information is for.
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.UpdateNumberRequest
Two character country code in ISO 3166-1 alpha-2 format.
getCountry() - Method in class com.vonage.client.numbers.ListNumbersFilter
Two character country code in ISO 3166-1 alpha-2 format.
getCountry() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Two character country code in ISO 3166-1 alpha-2 format.
getCountry() - Method in class com.vonage.client.numbers.AvailableNumber
Two character country code in ISO 3166-1 alpha-2 format.
getCountry() - Method in class com.vonage.client.numbers.OwnedNumber
Two character country code in ISO 3166-1 alpha-2 format.
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
Time the secret was created.
getCreated() - Method in class com.vonage.client.conversations.ConversationTimestamp
Time that the conversation was created.
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.
getCreatedAt() - Method in class com.vonage.client.video.ProjectDetails
 
getCreatedAt() - Method in class com.vonage.client.video.RenderResponse
The time the Experience Composer started, expressed in milliseconds since the Unix epoch.
getCreatedAt() - Method in class com.vonage.client.video.StreamComposition
The time at which this composition was started or created.
getCreatedAtMillis() - Method in class com.vonage.client.video.StreamComposition
The time at which this composition was started or created, in milliseconds since the Unix epoch.
getCreateDt() - Method in class com.vonage.client.video.CreateSessionResponse
 
getCreditLimit() - Method in class com.vonage.client.subaccounts.Account
Credit limit of the subaccount.
getCurrency() - Method in class com.vonage.client.account.Network
Currency code for the network price.
getCurrency() - Method in class com.vonage.client.account.PricingResponse
Currency that your account is being billed in (EUR by default).
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
 
getCurrentCarrier() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getCursor() - Method in class com.vonage.client.common.HalFilterRequest
The cursor to start returning results from.
getCursor() - Method in class com.vonage.client.conversations.ListConversationsRequest
 
getCursor() - Method in class com.vonage.client.conversations.ListEventsRequest
 
getCursor() - Method in class com.vonage.client.conversations.ListMembersRequest
 
getCursor() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
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.MessageRequest
 
getCustom() - Method in class com.vonage.client.messages.rcs.RcsCustomRequest
 
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.conversations.ConversationProperties
Custom key-value pairs to be included with conversation data.
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.voice.AnswerWebhook
A custom data map, optionally passed as parameter on the callServer method when a call is initiated from an application using the Client SDK.
getCustomSortKey() - Method in class com.vonage.client.conversations.ConversationProperties
Custom sort key.
getCustomUserAgent() - Method in class com.vonage.client.HttpConfig
Returns the custom user agent string that will be appended to the default one, if set.
getDashedLocale() - Method in class com.vonage.client.verify.BaseRequest
 
getData() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
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.
getData() - Method in class com.vonage.client.sms.MessageEvent
The binary content of this message.
getData() - Method in class com.vonage.client.video.SignalRequest
 
getData() - Method in class com.vonage.client.video.TokenOptions
Returns the connection metadata assigned to the token.
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
 
getDateCreated() - Method in class com.vonage.client.verify2.TemplateFragment
Timestamp of when the template fragment was created.
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
 
getDateUpdated() - Method in class com.vonage.client.verify2.TemplateFragment
Timestamp of when the template fragment was last updated.
getDefaultPrice() - Method in class com.vonage.client.account.PricingResponse
Default price for the country.
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
Deprecated.
 
getDeliveryReceiptUrl() - Method in class com.vonage.client.account.SettingsResponse
URL where Vonage will send a webhook when a delivery receipt is received when a number-specific URL is not configured.
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
Deprecated.
 
getDestinationNetworkCode() - Method in class com.vonage.client.messages.MessageStatus
If MessageStatus.getChannel() is Channel.SMS or Channel.MMS, returns the network code for the destination.
getDestroyed() - Method in class com.vonage.client.conversations.ConversationTimestamp
Time that the conversation was destroyed.
getDetail() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getDetail() - Method in class com.vonage.client.messages.MessageStatus.Error
Text describing the error.
getDetail() - Method in class com.vonage.client.voice.EventWebhook
Provides a more specific status to accompany EventWebhook.getStatus().
getDetail() - Method in exception class com.vonage.client.VonageApiResponseException
Extended description of the error, explaining the cause.
getDetailEnum() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getDetails() - Method in class com.vonage.client.proactiveconnect.SyncStatus
Details on the sync status.
getDetectSpeech() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether to detect speech in the recording.
getDialingPrefix() - Method in class com.vonage.client.account.PricingResponse
Dialing prefix for the country.
getDigits() - Method in class com.vonage.client.incoming.DtmfResult
Deprecated.
The button sequence pressed by the user.
getDigits() - Method in class com.vonage.client.voice.DtmfResult
The button sequence pressed by the user.
getDirection() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getDirection() - Method in class com.vonage.client.voice.CallEvent
Whether the call is inbound or outbound.
getDirection() - Method in class com.vonage.client.voice.CallInfo
 
getDirection() - Method in class com.vonage.client.voice.EventWebhook
Call direction, can be either inbound or outbound.
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
Readable alternate country name.
getDisplayName() - Method in class com.vonage.client.conversations.BaseConversation
The public facing name of the conversation.
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
Deprecated.
 
getDtmf() - Method in class com.vonage.client.voice.EventWebhook
DTMF capturing results.
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.video.Archive
The duration of the recording (precision in seconds).
getDuration() - Method in class com.vonage.client.voice.CallInfo
 
getDuration() - Method in class com.vonage.client.voice.EventWebhook
Call length, in seconds.
getDurationSeconds() - Method in class com.vonage.client.video.Archive
The duration of the recording, in seconds.
getE2ee() - Method in class com.vonage.client.video.CreateSessionRequest
Defines whether the session will be end-to-end encrypted.
getEarmuffed() - Method in class com.vonage.client.conversations.MediaAudioSettings
Whether hearing audio is disabled.
getEmbedded() - Method in class com.vonage.client.voice.CallInfoPage
 
getEmoji() - Method in class com.vonage.client.messages.whatsapp.Reaction
The emoji used as a reaction.
getEnabled() - Method in class com.vonage.client.conversations.MediaAudioSettings
Whether audio is enabled.
getEncodingType() - Method in class com.vonage.client.messages.sms.OutboundSettings
 
getEndDate() - Method in class com.vonage.client.common.HalFilterRequest
Filter records that occurred before this point in time.
getEndDate() - Method in class com.vonage.client.conversations.ListConversationsRequest
 
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.
getEndId() - Method in class com.vonage.client.conversations.ListEventsRequest
The ID to stop returning events at.
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
 
getEndpointType() - Method in class com.vonage.client.voice.AnswerWebhook
The type of endpoint that answered the call.
getEndTime() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
getEndTime() - Method in class com.vonage.client.voice.CallInfo
 
getEndTime() - Method in class com.vonage.client.voice.EventWebhook
End time in ISO 8601 format.
getEntityId() - Method in class com.vonage.client.messages.sms.OutboundSettings
 
getEntityId() - Method in class com.vonage.client.sms.messages.Message
 
getEntityId() - Method in class com.vonage.client.verify2.SmsWorkflow
Optional PEID required for SMS delivery using Indian Carriers.
getEnvironment() - Method in class com.vonage.client.video.ProjectDetails
 
getError() - Method in class com.vonage.client.incoming.SpeechResults
Deprecated.
Error message.
getError() - Method in class com.vonage.client.messages.MessageStatus
If the message encountered a problem a descriptive error will be supplied in this object.
getError() - Method in class com.vonage.client.voice.SpeechResults
Error message.
getErrorCodeLabel() - Method in exception class com.vonage.client.VonageApiResponseException
The status code description.
getErrors() - Method in exception class 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.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 class 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.
getEvent(String, int) - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve a conversation Event by its ID.
getEventId() - Method in class com.vonage.client.conversations.EventDeleteEvent
ID of the event.
getEventId() - Method in class com.vonage.client.conversations.MessageDeliveredEvent
ID of the event.
getEventId() - Method in class com.vonage.client.conversations.MessageRejectedEvent
ID of the event.
getEventId() - Method in class com.vonage.client.conversations.MessageSeenEvent
ID of the event.
getEventId() - Method in class com.vonage.client.conversations.MessageSubmittedEvent
ID of the event.
getEventId() - Method in class com.vonage.client.conversations.MessageUndeliverableEvent
ID of the event.
getEventId() - Method in class com.vonage.client.verify.CheckResponse
 
getEventMask() - Method in class com.vonage.client.conversations.Callback
 
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
 
getEventMethod() - Method in class com.vonage.client.voice.ncco.TranscriptionSettings
The HTTP method Vonage uses to make the request to TranscriptionSettings.getEventUrl().
getEvents() - Method in class com.vonage.client.conversations.ListEventsResponse
Gets the events contained in the _embedded response.
getEventType() - Method in class com.vonage.client.conversations.ListEventsRequest
The type of event to search for.
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.RecordAction
 
getEventUrl() - Method in class com.vonage.client.voice.ncco.TranscriptionSettings
The URL to the webhook endpoint that is called asynchronously when a transcription is finished.
getExcludeDeletedEvents() - Method in class com.vonage.client.conversations.ListEventsRequest
Whether to exclude deleted events from the results.
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.
getExpiresIn() - Method in class com.vonage.client.auth.camara.BackendAuthResponse
Number of seconds until the authentication code expires.
getExpiresIn() - Method in class com.vonage.client.auth.camara.TokenResponse
 
getExpiryLength() - Method in class com.vonage.client.video.TokenOptions
Returns the time-to-live for the JWT.
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
Capabilities of the number as an array of strings.
getFeatures() - Method in class com.vonage.client.numbers.OwnedNumber
Capabilities of the number as an array of strings.
getFeatures() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Desired capabilities as an array of strings.
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.rcs.RcsFileRequest
 
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
Deprecated.
 
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.conversations.AudioRecordEvent
File format for the recording.
getFormat() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getFragmentId() - Method in class com.vonage.client.verify2.TemplateFragment
Unique fragment identifier.
getFraudCheck() - Method in class com.vonage.client.verify2.VerificationRequest
Determines if the network level fraud check is enforced.
getFraudScore() - Method in class com.vonage.client.numberinsight2.FraudCheckResponse
Result of the fraud score insight operation.
getFrom() - Method in class com.vonage.client.conversations.Event
Member ID this event was sent from.
getFrom() - Method in class com.vonage.client.conversations.Member
TODO document this
getFrom() - Method in class com.vonage.client.conversations.MemberChannel
Sender channel.
getFrom() - Method in class com.vonage.client.conversations.UpdateMemberRequest
TODO document this.
getFrom() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getFrom() - Method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
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.MoneyTransfer
Account to transfer from.
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.WhatsappCodelessWorkflow
The number to send the verification request from.
getFrom() - Method in class com.vonage.client.verify2.WhatsappWorkflow
The number to send the verification request from.
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.SmsWorkflow
The number or sender ID the message will be sent from.
getFrom() - Method in class com.vonage.client.video.SipDialRequest
 
getFrom() - Method in class com.vonage.client.voice.AnswerWebhook
The number or user that made the call.
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.EventWebhook
Number the call came from, in E.164 format.
getFrom() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getFromMember() - Method in class com.vonage.client.conversations.Event
Member that initiated the event.
getFromRandomNumber() - Method in class com.vonage.client.voice.Call
 
getFromUser() - Method in class com.vonage.client.conversations.Event
Details about the user that initiated the event.
getGuestUrl() - Method in class com.vonage.client.meetings.RoomLinks
 
getHandsetStatus() - Method in class com.vonage.client.insight.RealTimeData
 
getHasApplication() - Method in class com.vonage.client.numbers.ListNumbersFilter
Whether results should be filtered to numbers assigned to an application.
getHeaders() - Method in class com.vonage.client.users.channels.Websocket
Custom properties to add to the header.
getHeaders() - Method in class com.vonage.client.video.SipDialRequest
 
getHeaders() - Method in class com.vonage.client.video.Websocket
Headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.
getHeaders() - Method in class com.vonage.client.voice.ncco.SipEndpoint
Defines custom headers to be sent as part of the SIP INVITE request.
getHeaders() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
getHeaders() - Method in class com.vonage.client.voice.SipEndpoint
Defines custom headers to be sent as part of the SIP INVITE request.
getHeadersMap() - Method in class com.vonage.client.voice.WebSocketEndpoint
 
getHeaderValue() - Method in class com.vonage.client.auth.BasicAuthMethod
 
getHeaderValue() - Method in class com.vonage.client.auth.BearerAuthMethod
 
getHeaderValue() - Method in interface com.vonage.client.auth.HeaderAuthMethod
 
getHeadline() - Method in class com.vonage.client.messages.whatsapp.Referral
Headline text of the referring advertisement or post.
getHls() - Method in class com.vonage.client.video.BroadcastUrls
If you specified an HLS endpoint, the object includes an HLS property, which is set to the URL for the HLS broadcast.
getHlsSettings() - Method in class com.vonage.client.video.Broadcast
 
getHostUrl() - Method in class com.vonage.client.meetings.RoomLinks
 
getHref() - Method in class com.vonage.client.common.UrlContainer
href property of the link.
getHref() - Method in class com.vonage.client.voice.PageLink
 
getHttpClient() - Method in class com.vonage.client.HttpWrapper
Gets the underlying HttpClient instance used by the SDK.
getHttpConfig() - Method in class com.vonage.client.HttpWrapper
Gets the HTTP configuration settings for the client.
getHttpWrapper() - Method in class com.vonage.client.AbstractMethod
 
getId() - Method in class com.vonage.client.account.SecretResponse
ID of the secret.
getId() - Method in class com.vonage.client.application.Application
Unique application ID.
getId() - Method in class com.vonage.client.conversations.BaseConversation
Unique identifier for this conversation.
getId() - Method in class com.vonage.client.conversations.BaseMember
Unique member identifier.
getId() - Method in class com.vonage.client.conversations.Event
Event 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
 
getId() - Method in class com.vonage.client.verify2.Template
Unique template identifier.
getId() - Method in class com.vonage.client.video.ConnectResponse
A unique identifier for the Audio Connector WebSocket connection.
getId() - Method in class com.vonage.client.video.RenderResponse
Unique identifier for the Experience Composer.
getId() - Method in class com.vonage.client.video.Rtmp
 
getId() - Method in class com.vonage.client.video.SessionStream
 
getId() - Method in class com.vonage.client.video.SipDialResponse
A unique ID for the SIP call.
getId() - Method in class com.vonage.client.video.StreamComposition
Unique ID of the composition.
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.rcs.RcsImageRequest
 
getImage() - Method in class com.vonage.client.messages.viber.ViberImageRequest
 
getImage() - Method in class com.vonage.client.messages.whatsapp.WhatsappImageRequest
 
getImageCaption() - Method in class com.vonage.client.messages.InboundMessage
Additional text accompanying the image.
getImageUrl() - Method in class com.vonage.client.conversations.BaseConversation
An image URL that you associate with the conversation.
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.messages.whatsapp.Referral
URL of the image shown in the advertisement or post.
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.
getIncludeCustomData() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
Whether to include custom data in the responses.
getIncomingSmsUrl() - Method in class com.vonage.client.account.SettingsRequest
Deprecated.
 
getIncomingSmsUrl() - Method in class com.vonage.client.account.SettingsResponse
URL where Vonage will send a webhook when an incoming SMS is received when a number-specific URL is not configured.
getIndex() - Method in class com.vonage.client.numbers.ListNumbersFilter
Page index to start return results from.
getIndex() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Page index to start return results from.
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.
getInitialLayoutClassList() - Method in class com.vonage.client.video.TokenOptions
Returns the initial layout class list for streams published by the client using this token.
getInitiatedAt() - Method in class com.vonage.client.verify2.WorkflowStatus
Date and time this workflow was initiated.
getInitiator() - Method in class com.vonage.client.conversations.Member
Describes how this member was initiated.
getInserted() - Method in class com.vonage.client.proactiveconnect.UploadListItemsResponse
Items inserted in the list.
getInsightClient() - Method in class com.vonage.client.VonageClient
Returns the Number Insight API client.
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 class 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
 
getInterval() - Method in class com.vonage.client.auth.camara.BackendAuthResponse
Number of seconds until the next request should be made.
getInvalidParameters() - Method in exception class 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.
getInvited() - Method in class com.vonage.client.conversations.MemberTimestamp
Time that the member was invited.
getInvitedBy() - Method in class com.vonage.client.conversations.Member
Unique member ID this member was invited by.
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.
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.
getJoined() - Method in class com.vonage.client.conversations.MemberTimestamp
Time that the member joined.
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
Deprecated.
 
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
Deprecated.
 
getKeyword() - Method in class com.vonage.client.sms.MessageEvent
The first word in the message body.
getKnockingId() - Method in class com.vonage.client.conversations.Member
Unique knocking identifier.
getLabel() - Method in class com.vonage.client.numberinsight2.FraudScore
Mapping of risk score to a verbose description.
getLanguage() - Method in class com.vonage.client.conversations.AudioRecordEvent
Text-to-speech transcription language.
getLanguage() - Method in class com.vonage.client.conversations.AudioSayEvent
Language for the spoken text.
getLanguage() - Method in class com.vonage.client.meetings.UISettings
Language setting.
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.ncco.TranscriptionSettings
Language for the recording transcription.
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
 
getLanguageCode() - Method in class com.vonage.client.video.CaptionsRequest
Spoken language used on this call in BCP-47 format.
getLast() - Method in class com.vonage.client.voice.PageLinks
Deprecated.
 
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.conversations.Location
Latitude of the location.
getLatitude() - Method in class com.vonage.client.messages.whatsapp.Location
 
getLayout() - Method in class com.vonage.client.video.StreamComposition
Describes how the streams in this composition are displayed.
getLayoutClassList() - Method in class com.vonage.client.video.SessionStream
 
getLeft() - Method in class com.vonage.client.conversations.MemberTimestamp
Time that the member left.
getLegPersistenceTime() - Method in class com.vonage.client.application.capabilities.Voice
Persistence duration for conversation legs, in days.
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.conversations.AudioPlayEvent
Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.
getLevel() - Method in class com.vonage.client.conversations.AudioSayEvent
Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.
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
Deprecated.
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
Deprecated.
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.TemplateFragment
Template Locale in IETF BCP 47 format.
getLocale() - Method in class com.vonage.client.verify2.VerificationRequest
Language for the request in ISO_639-1 format.
getLocaleAsString() - Method in class com.vonage.client.verify2.VerificationRequest
 
getLocation() - Method in class com.vonage.client.conversations.MessageEvent
getLocation() - Method in class com.vonage.client.video.CreateSessionRequest
The location hint IP address.
getLogoType() - Method in class com.vonage.client.meetings.LogoUploadsUrlResponse.Fields
Logo's type.
getLongitude() - Method in class com.vonage.client.conversations.Location
Longitude of the location.
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.conversations.AudioPlayEvent
Number of times to repeat the audio.
getLoop() - Method in class com.vonage.client.conversations.AudioSayEvent
Number of times to repeat the audio.
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
 
getMachineDetectionSubstate() - Method in class com.vonage.client.voice.EventWebhook
Advanced machine detection status, when call is answered by voicemail and the beep is detected.
getMainColor() - Method in class com.vonage.client.meetings.Theme
Main colour hex code.
getMaxApiCallsPerSecond() - Method in class com.vonage.client.account.SettingsResponse
Maximum number of API calls per second for the account.
getMaxBitrate() - Method in class com.vonage.client.video.StreamComposition
The maximum bitrate for the stream in bits per second (if one was set).
getMaxDigits() - Method in class com.vonage.client.voice.ncco.DtmfSettings
The number of digits the user can press.
getMaxDuration() - Method in class com.vonage.client.video.Broadcast
The maximum duration for the broadcast (if one was set).
getMaxDuration() - Method in class com.vonage.client.video.CaptionsRequest
The maximum duration for the audio captioning, in seconds.
getMaxDuration() - Method in class com.vonage.client.video.RenderRequest
Maximum time allowed for the Experience Composer, in seconds.
getMaxDuration() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getMaxDurationSeconds() - Method in class com.vonage.client.video.Broadcast
The maximum duration for the broadcast (if one was set), in seconds.
getMaxInboundMessagesPerSecond() - Method in class com.vonage.client.account.SettingsResponse
Maximum number of inbound messages per second for the account.
getMaxOutboundMessagesPerSecond() - Method in class com.vonage.client.account.SettingsResponse
Maximum number of outbound messages per second for the account.
getMcc() - Method in class com.vonage.client.account.Network
Mobile Country Code of the operator.
getMedia() - Method in class com.vonage.client.conversations.Member
Media settings for this member.
getMediaMode() - Method in class com.vonage.client.video.CreateSessionRequest
Defines whether the session will transmit streams using the Vonage Media Server or attempt to transmit streams directly between clients.
getMediaServerUrl() - Method in class com.vonage.client.video.CreateSessionResponse
 
getMediaType() - Method in class com.vonage.client.messages.whatsapp.Referral
The type of media shown in the advertisement or post.
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
Deprecated.
Support for this API will be removed in the next major release.
getMember() - Method in class com.vonage.client.conversations.UserConversation
Basic metadata about the conversation membership.
getMember(String, String) - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve a conversation Member by its ID.
getMemberId() - Method in class com.vonage.client.conversations.MemberInitiator
If MemberInitiator.invitedByAdmin() is false, returns the ID of the inviting member.
getMemberId() - Method in class com.vonage.client.conversations.UpdateMemberRequest
Unique Member identifier.
getMemberIdInviting() - Method in class com.vonage.client.conversations.Member
Unique member ID this member was invited by.
getMembers() - Method in class com.vonage.client.conversations.ListMembersResponse
Gets the members contained in the _embedded response.
getMessage() - Method in exception class com.vonage.client.auth.VonageUnacceptableAuthException
 
getMessage() - Method in exception class com.vonage.client.meetings.MeetingsResponseException
 
getMessage() - Method in class com.vonage.client.voice.DtmfResponse
 
getMessage() - Method in class com.vonage.client.voice.StreamResponse
 
getMessage() - Method in class com.vonage.client.voice.TalkResponse
 
getMessage() - Method in exception class com.vonage.client.VonageApiResponseException
 
getMessageBody() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
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
Deprecated.
 
getMessageId() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getMessageId() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
getMessageId() - Method in class com.vonage.client.sms.MessageEvent
Vonage's unique identifier for this message.
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.OwnedNumber
Application ID for inbound message handling, if applicable.
getMessagesCallbackValue() - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
getMessagesClient() - Method in class com.vonage.client.VonageClient
Returns the Messages v1 API client.
getMessageSettings() - Method in class com.vonage.client.messages.sms.SmsTextRequest
 
getMessageStatus() - Method in enum class com.vonage.client.sms.MessageStatus
 
getMessageTimestamp() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getMessageTimestamp() - Method in class com.vonage.client.sms.MessageEvent
The UTC±00:00 time when Vonage started to push this inbound message to your webhook endpoint.
getMessageType() - Method in class com.vonage.client.conversations.MessageEvent
Describes the media type for this event.
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
Deprecated.
 
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
Deprecated.
The HTTP request method for this webhook.
getMethod() - Method in class com.vonage.client.conversations.Callback
Method to use for the callback, either HttpMethod.GET or HttpMethod.POST.
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
Mobile Network Code of the operator.
getMode() - Method in class com.vonage.client.voice.AdvancedMachineDetection
Detect if machine answered and sends a human or machine status in the webhook payload.
getMode() - Method in class com.vonage.client.voice.ncco.InputAction
How the input should be processed.
getMoHttpUrl() - Method in class com.vonage.client.numbers.OwnedNumber
URL of the webhook endpoint that handles inbound messages.
getMoHttpUrl() - Method in class com.vonage.client.numbers.UpdateNumberRequest
A URL-encoded URI to the webhook endpoint that handles inbound messages.
getMoSmppSysType() - Method in class com.vonage.client.numbers.UpdateNumberRequest
The associated system type for your SMPP client.
getMsisdn() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getMsisdn() - Method in class com.vonage.client.numbers.UpdateNumberRequest
Phone number in E.164 format.
getMsisdn() - Method in class com.vonage.client.numbers.AvailableNumber
Phone number in E.164 format.
getMsisdn() - Method in class com.vonage.client.numbers.OwnedNumber
Phone number in E.164 format.
getMsisdn() - Method in class com.vonage.client.sms.MessageEvent
The phone number that this inbound message was sent from.
getMultiArchiveTag() - Method in class com.vonage.client.video.Archive
Returns the multiArchiveTag if set for the Archive.
getMultiBroadcastTag() - Method in class com.vonage.client.video.Broadcast
The unique tag for simultaneous broadcasts (if one was set).
getMultitrack() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether the audio has multiple tracks.
getMusicOnHoldUrl() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getMute() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getMuted() - Method in class com.vonage.client.conversations.MediaAudioSettings
Whether producing audio is disabled.
getName() - Method in class com.vonage.client.account.Country
Country name.
getName() - Method in class com.vonage.client.account.Network
Company/organisational name of the operator.
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
Deprecated.
 
getName() - Method in class com.vonage.client.conversations.BaseConversation
Internal conversation name.
getName() - Method in class com.vonage.client.conversations.Location
Name of the location.
getName() - Method in class com.vonage.client.insight.CallerIdentity
 
getName() - Method in class com.vonage.client.insight.CarrierDetails
 
getName() - Method in exception class com.vonage.client.meetings.MeetingsResponseException
 
getName() - Method in class com.vonage.client.messages.internal.MessagePayload
 
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.verify2.Template
Reference name for the template.
getName() - Method in class com.vonage.client.video.Archive
The name of the archive.
getName() - Method in class com.vonage.client.video.GetStreamResponse
 
getName() - Method in class com.vonage.client.video.ProjectDetails
 
getName() - Method in class com.vonage.client.video.RenderRequest.Properties
Name of the composed output stream which is published to the session.
getName() - Method in class com.vonage.client.video.RenderResponse
Name of the composed output stream which is published to the session.
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
 
getNccoUrl() - Method in class com.vonage.client.conversations.Callback.Params
Call Control Object URL to use for the callback.
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
 
getNetwork() - Method in class com.vonage.client.voice.EventWebhook
Type of network that was used in the call.
getNetworkApis() - Method in class com.vonage.client.application.Application.Capabilities
Network APIs capability.
getNetworkApplicationId() - Method in class com.vonage.client.application.capabilities.NetworkApis
Gets the network application ID (this is different from the Vonage application ID).
getNetworkCode() - Method in class com.vonage.client.insight.CarrierDetails
 
getNetworkCode() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.SMS or Channel.MMS, return the network code from which the message originated (if available).
getNetworkCode() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
getNetworks() - Method in class com.vonage.client.account.PricingResponse
List of supported networks in the country.
getNetworkType() - Method in class com.vonage.client.insight.CarrierDetails
 
getNext() - Method in class com.vonage.client.voice.PageLinks
Deprecated.
 
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
Deprecated.
 
getNonce() - Method in class com.vonage.client.sms.MessageEvent
A random string that adds an extra element of unpredictability into the signature for the request.
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.numberinsight2.Phone
Phone number used in the fraud check operation(s).
getNumber() - Method in class com.vonage.client.subaccounts.NumberTransfer
The number being transferred between accounts.
getNumber() - Method in class com.vonage.client.users.channels.Mms
Phone number for this channel.
getNumber() - Method in class com.vonage.client.users.channels.Pstn
Phone number for this channel.
getNumber() - Method in class com.vonage.client.users.channels.Sms
Phone number for this channel.
getNumber() - Method in class com.vonage.client.users.channels.Viber
Phone number for this channel.
getNumber() - Method in class com.vonage.client.users.channels.Whatsapp
Phone number for this channel.
getNumber() - Method in class com.vonage.client.users.channels.WhatsappVoice
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.
getNumberInsight2Client() - Method in class com.vonage.client.VonageClient
Returns the Fraud Detection API client.
getNumbers() - Method in class com.vonage.client.conversations.Conversation
Channels containing the contact numbers for this conversation.
getNumbers() - Method in class com.vonage.client.numbers.ListNumbersResponse
A paginated array of owned numbers and their details.
getNumbers() - Method in class com.vonage.client.numbers.SearchNumbersResponse
A paginated array of available numbers and their details.
getNumbersClient() - Method in class com.vonage.client.VonageClient
Returns the Numbers API client.
getNumberVerificationClient() - Method in class com.vonage.client.VonageClient
Returns the CAMARA Number Verification API client.
getNumMessages() - Method in class com.vonage.client.messages.sms.SmsInboundMetadata
The number of inbound SMS messages concatenated together to comprise this message.
getObserveForceMute() - Method in class com.vonage.client.video.SipDialRequest
 
getOccurredAt() - Method in class com.vonage.client.proactiveconnect.Event
Date and time the event occurred in ISO 8601 format.
getOffset() - Method in class com.vonage.client.video.ListStreamCompositionsRequest
The start offset in the list of existing compositions.
getOnAnswer() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint
 
getOrder() - Method in class com.vonage.client.common.HalFilterRequest
Order to sort the results by.
getOrder() - Method in class com.vonage.client.conversations.ListConversationsRequest
 
getOrder() - Method in class com.vonage.client.conversations.ListEventsRequest
 
getOrder() - Method in class com.vonage.client.conversations.ListMembersRequest
 
getOrder() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
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
 
getOrderBy() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
Determines how the results should be compared and ordered.
getOriginalCarrier() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getOutputMode() - Method in class com.vonage.client.video.Archive
The output mode to be generated for this archive: composed or individual.
getPage() - Method in class com.vonage.client.application.ListApplicationRequest
 
getPage() - Method in class com.vonage.client.common.HalFilterRequest
Page number to navigate to in the response.
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.HalFilterRequest
Number of results per page.
getPageSize() - Method in class com.vonage.client.common.HalPageResponse
Size of each page.
getPageSize() - Method in class com.vonage.client.conversations.ListConversationsRequest
 
getPageSize() - Method in class com.vonage.client.conversations.ListEventsRequest
 
getPageSize() - Method in class com.vonage.client.conversations.ListMembersRequest
 
getPageSize() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
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
 
getParams() - Method in class com.vonage.client.conversations.Callback
Additional parameters.
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.
getPassword() - Method in class com.vonage.client.video.SipDialRequest
 
getPattern() - Method in class com.vonage.client.numbers.ListNumbersFilter
Number pattern to narrow down the results by.
getPattern() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Number pattern to narrow down the results by.
getPayee() - Method in class com.vonage.client.verify.Psd2Request
 
getPayload() - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
getPayload() - Method in class com.vonage.client.messages.Button
Payload for the button.
getPayload() - Method in class com.vonage.client.voice.ncco.NotifyAction
 
getPhone() - Method in class com.vonage.client.numberinsight2.FraudCheckResponse
An object containing at least the phone number that was used in the fraud check.
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.
getPlayId() - Method in class com.vonage.client.conversations.AudioPlayEvent
Unique audio play identifier.
getPlayId() - Method in class com.vonage.client.conversations.AudioPlayDoneEvent
Unique audio play identifier.
getPlayId() - Method in class com.vonage.client.conversations.AudioPlayStopEvent
Unique audio play identifier.
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.conversations.AudioSayEvent
Whether to use the premium version of the text-to-speech voice.
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
Deprecated.
 
getPrevUrl() - Method in class com.vonage.client.common.HalLinks
The href property of prev.
getPrice() - Method in class com.vonage.client.account.Network
Cost to send a message or make a call to this 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
Deprecated.
 
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
 
getPrice() - Method in class com.vonage.client.voice.EventWebhook
Total cost of the call in Euros.
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.MoneyTransfer
Primary account ID for this transaction.
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
Deprecated.
This API is sunset and will be removed in the next major release.
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.
getProperties() - Method in class com.vonage.client.conversations.Conversation
Properties for this conversation.
getProperties() - Method in class com.vonage.client.video.RenderRequest
The initial configuration of Publisher properties for the composed output stream.
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.
getProxy() - Method in class com.vonage.client.HttpConfig
Returns the proxy URL to use for the underlying HTTP client configuration.
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.
getQueue() - Method in class com.vonage.client.conversations.AudioPlayEvent
Whether to queue the audio.
getQueue() - Method in class com.vonage.client.conversations.AudioSayEvent
Whether to queue the audio.
getRandomFromNumber() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getRate() - Method in class com.vonage.client.voice.CallInfo
 
getRate() - Method in class com.vonage.client.voice.EventWebhook
Cost per minute of the call, in Euros.
getReachability() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getReaction() - Method in class com.vonage.client.messages.InboundMessage
getReaction() - Method in class com.vonage.client.messages.whatsapp.WhatsappReactionRequest
 
getRealTimeData() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
getRealTimeData() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getReason() - Method in class com.vonage.client.numberinsight2.SimSwap
Reason for a sim swap error response.
getReason() - Method in class com.vonage.client.video.Archive
For archives with ArchiveStatus.STOPPED or ArchiveStatus.FAILED, this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.
getReason() - Method in class com.vonage.client.video.RenderResponse
The reason field is only available when the status is either RenderStatus.STOPPED or RenderStatus.FAILED.
getReason() - Method in class com.vonage.client.voice.EventWebhook
Information about the nature of the error.
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
 
getRecordId() - Method in class com.vonage.client.conversations.AudioRecordStopEvent
Unique recording identifier.
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
Deprecated.
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.incoming.SpeechResults
Deprecated.
Speech recording URL.
getRecordingUrl() - Method in class com.vonage.client.meetings.MeetingsEventCallback
URL of the uploaded recording.
getRecordingUrl() - Method in class com.vonage.client.voice.EventWebhook
Where to download the recording.
getRecordingUrl() - Method in class com.vonage.client.voice.SpeechResults
Speech recording URL.
getRecordingUuid() - Method in class com.vonage.client.voice.EventWebhook
Unique identifier for the 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
Returns the Redact API client.
getRedirectUri() - Method in class com.vonage.client.application.capabilities.NetworkApis
Gets the Redirect URL.
getRedirectUrl() - Method in class com.vonage.client.verify2.SilentAuthWorkflow
getReference() - Method in class com.vonage.client.subaccounts.MoneyTransfer
Reference for the transfer.
getReferredProduct() - Method in class com.vonage.client.messages.whatsapp.Context
Deprecated.
This will be moved in a future release.
getRefreshToken() - Method in class com.vonage.client.auth.camara.TokenResponse
 
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.
getRegionalBaseUri(ApiRegion) - Method in class com.vonage.client.HttpConfig
Returns the base URI for the specified region.
getRegionUrl() - Method in class com.vonage.client.voice.AnswerWebhook
Regional API endpoint which should be used to control the call with REST API; see the full list of regions.
getRemainingBalance() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getRemainingBalance() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
getRender(String) - Method in class com.vonage.client.video.VideoClient
Retrieve details on an Experience Composer.
getRequestId() - Method in class com.vonage.client.insight.BasicInsightResponse
 
getRequestId() - Method in class com.vonage.client.numberinsight2.FraudCheckResponse
Unique ID for this request for reference.
getRequestId() - Method in class com.vonage.client.verify.CheckRequest
Deprecated.
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 class com.vonage.client.verify2.VerifyCodeResponse
ID of the verify request.
getRequestId() - Method in exception class com.vonage.client.verify2.VerifyResponseException
The request ID, if the status code is 409 for a failed outbound request.
getRequestPrice() - Method in class com.vonage.client.insight.StandardInsightResponse
 
getResolution() - Method in class com.vonage.client.video.RenderRequest
Render resolution of the Experience Composer.
getResolution() - Method in class com.vonage.client.video.RenderResponse
Output resolution of the Experience Composer (either "640x480", "1280x720", "480x640", or "720x1280").
getResolution() - Method in class com.vonage.client.video.StreamComposition
The video resolution of the composition.
getRestBaseUri() - Method in class com.vonage.client.HttpConfig
 
getResults() - Method in class com.vonage.client.incoming.SpeechResults
Deprecated.
The recognised text objects.
getResults() - Method in class com.vonage.client.voice.SpeechResults
The recognised text objects.
getRingback() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.OnAnswer
 
getRingbackTone() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getRingingTimer() - Method in class com.vonage.client.voice.Call
 
getRiskRecommendation() - Method in class com.vonage.client.numberinsight2.FraudScore
Recommended action based on the risk score.
getRiskScore() - Method in class com.vonage.client.numberinsight2.FraudScore
Score derived from evaluating fraud-related data associated with the phone number.
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
 
getRole() - Method in class com.vonage.client.video.TokenOptions
Returns the role assigned to the token.
getRoom(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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.
getRtcId() - Method in class com.vonage.client.conversations.AudioEarmuffOffEvent
Unique audio RTC identifier.
getRtcId() - Method in class com.vonage.client.conversations.AudioEarmuffOnEvent
Unique audio RTC identifier.
getRtcId() - Method in class com.vonage.client.conversations.AudioMuteOffEvent
Unique audio RTC identifier.
getRtcId() - Method in class com.vonage.client.conversations.AudioMuteOnEvent
Unique audio RTC identifier.
getRtmps() - Method in class com.vonage.client.video.BroadcastUrls
If you specified RTMP stream endpoints, this property will be non-null.
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.
getSaveAudio() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getSayId() - Method in class com.vonage.client.conversations.AudioSayEvent
Unique audio say identifier.
getSayId() - Method in class com.vonage.client.conversations.AudioSayDoneEvent
Unique audio say identifier.
getSayId() - Method in class com.vonage.client.conversations.AudioSayStopEvent
Unique audio say identifier.
getScreenshareType() - Method in class com.vonage.client.video.StreamCompositionLayout
 
getSearchPattern() - Method in class com.vonage.client.numbers.ListNumbersFilter
Strategy to use for matching.
getSearchPattern() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Strategy to use for matching.
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
Gets the secrets contained in the _embedded resource.
getSecure() - Method in class com.vonage.client.video.SipDialRequest
 
getSelf() - Method in class com.vonage.client.voice.PageLinks
Deprecated.
 
getSelfUrl() - Method in class com.vonage.client.common.HalLinks
The href property of self.
getSelfUrl() - Method in class com.vonage.client.messages.InboundMessage
The URL for the message resource, including the geo-specific base URI.
getSender() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
getSenderId() - Method in class com.vonage.client.verify.VerifyDetails
 
getSensitivity() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getSentimentAnalysis() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether sentiment analysis is enabled.
getSentimentAnalysis() - Method in class com.vonage.client.voice.ncco.TranscriptionSettings
Perform sentiment analysis on the call recording transcription segments.
getSequenceNumber() - Method in class com.vonage.client.conversations.Conversation
The last Event ID in this conversation.
getServerUrl() - Method in class com.vonage.client.video.Rtmp
 
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
Deprecated.
 
getSessionId() - Method in class com.vonage.client.video.CaptionsRequest
Unique identifier of the Vonage Video session.
getSessionId() - Method in class com.vonage.client.video.ConnectRequest
Unique identifier of the Vonage Video session.
getSessionId() - Method in class com.vonage.client.video.RenderRequest
Unique identifier of the Vonage Video session.
getSessionId() - Method in class com.vonage.client.video.SipDialRequest
Unique identifier of the Vonage Video session.
getSessionId() - Method in class com.vonage.client.video.CreateSessionResponse
 
getSessionId() - Method in class com.vonage.client.video.ListStreamCompositionsRequest
Retrieve only compositions for a given session ID.
getSessionId() - Method in class com.vonage.client.video.RenderResponse
Session ID of the Vonage Video session you are working with.
getSessionId() - Method in class com.vonage.client.video.StreamComposition
The ID of the video session associated with this composition.
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.
getSignatureForRequestParameters(Map<String, String>, String, HashUtil.HashType) - Static method in class com.vonage.client.auth.RequestSigning
Signs a set of request parameters.
getSignedCallbacks() - Method in class com.vonage.client.application.capabilities.Rtc
Whether to use signed webhooks.
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.
getSimSwap() - Method in class com.vonage.client.numberinsight2.FraudCheckResponse
Result of the SIM swap insight operation.
getSimSwapClient() - Method in class com.vonage.client.VonageClient
Returns the CAMARA SIM Swap API client.
getSip() - Method in class com.vonage.client.users.channels.Channels
SIP channels.
getSize() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
getSize() - Method in class com.vonage.client.numbers.ListNumbersFilter
Page size.
getSize() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Page size.
getSize() - Method in class com.vonage.client.video.Archive
The size of the MP4 file.
getSize() - Method in class com.vonage.client.voice.EventWebhook
Size of the recording file, in bytes.
getSms() - Method in class com.vonage.client.users.channels.Channels
SMS channels.
getSmsClient() - Method in class com.vonage.client.VonageClient
Returns the SMS API client.
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.
getSmsTotalCount() - Method in class com.vonage.client.messages.MessageStatus
MessageStatus.getChannel() is Channel.SMS, returns the number of SMS messages concatenated together to comprise the submitted message.
getSocketTimeout() - Method in class com.vonage.client.common.Webhook
Deprecated.
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 class com.vonage.client.auth.ApiKeyHeaderAuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.ApiKeyQueryParamsAuthMethod
 
getSortKey() - Method in interface com.vonage.client.auth.AuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.camara.NetworkAuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.JWTAuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.NoAuthMethod
 
getSortKey() - Method in class com.vonage.client.auth.SignatureAuthMethod
 
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).
getSourceId() - Method in class com.vonage.client.messages.whatsapp.Referral
Meta/WhatsApp ID of the referring advertisement or post.
getSourceType() - Method in class com.vonage.client.messages.whatsapp.Referral
The type of the referring advertisement or post.
getSourceType() - Method in class com.vonage.client.proactiveconnect.ListEventsFilter
Source type to filter by.
getSourceUrl() - Method in class com.vonage.client.messages.whatsapp.Referral
A URL referencing the content of the media shown in the advertisement when the user clicked to send a message.
getSpeech() - Method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
getSpeech() - Method in class com.vonage.client.voice.EventWebhook
Speech recognition results.
getSpeech() - Method in class com.vonage.client.voice.ncco.InputAction
 
getSplit() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether the audio is split.
getSplit() - Method in class com.vonage.client.voice.ncco.RecordAction
 
getSsml() - Method in class com.vonage.client.conversations.AudioSayEvent
Whether to enable Synthesized Speech Markup Language (SSML).
getStandardHeaders() - Method in class com.vonage.client.voice.ncco.SipEndpoint
Headers that are RFC standards, i.e. not prepended with X-.
getStandardHeaders() - Method in class com.vonage.client.voice.SipEndpoint
Headers that are RFC standards, i.e. not prepended with X-.
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.common.HalFilterRequest
Filter records that occurred after this point in time.
getStartDate() - Method in class com.vonage.client.conversations.ListConversationsRequest
 
getStartDate() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
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.
getStartId() - Method in class com.vonage.client.conversations.ListEventsRequest
The ID to start returning events at.
getStartOnEnter() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getStartTime() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
getStartTime() - Method in class com.vonage.client.voice.CallInfo
 
getStartTime() - Method in class com.vonage.client.voice.EventWebhook
Start time in ISO 8601 format.
getStartTimeout() - Method in class com.vonage.client.voice.ncco.SpeechSettings
 
getState() - Method in class com.vonage.client.conversations.BaseMember
State that the member is in.
getState() - Method in class com.vonage.client.conversations.Conversation
The state the conversation is in.
getState() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
Only include conversations with this member state.
getState() - Method in class com.vonage.client.conversations.UpdateMemberRequest
State to transition the member into.
getStatus() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
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.numberinsight2.FraudScore
Status of the fraud score API call.
getStatus() - Method in class com.vonage.client.numberinsight2.SimSwap
Status of the sim swap call.
getStatus() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
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 class 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.VerifyCodeResponse
Status of the verification workflow.
getStatus() - Method in class com.vonage.client.verify2.WorkflowStatus
State of the verification workflow.
getStatus() - Method in class com.vonage.client.video.Archive
The status of the archive, as defined by the ArchiveStatus enum.
getStatus() - Method in class com.vonage.client.video.Broadcast
The status of the broadcast at the time this object was created.
getStatus() - Method in class com.vonage.client.video.ProjectDetails
 
getStatus() - Method in class com.vonage.client.video.RenderResponse
Status of the Experience Composer.
getStatus() - Method in class com.vonage.client.video.Rtmp
The status of the RTMP stream.
getStatus() - Method in class com.vonage.client.voice.CallEvent
The status of the call.
getStatus() - Method in class com.vonage.client.voice.CallInfo
 
getStatus() - Method in class com.vonage.client.voice.CallsFilter
 
getStatus() - Method in class com.vonage.client.voice.EventWebhook
Event type.
getStatusCallbackUrl() - Method in class com.vonage.client.video.CaptionsRequest
A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
getStatusCode() - Method in exception class 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.
getStream(String, String) - Method in class com.vonage.client.video.VideoClient
Use this method to get information on a Vonage Video stream.
getStreamed() - Method in class com.vonage.client.conversations.AudioRecordEvent
Whether the audio recording is streamed.
getStreamId() - Method in class com.vonage.client.video.RenderResponse
ID of the composed stream being published.
getStreamId() - Method in class com.vonage.client.video.SipDialResponse
The video stream ID for the SIP call's stream in the OpenTok session.
getStreamId() - Method in class com.vonage.client.video.VideoStream
Gets the ID of the archive stream.
getStreamMode() - Method in class com.vonage.client.video.StreamComposition
The stream mode to used for selecting streams to be included in this composition: StreamMode.AUTO or StreamMode.MANUAL.
getStreamName() - Method in class com.vonage.client.video.Rtmp
 
GetStreamResponse - Class in com.vonage.client.video
Represents details of a stream, as returned from VideoClient.getStream(String, String).
GetStreamResponse() - Constructor for class com.vonage.client.video.GetStreamResponse
 
getStreams() - Method in class com.vonage.client.video.StreamComposition
Returns the streams associated with this composition.
getStreams() - Method in class com.vonage.client.video.Websocket
Stream IDs for the Vonage Video streams you want to include in the WebSocket audio.
getStreamUrl() - Method in class com.vonage.client.conversations.AudioPlayEvent
Source URL of the audio to play.
getStreamUrl() - Method in class com.vonage.client.voice.ncco.StreamAction
 
getStyle() - Method in class com.vonage.client.conversations.AudioSayEvent
Text-to-speech voice style.
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.
getStylesheet() - Method in class com.vonage.client.video.StreamCompositionLayout
 
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
Returns the Subaccounts API client.
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.
getSubtype() - Method in class com.vonage.client.messages.Button
Subtype of button being received.
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.
getSwapped() - Method in class com.vonage.client.numberinsight2.SimSwap
Whether the sim was swapped within the past week.
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
 
getTemplate(UUID) - Method in class com.vonage.client.verify2.Verify2Client
Retrieve a specific template.
getTemplateFragment(UUID, UUID) - Method in class com.vonage.client.verify2.Verify2Client
Retrieve a specific fragment.
getTemplateFragments() - Method in class com.vonage.client.verify2.ListTemplateFragmentsResponse
Gets the embedded collection of template fragments.
getTemplateId() - Method in class com.vonage.client.verify2.TemplateFragment
Unique identifier of the template this fragment belongs to.
getTemplates() - Method in class com.vonage.client.verify2.ListTemplatesResponse
Gets the embedded collection of templates.
getText() - Method in class com.vonage.client.conversations.AudioSayEvent
Text to be spoken.
getText() - Method in class com.vonage.client.conversations.MessageEvent
getText() - Method in class com.vonage.client.conversations.UpdateMemberRequest
Reason text for leaving.
getText() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getText() - Method in class com.vonage.client.incoming.Result
Deprecated.
Transcript text representing the words that the user spoke.
getText() - Method in class com.vonage.client.messages.Button
Additional context for the button.
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.MessageRequest
 
getText() - Method in class com.vonage.client.messages.messenger.MessengerTextRequest
 
getText() - Method in class com.vonage.client.messages.rcs.RcsTextRequest
 
getText() - Method in class com.vonage.client.messages.sms.SmsTextRequest
 
getText() - Method in interface com.vonage.client.messages.TextMessageRequest
Get the text field of the message.
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.sms.MessageEvent
Message body for this inbound message.
getText() - Method in class com.vonage.client.verify2.TemplateFragment
Text content of the template.
getText() - Method in class com.vonage.client.voice.ncco.TalkAction
 
getText() - Method in class com.vonage.client.voice.SpeechTranscript
Transcript text representing the words that the user spoke.
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
Deprecated.
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.
getThumbnailUrl() - Method in class com.vonage.client.messages.whatsapp.Referral
URL of the thumbnail image shown in the advertisement or post.
getThumbUrl() - Method in class com.vonage.client.messages.viber.Video
 
getTimeOut() - Method in class com.vonage.client.voice.ncco.ConnectAction
 
getTimeOut() - Method in class com.vonage.client.voice.ncco.DtmfSettings
Time to wait in seconds before submitting the event.
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
Deprecated.
Indicates if the input ended when user stopped speaking, by max duration timeout or if the user didn't say anything.
getTimeoutReason() - Method in class com.vonage.client.voice.SpeechResults
Indicates if the input ended when user stopped speaking, by max duration timeout or if the user didn't say anything.
getTimestamp() - Method in class com.vonage.client.conversations.BaseConversation
Timestamps for this conversation.
getTimestamp() - Method in class com.vonage.client.conversations.Event
Time of creation.
getTimestamp() - Method in class com.vonage.client.conversations.Member
Timestamps for this member.
getTimestamp() - Method in class com.vonage.client.conversion.ConversionRequest
Deprecated.
 
getTimestamp() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getTimestamp() - Method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
getTimestamp() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getTimestamp() - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
getTimestamp() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
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.MessageEvent
The Unix timestamp representation of MessageEvent.getMessageTimestamp().
getTimestamp() - Method in class com.vonage.client.voice.EventWebhook
Event timestamp in ISO 8601 format.
getTimeStamp() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
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 exception class com.vonage.client.VonageApiResponseException
Brief description / name of the error.
getTo() - Method in class com.vonage.client.conversations.MemberChannel
Receiver channel.
getTo() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getTo() - Method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
getTo() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
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.MessageEvent
Phone number that the message was sent to.
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.MoneyTransfer
Account to transfer to.
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.AnswerWebhook
The user or number that answered the call.
getTo() - Method in class com.vonage.client.voice.Call
 
getTo() - Method in class com.vonage.client.voice.CallInfo
 
getTo() - Method in class com.vonage.client.voice.EventWebhook
Number the call was made to, in E.164 format.
getToken() - Method in class com.vonage.client.video.CaptionsRequest
JSON Web Token with the appropriate roles for this request.
getToken() - Method in class com.vonage.client.video.ConnectRequest
JSON Web Token with the appropriate roles for this request.
getToken() - Method in class com.vonage.client.video.RenderRequest
JSON Web Token with the appropriate roles for this request.
getToken() - Method in class com.vonage.client.video.SipDialRequest
JSON Web Token with the appropriate roles for this request.
getTokenType() - Method in class com.vonage.client.auth.camara.TokenResponse
 
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.
getTranscription() - Method in class com.vonage.client.voice.ncco.ConversationAction
 
getTranscription() - Method in class com.vonage.client.voice.ncco.RecordAction
 
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.conversations.ConversationProperties
Number of seconds after which an empty conversation is deleted.
getTtl() - Method in class com.vonage.client.messages.MessageRequest
 
getTtl() - Method in class com.vonage.client.messages.mms.MmsRequest
 
getTtl() - Method in class com.vonage.client.messages.rcs.RcsRequest
 
getTtl() - Method in class com.vonage.client.messages.sms.SmsTextRequest
 
getTtl() - Method in class com.vonage.client.messages.viber.ViberService
 
getType() - Method in class com.vonage.client.account.Network
Network type.
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.NetworkApis
 
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.Verify
 
getType() - Method in class com.vonage.client.application.capabilities.Voice
 
getType() - Method in class com.vonage.client.conversations.ConversationProperties
Conversation type.
getType() - Method in class com.vonage.client.conversations.Event
Type of event.
getType() - Method in class com.vonage.client.conversations.MemberChannel
Main channel type.
getType() - Method in class com.vonage.client.conversion.ConversionRequest
Deprecated.
 
getType() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
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.mms.Content
The type of attachment.
getType() - Method in class com.vonage.client.messages.viber.ViberService
 
getType() - Method in class com.vonage.client.numberinsight2.FraudCheckResponse
The type of lookup used in the request.
getType() - Method in class com.vonage.client.numberinsight2.Phone
Type of phone, if Insight.FRAUD_SCORE was requested.
getType() - Method in class com.vonage.client.numbers.AvailableNumber
Type of number as a string.
getType() - Method in class com.vonage.client.numbers.OwnedNumber
Type of number as a string.
getType() - Method in class com.vonage.client.numbers.SearchNumbersFilter
Type of number to search for.
getType() - Method in enum class com.vonage.client.numbers.Type
Deprecated.
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
Deprecated.
 
getType() - Method in class com.vonage.client.sms.MessageEvent
Type of message.
getType() - Method in class com.vonage.client.sms.messages.Message
 
getType() - Method in class com.vonage.client.users.channels.Channel
If the type field is present in JSON payload, returns the value as an enum.
getType() - Method in class com.vonage.client.verify2.VerificationCallback
Type of response.
getType() - Method in class com.vonage.client.video.SignalRequest
 
getType() - Method in class com.vonage.client.video.StreamCompositionLayout
 
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.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.VbcEndpoint
 
getType() - Method in class com.vonage.client.voice.WebSocketEndpoint
 
getType() - Method in exception class com.vonage.client.VonageApiResponseException
Link to the API error type.
getUdh() - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
getUdh() - Method in class com.vonage.client.sms.MessageEvent
The hex encoded user data header.
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.conversations.ConversationTimestamp
Time that the conversation was update.
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.
getUpdatedAt() - Method in class com.vonage.client.video.Broadcast
For this start method, this timestamp matches the StreamComposition.getCreatedAt() timestamp.
getUpdatedAt() - Method in class com.vonage.client.video.RenderResponse
UNIX timestamp when the Experience Composer status was last updated.
getUpdatedAtMillis() - Method in class com.vonage.client.video.Broadcast
For this start method, this timestamp matches the StreamComposition.getCreatedAtMillis() timestamp.
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.video.SipDialRequest
 
getUri() - Method in class com.vonage.client.video.Websocket
A publicly reachable WebSocket URI to be used for the destination of the audio stream.
getUri() - Method in class com.vonage.client.voice.ncco.SipEndpoint
URI of the SIP endpoint.
getUri() - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint
 
getUri() - Method in class com.vonage.client.voice.SipEndpoint
SIP URI to connect to.
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.conversations.Callback
Event URL for the callback.
getUrl() - Method in class com.vonage.client.conversations.MessageEvent
If MessageEvent.getMessageType() is multimedia, returns the URL of the media.
getUrl() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
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.mms.Content
URL of the attachment.
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.video.Archive
The download URL of the available MP4 file.
getUrl() - Method in class com.vonage.client.video.RenderRequest
A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
getUrl() - Method in class com.vonage.client.video.RenderResponse
A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
getUrl() - Method in class com.vonage.client.voice.ncco.PhoneEndpoint.OnAnswer
 
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.conversations.BaseMember
User associated with this member.
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
Gets the User-Agent header to be used in HTTP requests.
getUserDataHeader() - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
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.
getUserId() - Method in class com.vonage.client.conversations.MemberInitiator
If MemberInitiator.invitedByAdmin() is false, returns the ID of the inviting user.
getUsername() - Method in class com.vonage.client.users.channels.Sip
SIP username.
getUsername() - Method in class com.vonage.client.video.SipDialRequest
 
getUsers() - Method in class com.vonage.client.users.ListUsersResponse
Retrieves the embedded resource contents.
getUsersClient() - Method in class com.vonage.client.VonageClient
Returns the Users API client.
getUuid() - Method in class com.vonage.client.incoming.CallEvent
Deprecated.
 
getUuid() - Method in class com.vonage.client.incoming.InputEvent
Deprecated.
 
getUuid() - Method in class com.vonage.client.incoming.RecordEvent
Deprecated.
 
getUuid() - Method in class com.vonage.client.voice.AnswerWebhook
Unique identifier for this call.
getUuid() - Method in class com.vonage.client.voice.CallEvent
The unique identifier for this call leg.
getUuid() - Method in class com.vonage.client.voice.CallInfo
 
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.conversations.AudioRecordEvent
The validity parameter.
getValidNumber() - Method in class com.vonage.client.insight.AdvancedInsightResponse
 
getValue() - Method in class com.vonage.client.account.BalanceResponse
Account balance in EUR as a double.
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
 
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
 
getVcardName() - Method in class com.vonage.client.messages.InboundMessage
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
 
getVerify() - Method in class com.vonage.client.application.Application.Capabilities
Verify capability.
getVerify2Client() - Method in class com.vonage.client.VonageClient
Returns the Verify v2 API client.
getVerifyClient() - Method in class com.vonage.client.VonageClient
Returns the Verify v1 API client.
getVerifyStatus() - Method in enum class com.vonage.client.verify.VerifyStatus
 
getVersionedApiBaseUri(String) - Method in class com.vonage.client.HttpConfig
Deprecated.
getVersionedApiEuBaseUri(String) - Method in class com.vonage.client.HttpConfig
Deprecated.
getVersionedRestBaseUri(String) - Method in class com.vonage.client.HttpConfig
Deprecated.
getVersionedVideoBaseUri(String) - Method in class com.vonage.client.HttpConfig
Deprecated.
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.rcs.RcsVideoRequest
 
getVideo() - Method in class com.vonage.client.messages.viber.ViberVideoRequest
 
getVideo() - Method in class com.vonage.client.messages.whatsapp.WhatsappVideoRequest
 
getVideo() - Method in class com.vonage.client.video.SipDialRequest
 
getVideoBaseUri() - Method in class com.vonage.client.HttpConfig
 
getVideoClient() - Method in class com.vonage.client.VonageClient
Returns the Video API client.
getVideoType() - Method in class com.vonage.client.video.GetStreamResponse
 
getVideoUrl() - Method in class com.vonage.client.messages.InboundMessage
If InboundMessage.getMessageType() is MessageType.VIDEO, returns the URL of the video.
getVideoUrl() - Method in class com.vonage.client.messages.whatsapp.Referral
URL of the video shown in the advertisement or post.
getVoice() - Method in class com.vonage.client.application.Application.Capabilities
Voice capability.
getVoiceCallbackType() - Method in class com.vonage.client.numbers.OwnedNumber
Voice webhook type.
getVoiceCallbackType() - Method in class com.vonage.client.numbers.UpdateNumberRequest
Specifies whether inbound voice calls on your number are forwarded to a SIP or a telephone number.
getVoiceCallbackValue() - Method in class com.vonage.client.numbers.OwnedNumber
SIP URI, telephone number or Application ID.
getVoiceCallbackValue() - Method in class com.vonage.client.numbers.UpdateNumberRequest
The SIP URI or telephone number.
getVoiceClient() - Method in class com.vonage.client.VonageClient
Returns the Voice API client.
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
The webhook URI for Vonage to send a request to when a call ends.
getWebhooks() - Method in class com.vonage.client.application.capabilities.Capability
Webhooks grouped by type.
getWebhookUrl() - Method in class com.vonage.client.messages.MessageRequest
 
getWebhookVersion() - Method in class com.vonage.client.messages.MessageRequest
 
getWebsocket() - Method in class com.vonage.client.users.channels.Channels
Websocket channels.
getWebsocket() - Method in class com.vonage.client.video.ConnectRequest
WebSocket parameters.
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.
getWhatsappContextStatus() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.WHATSAPP, returns an enum indicating whether there is a context for this inbound message.
getWhatsappConversationId() - Method in class com.vonage.client.messages.MessageStatus
If the MessageStatus.getChannel() is Channel.WHATSAPP and MessageStatus.getStatus() is MessageStatus.Status.DELIVERED, returns the conversation ID of the message that triggered this callback.
getWhatsappConversationType() - Method in class com.vonage.client.messages.MessageStatus
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.
getWhatsappReferral() - Method in class com.vonage.client.messages.InboundMessage
If the InboundMessage.getChannel() is Channel.WHATSAPP and a content referral is present in the message, returns the metadata related to the post or advertisement that the user clicked on.
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
 
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
 
GUJARATI - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 

H

HalFilterRequest - Class in com.vonage.client.common
Provides basic filtering parameters for HAL resources.
HalFilterRequest(HalFilterRequest.Builder<?, ?>) - Constructor for class com.vonage.client.common.HalFilterRequest
 
HalFilterRequest(Integer, Integer, SortOrder) - Constructor for class com.vonage.client.common.HalFilterRequest
 
HalFilterRequest.Builder<F,B> - Class in com.vonage.client.common
 
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
 
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
 
hasApplication(boolean) - Method in class com.vonage.client.numbers.ListNumbersFilter.Builder
Set this optional field to true to restrict your results to numbers associated with any application.
hasAudio - Variable in class com.vonage.client.video.StreamComposition.Builder
 
hasAudio - Variable in class com.vonage.client.video.StreamComposition
 
hasAudio() - Method in class com.vonage.client.video.StreamComposition
Whether the archive has an audio track (true) or not (false).
hasAudio() - Method in class com.vonage.client.video.VideoStream
Whether the recording has audio.
hasAudio(boolean) - Method in class com.vonage.client.video.Archive.Builder
Call this method to include an audio track (true, the default) or not false).
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.auth.AbstractAuthMethod
 
hashCode() - Method in class com.vonage.client.JsonableBaseObject
 
hashCode() - Method in exception class com.vonage.client.VonageApiResponseException
 
hashType(HashUtil.HashType) - Method in class com.vonage.client.VonageClient.Builder
Sets the hash type to use for signing requests.
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
 
hasVideo - Variable in class com.vonage.client.video.StreamComposition.Builder
 
hasVideo - Variable in class com.vonage.client.video.StreamComposition
 
hasVideo() - Method in class com.vonage.client.video.StreamComposition
Whether the composition has a video track (true) or not (false).
hasVideo() - Method in class com.vonage.client.video.VideoStream
Whether the recording has video.
hasVideo(boolean) - Method in class com.vonage.client.video.Archive.Builder
Call this method to include a video track (true, the default) or not false).
HAUSA - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
HD_LANDSCAPE - Enum constant in enum class com.vonage.client.video.Resolution
720p landscape (1280x720)
HD_PORTRAIT - Enum constant in enum class com.vonage.client.video.Resolution
720p portrait (720x1280)
HE - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Hebrew
HeaderAuthMethod - Interface in com.vonage.client.auth
Interface for auth methods which use the Authorization: header.
headers(Map<String, ?>) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
Sets the custom headers, which will be prepended with X- by Vonage.
headers(Map<String, ?>) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
headers(Map<String, String>) - Method in class com.vonage.client.video.ConnectRequest.Builder
Key-value pairs of headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.
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
 
HI_IN - Enum constant in enum class com.vonage.client.video.Language
Hindi
HIGH - Enum constant in enum class com.vonage.client.numberinsight2.RiskLabel
 
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
 
hls(Hls) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL, but REQUIRED if no RTMP URLs are set) Sets the HTTP Live Streaming (HLS) output of the broadcast.
Hls - Class in com.vonage.client.video
Represents HTTP Live Streaming (HLS) options for a Broadcast.
Hls() - Constructor for class com.vonage.client.video.Hls
 
Hls(Hls.Builder) - Constructor for class com.vonage.client.video.Hls
 
Hls.Builder - Class in com.vonage.client.video
Used to create the Hls object.
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
Deprecated.
This class will be made package-private in the next major release.
HmacMd5Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacMd5Hasher
Deprecated.
 
HmacSha1Hasher - Class in com.vonage.client.auth.hashutils
Deprecated.
This class will be made package-private in the next major release.
HmacSha1Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacSha1Hasher
Deprecated.
 
HmacSha256Hasher - Class in com.vonage.client.auth.hashutils
Deprecated.
This class will be made package-private in the next major release.
HmacSha256Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacSha256Hasher
Deprecated.
 
HmacSha512Hasher - Class in com.vonage.client.auth.hashutils
Deprecated.
This class will be made package-private in the next major release.
HmacSha512Hasher() - Constructor for class com.vonage.client.auth.hashutils.HmacSha512Hasher
Deprecated.
 
HORIZONTAL - Enum constant in enum class com.vonage.client.video.ScreenLayoutType
Horizontal presentation
href - Variable in class com.vonage.client.common.UrlContainer
 
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
Configure the HTTP client parameters.
HttpConfig - Class in com.vonage.client
 
HttpConfig.Builder - Class in com.vonage.client
Builder for configuring the base URI and timeout of the 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
Deprecated.
 
HUMAN - Enum constant in enum class com.vonage.client.voice.CallStatus
For an outbound call made programmatically with machine detection enabled, this indicates a human answered the call.
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
 

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
 
id - Variable in class com.vonage.client.video.StreamComposition
 
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.
id(String) - Method in class com.vonage.client.video.Rtmp.Builder
(OPTIONAL) Sets a unique ID for the stream.
image - Variable in class com.vonage.client.messages.InboundMessage
 
IMAGE - Enum constant in enum class com.vonage.client.common.MessageType
 
IMAGE - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
imageUrl(String) - Method in class com.vonage.client.conversations.Conversation.Builder
An image URL that you associate with the conversation.
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.
INACTIVE - Enum constant in enum class com.vonage.client.conversations.ConversationStatus
 
INBOUND - Enum constant in enum class com.vonage.client.common.Webhook.Type
Deprecated.
 
INBOUND - Enum constant in enum class com.vonage.client.incoming.CallDirection
Deprecated.
 
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.Origin - Class in com.vonage.client.messages
 
InboundMessage.UrlWrapper - Class in com.vonage.client.messages
 
InboundMessage.UrlWrapperWithCaption - Class in com.vonage.client.messages
 
InboundMessage.Whatsapp - Class in com.vonage.client.messages
 
includeCustomData(Boolean) - Method in class com.vonage.client.conversations.ListUserConversationsRequest.Builder
Whether to include custom data in the responses.
INDIAN_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
INDIVIDUAL - Enum constant in enum class com.vonage.client.video.OutputMode
Each stream in the archive is recorded to its own individual file.
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
 
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
 
initialLayoutClassList(List<String>) - Method in class com.vonage.client.video.TokenOptions.Builder
A List of class names (strings) to be used as the initial layout classes for streams published by the client.
initiatedAt - Variable in class com.vonage.client.verify2.WorkflowStatus
 
initiateVerification(String, URI, String) - Method in class com.vonage.client.camara.numberverification.NumberVerificationClient
Sets up the client for verifying the given phone number.
INPUT - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
INPUT - Enum constant in enum class com.vonage.client.voice.CallStatus
An NCCO input action has finished.
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
Builder for specifying the properties of an InputAction.
InputEvent - Class in com.vonage.client.incoming
Deprecated.
InputEvent() - Constructor for class com.vonage.client.incoming.InputEvent
Deprecated.
 
InputMode - Enum Class in com.vonage.client.voice.ncco
Represents the input mode for InputAction.
Insight - Enum Class in com.vonage.client.numberinsight2
Represents the type of insights used for a fraud check request.
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 class 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
Deprecated.
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.
INTERNAL_ERROR - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
Server error or failure.
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
Deprecated.
Number invalid.
INVALID_NUMBER - Enum constant in enum class com.vonage.client.voice.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.
invalidParameters - Variable in exception class com.vonage.client.VonageApiResponseException
 
INVITED - Enum constant in enum class com.vonage.client.conversations.MemberState
 
invitedByAdmin() - Method in class com.vonage.client.conversations.MemberInitiator
Whether the member was invited by an admin JWT or a user.
invocationId(String) - Method in class com.vonage.client.proactiveconnect.ListEventsFilter.Builder
Invocation ID to filter by.
IRISH - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
IRISH_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
isAsync() - Method in class com.vonage.client.insight.AdvancedInsightRequest
 
isAutoReload() - Method in class com.vonage.client.account.BalanceResponse
Whether balance auto-reloading is enabled.
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
Deprecated.
 
isDefault() - Method in class com.vonage.client.verify2.Template
Whether this is the default template.
isDefaultApiBaseUri() - Method in class com.vonage.client.HttpConfig
Deprecated.
isDefaultApiEuBaseUri() - Method in class com.vonage.client.HttpConfig
Deprecated.
isDefaultRestBaseUri() - Method in class com.vonage.client.HttpConfig
Deprecated.
isDefaultVideoBaseUri() - Method in class com.vonage.client.HttpConfig
Deprecated.
isDelivered() - Method in class com.vonage.client.conversion.ConversionRequest
Deprecated.
 
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
Determines if the callee's activity is sent to your webhook endpoint after pressing the hash key.
isTemporaryError() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
isTimedOut() - Method in class com.vonage.client.incoming.DtmfResult
Deprecated.
Whether the DTMF input timed out.
isTimedOut() - Method in class com.vonage.client.voice.DtmfResult
Whether the DTMF input timed out.
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
IT_IT - Enum constant in enum class com.vonage.client.video.Language
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
 
iterator() - Method in class com.vonage.client.voice.CallInfoPage
 

J

JA_JP - Enum constant in enum class com.vonage.client.video.Language
Japanese
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.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.
JOINED - Enum constant in enum class com.vonage.client.conversations.MemberState
 
Jsonable - Interface in com.vonage.client
Indicates that a class can be serialized to and parsed from JSON.
JsonableBaseObject - Class in com.vonage.client
Base class for requests and responses which are serialised and parsed to and from JSON.
JsonableBaseObject() - Constructor for class com.vonage.client.JsonableBaseObject
 
JWTAuthMethod - Class in com.vonage.client.auth
 
JWTAuthMethod(String, byte[]) - 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
 
KANNADA - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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
 
knockingId(String) - Method in class com.vonage.client.conversations.Member.Builder
(OPTIONAL) Unique knocking identifier.
KO_KR - Enum constant in enum class com.vonage.client.video.Language
Korean
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

L16_16K - Enum constant in enum class com.vonage.client.video.Websocket.AudioRate
Linear 16-bit PCM at 16 Khz.
L16_8K - Enum constant in enum class com.vonage.client.video.Websocket.AudioRate
Linear 16-bit PCM at 8 Khz.
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.numberinsight2.PhoneType
 
LANDLINE - Enum constant in enum class com.vonage.client.numbers.Type
 
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(SpeechSettings.Language) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Expected language of the user's speech.
language(SpeechSettings.Language) - Method in class com.vonage.client.voice.ncco.TranscriptionSettings.Builder
The language (BCP-47 format) for the recording you're transcribing.
language(TextToSpeechLanguage) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Text-to-speech transcription language.
language(TextToSpeechLanguage) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Language for the spoken text.
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.
Language - Enum Class in com.vonage.client.video
Represents the supported BCP-47 language codes for Live Captions.
languageCode(Language) - Method in class com.vonage.client.video.CaptionsRequest.Builder
BCP-47 code for a spoken language used on this call.
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.conversations.Location.Builder
Latitude of the location.
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
 
LATVIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
layout - Variable in class com.vonage.client.video.StreamComposition.Builder
 
layout - Variable in class com.vonage.client.video.StreamComposition
 
layout(StreamCompositionLayout) - Method in class com.vonage.client.video.Archive.Builder
Sets the layout for a composed archive.
layout(StreamCompositionLayout) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) Specify this to assign the initial layout type for the broadcast.
layoutClassList(String...) - Method in class com.vonage.client.video.SessionStream.Builder
Use this method to set the layout classes for the stream.
layoutClassList(List<String>) - Method in class com.vonage.client.video.SessionStream.Builder
Use this method to set the layout classes for the stream.
LEFT - Enum constant in enum class com.vonage.client.conversations.MemberState
 
LEG_STATUS_UPDATE - Enum constant in enum class com.vonage.client.conversations.EventType
Update on the status of a conversation leg.
legPersistenceTime(int) - Method in class com.vonage.client.application.capabilities.Voice.Builder
Persistence duration for conversation legs, in days.
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.conversations.AudioPlayEvent.Builder
Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.
level(double) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Audio volume level, with -1 being quietest, +1 being loudest and 0 the default.
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.
listArchives() - Method in class com.vonage.client.video.VideoClient
List all archives in the application.
listArchives(ListStreamCompositionsRequest) - Method in class com.vonage.client.video.VideoClient
List all archives in the application.
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.
listBroadcasts() - Method in class com.vonage.client.video.VideoClient
List all broadcasts that are in progress and started in the application.
listBroadcasts(ListStreamCompositionsRequest) - Method in class com.vonage.client.video.VideoClient
List all broadcasts that are in progress and started in the application.
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).
listConversations() - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve the first 100 Conversations in the application.
listConversations(ListConversationsRequest) - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve conversations in the application which match the specified filter criteria.
ListConversationsRequest - Class in com.vonage.client.conversations
ListConversationsRequest.Builder - Class in com.vonage.client.conversations
 
ListConversationsResponse - Class in com.vonage.client.conversations
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
Deprecated.
Get numbers that can be used to dial into a meeting.
listEvents(ListEventsFilter) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Gets all events in the application matching the criteria.
listEvents(String) - Method in class com.vonage.client.conversations.ConversationsClient
List the first 100 events for a given Conversation.
listEvents(String, ListEventsRequest) - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve Events associated with a particular Conversation which match the specified filter criteria.
ListEventsFilter - Class in com.vonage.client.proactiveconnect
Filter options for finding events using listEvents(ListEventsFilter).
ListEventsFilter.Builder - Class in com.vonage.client.proactiveconnect
Builder for specifying options to filter events by.
ListEventsRequest - Class in com.vonage.client.conversations
ListEventsRequest.Builder - Class in com.vonage.client.conversations
 
ListEventsResponse - Class in com.vonage.client.conversations
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
Deprecated.
Gets the first 1000 events in the application.
listItems(UUID, int, int, SortOrder) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Get all items on a particular page.
ListItemsResponse - Class in com.vonage.client.proactiveconnect
listLists() - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Gets the first 1000 lists in the application.
listLists(int, int, SortOrder) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Get all lists on a particular page.
ListListsResponse - Class in com.vonage.client.proactiveconnect
listMembers(String) - Method in class com.vonage.client.conversations.ConversationsClient
List the first 100 Members for a given Conversation.
listMembers(String, ListMembersRequest) - Method in class com.vonage.client.conversations.ConversationsClient
Retrieve Members associated with a particular Conversation which match the specified filter criteria.
ListMembersRequest - Class in com.vonage.client.conversations
ListMembersRequest.Builder - Class in com.vonage.client.conversations
 
ListMembersResponse - Class in com.vonage.client.conversations
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
Deprecated.
Use ListNumbersFilter.builder(). This will be removed in the next major release.
ListNumbersFilter(Integer, Integer, String, SearchPattern) - Constructor for class com.vonage.client.numbers.ListNumbersFilter
Deprecated.
ListNumbersFilter.Builder - Class in com.vonage.client.numbers
Builder for setting the parameters of 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
Obtain pricing data on all supported countries for a specific service type.
listRecordings(String) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
Get recordings of a meeting session.
listRenders() - Method in class com.vonage.client.video.VideoClient
List all Experience Composers in the application.
listRenders(ListStreamCompositionsRequest) - Method in class com.vonage.client.video.VideoClient
List Experience Composers in the application, with the specified offset and number of results.
listRooms() - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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
Deprecated.
ListStreamCompositionsRequest - Class in com.vonage.client.video
ListStreamCompositionsRequest(ListStreamCompositionsRequest.Builder) - Constructor for class com.vonage.client.video.ListStreamCompositionsRequest
 
ListStreamCompositionsRequest.Builder - Class in com.vonage.client.video
 
listStreams(String) - Method in class com.vonage.client.video.VideoClient
Use this method to get information on all Vonage Video streams in a session.
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
 
listTemplateFragments(UUID) - Method in class com.vonage.client.verify2.Verify2Client
List all fragments associated with a template.
ListTemplateFragmentsResponse - Class in com.vonage.client.verify2
Represents a response page for listing template fragments.
ListTemplateFragmentsResponse() - Constructor for class com.vonage.client.verify2.ListTemplateFragmentsResponse
 
listTemplates() - Method in class com.vonage.client.verify2.Verify2Client
List all custom templates associated with the account.
ListTemplatesResponse - Class in com.vonage.client.verify2
Represents a response page for listing templates.
ListTemplatesResponse() - Constructor for class com.vonage.client.verify2.ListTemplatesResponse
 
listThemes() - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
Get all application themes.
ListTransfersFilter - Class in com.vonage.client.subaccounts
 
ListTransfersFilter.Builder - Class in com.vonage.client.subaccounts
 
listUserConversations(String) - Method in class com.vonage.client.conversations.ConversationsClient
List the first 100 conversations for a given user.
listUserConversations(String, ListUserConversationsRequest) - Method in class com.vonage.client.conversations.ConversationsClient
List the first 100 conversations for a given user.
ListUserConversationsRequest - Class in com.vonage.client.conversations
ListUserConversationsRequest.Builder - Class in com.vonage.client.conversations
 
ListUserConversationsResponse - Class in com.vonage.client.conversations
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
 
LIVE - Enum constant in enum class com.vonage.client.video.RtmpStatus
The Vonage video platform has successfully connected to the remote RTMP server, and the media is streaming.
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(String) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) Set the language that this request will be delivered in.
locale(Locale) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
locale(Locale) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
locale(Locale) - Method in class com.vonage.client.verify2.VerificationRequest.Builder
(OPTIONAL) Set the language that this request will be delivered in.
Locale - Enum Class in com.vonage.client.messages.whatsapp
Enum representing BCP-47 locales supported by WhatsApp.
location(Location) - Method in class com.vonage.client.conversations.MessageEvent.Builder
Sets the message location, if the type is MessageType.LOCATION.
location(String) - Method in class com.vonage.client.video.CreateSessionRequest.Builder
Call this method to set an IP address that the Vonage servers will use to situate the session in its global network.
location(InetAddress) - Method in class com.vonage.client.video.CreateSessionRequest.Builder
Call this method to set an IP address that the Vonage servers will use to situate the session in its global network.
Location - Class in com.vonage.client.conversations
Describes parameters for a Location message in MessageEvent.getLocation().
Location - Class in com.vonage.client.messages.whatsapp
Whatsapp Location message parameters.
LOCATION - Enum constant in enum class com.vonage.client.common.MessageType
 
LOCATION - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
Location.Builder - Class in com.vonage.client.conversations
Builder for setting Location parameters.
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
 
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.conversations.Location.Builder
Longitude of the location.
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.conversations.AudioPlayEvent.Builder
Number of times to repeat the audio.
loop(int) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Number of times to repeat the audio.
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
 
LOW - Enum constant in enum class com.vonage.client.numberinsight2.RiskLabel
 
lowLatency() - Method in class com.vonage.client.video.Hls
Whether low-latency mode is enabled for the HLS stream.
lowLatency(boolean) - Method in class com.vonage.client.video.Hls.Builder
Whether to enable low-latency mode for the HLS stream.

M

MACEDONIAN - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
MACHINE - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
MACHINE - Enum constant in enum class com.vonage.client.voice.CallStatus
For an outbound call made programmatically with machine detection enabled, this indicates a machine / voicemail answered the call.
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
Represents machine detection behaviour.
MachineDetectionStatus - Enum Class in com.vonage.client.voice
Represents event substates for advanced machine detection in EventWebhook.getMachineDetectionSubstate().
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
Deprecated.
 
makeParams() - Method in class com.vonage.client.auth.camara.AuthRequest
 
makeParams() - Method in class com.vonage.client.auth.camara.TokenRequest
 
makeParams() - Method in class com.vonage.client.common.HalFilterRequest
 
makeParams() - Method in class com.vonage.client.conversations.ListConversationsRequest
 
makeParams() - Method in class com.vonage.client.conversations.ListMembersRequest
 
makeParams() - Method in class com.vonage.client.conversations.ListEventsRequest
 
makeParams() - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
makeParams() - Method in class com.vonage.client.conversion.ConversionRequest
Deprecated.
 
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.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
Internal method for serializing the fields of this class into query parameters.
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.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
Deprecated.
 
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.VerifyRequest
 
makeParams() - Method in class com.vonage.client.video.CreateSessionRequest
 
makeParams() - Method in class com.vonage.client.video.ListStreamCompositionsRequest
 
makeParams() - Method in class com.vonage.client.voice.CallsFilter
 
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
 
MALAY - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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
 
MALAYALAM - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
MANDARIN_CHINESE_SIMPLIFIED - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
MANUAL - Enum constant in enum class com.vonage.client.video.ArchiveMode
The session is not archived automatically.
MANUAL - Enum constant in enum class com.vonage.client.video.StreamMode
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
 
MARKETING - Enum constant in enum class com.vonage.client.messages.whatsapp.ConversationType
 
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
Deprecated.
 
MAX_DURATION - Enum constant in enum class com.vonage.client.voice.SpeechTimeoutReason
 
maxBitrate - Variable in class com.vonage.client.video.StreamComposition.Builder
 
maxBitrate - Variable in class com.vonage.client.video.StreamComposition
 
maxBitrate(int) - Method in class com.vonage.client.video.Archive.Builder
(OPTIONAL) The maximum bitrate for the archive, in bits per second.
maxBitrate(int) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) The maximum bitrate for the broadcast, in bits per second.
maxDigits(int) - Method in class com.vonage.client.voice.ncco.DtmfSettings.Builder
The number of digits the user can press.
maxDuration(int) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) The maximum duration for the broadcast, in seconds.
maxDuration(int) - Method in class com.vonage.client.video.CaptionsRequest.Builder
The maximum duration for the audio captioning, in seconds.
maxDuration(int) - Method in class com.vonage.client.video.RenderRequest.Builder
(OPTIONAL) Maximum time allowed for the Experience Composer, in seconds.
maxDuration(int) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Controls maximum speech duration (from the moment user starts speaking).
maxDuration(Duration) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) The maximum duration for the broadcast.
maxTextLength() - Method in class com.vonage.client.messages.MessageRequest
Sets the maximum text length for text messages.
maxTextLength() - Method in class com.vonage.client.messages.messenger.MessengerTextRequest
 
maxTextLength() - Method in class com.vonage.client.messages.rcs.RcsTextRequest
 
maxTextLength() - Method in class com.vonage.client.messages.whatsapp.WhatsappTextRequest
 
MD5 - Enum constant in enum class com.vonage.client.auth.hashutils.HashUtil.HashType
 
media - Variable in class com.vonage.client.messages.MessageRequest
 
media(MemberMedia) - Method in class com.vonage.client.conversations.Member.Builder
(OPTIONAL) Media settings for this member.
MediaAudioSettings - Class in com.vonage.client.conversations
Represents the audio options in MemberMedia.getAudioSettings().
MediaAudioSettings() - Constructor for class com.vonage.client.conversations.MediaAudioSettings
 
MediaMessageRequest - Interface in com.vonage.client.messages
Convenience interface to indicate that MessageRequest.getMessageType() is media (has a URL).
MediaMessageRequest.Builder<B> - Interface in com.vonage.client.messages
Interface for builders with a media URL.
mediaMode(MediaMode) - Method in class com.vonage.client.video.CreateSessionRequest.Builder
Call this method to determine whether the session will transmit streams using the Vonage Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED).
MediaMode - Enum Class in com.vonage.client.video
Defines values for the mediaMode parameter of the CreateSessionRequest.Builder.mediaMode(MediaMode mediaMode) method.
MEDIUM - Enum constant in enum class com.vonage.client.numberinsight2.RiskLabel
 
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
Deprecated.
Support for this API will be removed in the next major release.
MeetingsClient(HttpWrapper) - Constructor for class com.vonage.client.meetings.MeetingsClient
Deprecated.
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 Class in com.vonage.client.meetings
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
MeetingsResponseException() - Constructor for exception class com.vonage.client.meetings.MeetingsResponseException
 
Member - Class in com.vonage.client.conversations
Represents a conversation membership.
Member() - Constructor for class com.vonage.client.conversations.Member
 
MEMBER_INVITED - Enum constant in enum class com.vonage.client.conversations.EventType
Member has been invited to the conversation.
MEMBER_JOINED - Enum constant in enum class com.vonage.client.conversations.EventType
Member has joined the conversation.
MEMBER_LEFT - Enum constant in enum class com.vonage.client.conversations.EventType
Member has left the conversation.
MEMBER_MEDIA - Enum constant in enum class com.vonage.client.conversations.EventType
Member has media.
MEMBER_MESSAGE_STATUS - Enum constant in enum class com.vonage.client.conversations.EventType
Status update on a member message.
Member.Builder - Class in com.vonage.client.conversations
 
MemberChannel - Class in com.vonage.client.conversations
Contains the channel properties for Member.getChannel().
MemberChannel() - Constructor for class com.vonage.client.conversations.MemberChannel
 
memberId(String) - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
(REQUIRED) Unique member identifier.
memberIdInviting(String) - Method in class com.vonage.client.conversations.Member.Builder
(OPTIONAL) Unique member ID to invite.
MemberInitiator - Class in com.vonage.client.conversations
 
MemberInitiator() - Constructor for class com.vonage.client.conversations.MemberInitiator
 
MemberMedia - Class in com.vonage.client.conversations
Contains the media properties for Member.getMedia().
MemberMedia.Builder - Class in com.vonage.client.conversations
Builder for constructing MemberMedia.
MemberState - Enum Class in com.vonage.client.conversations
Represents the state of a conversation member.
MemberTimestamp - Class in com.vonage.client.conversations
Represents the timestamps in Member.getTimestamp().
MemberTimestamp() - Constructor for class com.vonage.client.conversations.MemberTimestamp
 
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 - Enum constant in enum class com.vonage.client.conversations.EventType
Message event.
MESSAGE_DELIVERED - Enum constant in enum class com.vonage.client.conversations.EventType
Message has been delivered.
MESSAGE_REJECTED - Enum constant in enum class com.vonage.client.conversations.EventType
Message rejected.
MESSAGE_SEEN - Enum constant in enum class com.vonage.client.conversations.EventType
Message has been seen.
MESSAGE_SUBMITTED - Enum constant in enum class com.vonage.client.conversations.EventType
Message submitted.
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_UNDELIVERABLE - Enum constant in enum class com.vonage.client.conversations.EventType
Message could not be delivered.
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
 
MessageDeliveredEvent - Class in com.vonage.client.conversations
Represents a EventType.MESSAGE_DELIVERED event.
MessageDeliveredEvent.Builder - Class in com.vonage.client.conversations
Builder for configuring parameters of the event request.
MessageEvent - Class in com.vonage.client.conversations
Represents a EventType.MESSAGE event.
MessageEvent - Class in com.vonage.client.incoming
Deprecated.
Moved to MessageEvent.
MessageEvent - Class in com.vonage.client.sms
Represents an Inbound SMS webhook.
MessageEvent() - Constructor for class com.vonage.client.incoming.MessageEvent
Deprecated.
 
MessageEvent.Builder - Class in com.vonage.client.conversations
Builder for configuring parameters of the event request.
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
 
MessagePayload(String, String, String) - Constructor for class com.vonage.client.messages.internal.MessagePayload
 
MessageRejectedEvent - Class in com.vonage.client.conversations
Represents a EventType.MESSAGE_REJECTED event.
MessageRejectedEvent.Builder - Class in com.vonage.client.conversations
Builder for configuring parameters of the event request.
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,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 Class in com.vonage.client.messages
Response returned when sending a message fails (i.e. returns a non-2xx status code).
MessageResponseException() - Constructor for exception class 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 API
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.
MessageSeenEvent - Class in com.vonage.client.conversations
Represents a EventType.MESSAGE_SEEN event.
MessageSeenEvent.Builder - Class in com.vonage.client.conversations
Builder for configuring parameters of the event request.
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.
MessageSubmittedEvent - Class in com.vonage.client.conversations
Represents a EventType.MESSAGE_SUBMITTED event.
MessageSubmittedEvent.Builder - Class in com.vonage.client.conversations
Builder for configuring parameters of the event request.
MessagesVersion - Enum Class in com.vonage.client.messages
Represents the possible versions used for webhooks in the Messages API.
messageType - Variable in class com.vonage.client.messages.InboundMessage
 
MessageType - Enum Class in com.vonage.client.common
Represents a message media type.
MessageType - Enum Class in com.vonage.client.incoming
Deprecated.
MessageType - Enum Class in com.vonage.client.messages
Deprecated.
Will be replaced by MessageType in the next major release.
MessageType - Enum Class in com.vonage.client.sms
Represents the SMS message type.
MessageUndeliverableEvent - Class in com.vonage.client.conversations
MessageUndeliverableEvent.Builder - Class in com.vonage.client.conversations
Builder for configuring parameters of the event request.
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.common.ChannelType
 
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,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
Deprecated.
(REQUIRED) The HTTP request method for this webhook.
method(HttpMethod) - Method in class com.vonage.client.conversations.Callback.Builder
HTTP method to use for the callback.
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.common.ChannelType
 
MMS - Enum constant in enum class com.vonage.client.messages.Channel
 
MMS - Enum constant in enum class com.vonage.client.numbers.Feature
 
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,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
Deprecated.
This class is not maintained and will be removed in the next major release. Please consider using the Messages API instead.
MO(String, MO.MESSAGE_TYPE, String, String, BigDecimal, Date) - Constructor for class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
MO.MESSAGE_TYPE - Enum Class in com.vonage.client.sms.callback.messages
Deprecated.
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.numberinsight2.PhoneType
 
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.
mode(InputMode) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
How the input should be processed.
MODERATOR - Enum constant in enum class com.vonage.client.video.Role
In addition to the privileges granted to a publisher, a moderator can perform moderation functions, such as forcing clients to disconnect, to stop publishing streams, or to mute audio in published streams.
ModifyCallAction - Enum Class in com.vonage.client.voice
Enum representing call modification actions.
moHttpUrl(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the URL-encoded URI to the webhook endpoint that handles inbound messages.
moHttpUrl(URI) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the URL-encoded URI to the webhook endpoint that handles inbound messages.
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
 
moSmppSysType(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the associated system type for your SMPP client.
MP3 - Enum constant in enum class com.vonage.client.voice.ncco.RecordingFormat
 
multiArchiveTag(String) - Method in class com.vonage.client.video.Archive.Builder
Set this to support recording multiple archives for the same session simultaneously.
multiBroadcastTag(String) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) Set this to support multiple broadcasts for the same session simultaneously.
multitrack(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether the audio should have multiple tracks.
musicOnHoldUrl(String...) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
A URL to the mp3 file to stream to participants until the conversation starts.
musicOnHoldUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
Deprecated.
This will be removed in the next major release.
mute(boolean) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
Whether to mute the participant.
MUTE - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
muteCall(String) - Method in class com.vonage.client.voice.VoiceClient
Modify a call with the ModifyCallAction.MUTE action.
muted(boolean) - Method in class com.vonage.client.conversations.MemberMedia.Builder
 
muteSession(String, boolean, String...) - Method in class com.vonage.client.video.VideoClient
Force all streams (except for an optional list of streams) in a session to mute published audio.
muteSession(String, boolean, Collection<String>) - Method in class com.vonage.client.video.VideoClient
Force all streams (except for an optional list of streams) in a session to mute published audio.
muteStream(String, String) - Method in class com.vonage.client.video.VideoClient
Force mute a specific publisher stream.

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.InboundMessage.UrlWrapper
 
name - Variable in class com.vonage.client.messages.internal.MessagePayload
 
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.conversations.Conversation.Builder
Internal conversation name.
name(String) - Method in class com.vonage.client.conversations.Location.Builder
Name of the location.
name(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(OPTIONAL) The media name.
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.WhatsappFileRequest.Builder
(OPTIONAL) Specifies the name of the file being sent.
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.video.Archive.Builder
Sets a name for the archive.
name(String) - Method in class com.vonage.client.video.RenderRequest.Builder
(REQUIRED) Name of the composed output stream which is published to the session.
name(String) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
Sets the name of the Conversation room.
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
Deprecated.
Ncco(ObjectWriter, Action...) - Constructor for class com.vonage.client.voice.ncco.Ncco
Deprecated.
Ncco(ObjectWriter, Collection<? extends Action>) - Constructor for class com.vonage.client.voice.ncco.Ncco
Deprecated.
Ncco(Action...) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
Ncco(Collection<Action>) - Constructor for class com.vonage.client.voice.ncco.Ncco
 
nccoUrl(String) - Method in class com.vonage.client.conversations.Callback.Builder
Call Control Object URL to use for the callback.
NEPALI - Enum constant in enum class com.vonage.client.voice.ncco.SpeechSettings.Language
 
Network - Class in com.vonage.client.account
Represents a network in PricingResponse.
Network() - Constructor for class com.vonage.client.account.Network
Deprecated.
NETWORK - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
Network APIs
Network.Type - Enum Class in com.vonage.client.account
Represents the type of network.
NetworkApiClient - Class in com.vonage.client.camara
Base class for Vonage Network API clients.
NetworkApiClient(HttpWrapper) - Constructor for class com.vonage.client.camara.NetworkApiClient
 
NetworkApis - Class in com.vonage.client.application.capabilities
Network APIs capability configuration settings.
NetworkApis.Builder - Class in com.vonage.client.application.capabilities
 
networkApplicationId(String) - Method in class com.vonage.client.application.capabilities.NetworkApis.Builder
Sets the network application ID (this is different from the Vonage application ID).
networkAuthClient - Variable in class com.vonage.client.camara.NetworkApiClient
 
NetworkAuthClient - Class in com.vonage.client.auth.camara
Used for obtaining access tokens for use with Vonage CAMARA APIs.
NetworkAuthClient(HttpWrapper) - Constructor for class com.vonage.client.auth.camara.NetworkAuthClient
Create a new NetworkAuthClient.
NetworkAuthMethod - Class in com.vonage.client.auth.camara
Auth method for Vonage Network APIs.
NetworkAuthMethod(NetworkAuthClient, BackendAuthRequest) - Constructor for class com.vonage.client.auth.camara.NetworkAuthMethod
Creates a new Bearer auth method which uses the specified params to automatically obtain the token parameters in order to exchange them for an access token.
NetworkAuthMethod(NetworkAuthClient, TokenRequest) - Constructor for class com.vonage.client.auth.camara.NetworkAuthMethod
Creates a new Bearer auth method which uses the specified params to exchange for an access token.
NetworkAuthResponseException - Exception Class in com.vonage.client.auth.camara
Response returned when an authentication request fails (i.e. returns a non-2xx status code).
NetworkAuthResponseException() - Constructor for exception class com.vonage.client.auth.camara.NetworkAuthResponseException
 
networkCode - Variable in class com.vonage.client.messages.InboundMessage.Origin
 
NEW_ZEALAND_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
newJwt() - Method in class com.vonage.client.auth.JWTAuthMethod
Convenience method for creating custom JWTs.
nextEventWait(Integer) - Method in class com.vonage.client.verify.Psd2Request.Builder
 
nextEventWait(Integer) - Method in class com.vonage.client.verify.VerifyRequest.Builder
 
nextWorkflow(UUID) - Method in class com.vonage.client.verify2.Verify2Client
Move the request onto the next workflow, if available.
NO_DETAIL - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
No detail field present.
NO_DETAIL - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
No detail field present.
NoAuthMethod - Class in com.vonage.client.auth
Represents a no-op AuthMethod, for when no authentication is necessary.
NoAuthMethod() - Constructor for class com.vonage.client.auth.NoAuthMethod
 
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.
NONE - Enum constant in enum class com.vonage.client.messages.whatsapp.ContextStatus
 
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
 
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
Deprecated.
NotifyEvent() - Constructor for class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
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
Deprecated.
Number is no longer available.
NUMBER_OUT_OF_SERVICE - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
Number is no longer available.
NUMBER_UNREACHABLE - Enum constant in enum class com.vonage.client.sms.MessageStatus
Deprecated.
NUMBER_VERIFICATION_VERIFY_READ - Enum constant in enum class com.vonage.client.auth.camara.FraudPreventionDetectionScope
 
NumberInsight2Client - Class in com.vonage.client.numberinsight2
A client for talking to the Vonage NumberInsight2Client API.
NumberInsight2Client(HttpWrapper) - Constructor for class com.vonage.client.numberinsight2.NumberInsight2Client
Constructor.
NumberInsight2ResponseException - Exception Class in com.vonage.client.numberinsight2
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
NumberInsight2ResponseException() - Constructor for exception class com.vonage.client.numberinsight2.NumberInsight2ResponseException
 
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 Class in com.vonage.client.numbers
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
NumbersResponseException() - Constructor for exception class 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
 
NumberVerificationClient - Class in com.vonage.client.camara.numberverification
A client for communicating with the Vonage Number Verification API.
NumberVerificationClient(HttpWrapper) - Constructor for class com.vonage.client.camara.numberverification.NumberVerificationClient
Create a new NumberVerificationClient.

O

observeForceMute(boolean) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) flag that indicates whether the SIP end point observes force mute moderation (true) or not (false, the default).
OFF - Enum constant in enum class com.vonage.client.meetings.MicrophoneState
 
OFFLINE - Enum constant in enum class com.vonage.client.video.RtmpStatus
The Vonage video platform could not connect to the remote RTMP server.
offset(int) - Method in class com.vonage.client.video.ListStreamCompositionsRequest.Builder
Set an offset query parameters to specify the index offset of the first composition. 0 is offset of the most recently started composition (excluding deleted compositions). 1 is the offset of the composition that started prior to the most recent composition.
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 - Variable in class com.vonage.client.common.HalFilterRequest.Builder
 
order - Variable in class com.vonage.client.common.HalFilterRequest
 
order(SortOrder) - Method in class com.vonage.client.common.HalFilterRequest.Builder
Order to sort the results by.
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.common.MessageType
 
ORDER - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
orderBy(OrderBy) - Method in class com.vonage.client.conversations.ListUserConversationsRequest.Builder
Determines how the results should be compared and ordered.
OrderBy - Enum Class in com.vonage.client.conversations
Result ordering options for ListUserConversationsRequest.
origin - Variable in class com.vonage.client.messages.InboundMessage
 
Origin() - Constructor for class com.vonage.client.messages.InboundMessage.Origin
 
OUTBOUND - Enum constant in enum class com.vonage.client.incoming.CallDirection
Deprecated.
 
OUTBOUND - Enum constant in enum class com.vonage.client.redact.RedactRequest.Type
 
OUTBOUND - Enum constant in enum class com.vonage.client.voice.CallDirection
 
OutboundSettings - Class in com.vonage.client.messages.sms
Represents optional settings for the SMS message in SmsTextRequest.
outputMode(OutputMode) - Method in class com.vonage.client.video.Archive.Builder
Sets the output mode for this archive.
OutputMode - Enum Class in com.vonage.client.video
Defines values used in the Archive.Builder.outputMode(OutputMode) method and returned by the Archive.getOutputMode() method.
OwnedNumber - Class in com.vonage.client.numbers
Represents a number that is being rented by your account.
OwnedNumber() - Constructor for class com.vonage.client.numbers.OwnedNumber
Deprecated.
This will be made private in a future release.

P

page - Variable in class com.vonage.client.common.HalFilterRequest.Builder
 
page - Variable in class com.vonage.client.common.HalFilterRequest
 
page - Variable in class com.vonage.client.common.HalPageResponse
 
page(int) - Method in class com.vonage.client.common.HalFilterRequest.Builder
Page to navigate to in the response.
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
Deprecated.
Will be replaced by HalLinks in a future release.
PageLinks() - Constructor for class com.vonage.client.voice.PageLinks
Deprecated.
 
PAGER - Enum constant in enum class com.vonage.client.account.Network.Type
Deprecated.
PAGER - Enum constant in enum class com.vonage.client.insight.CarrierDetails.NetworkType
 
pageSize - Variable in class com.vonage.client.common.HalFilterRequest.Builder
 
pageSize - Variable in class com.vonage.client.common.HalFilterRequest
 
pageSize - Variable in class com.vonage.client.common.HalPageResponse
 
pageSize(int) - Method in class com.vonage.client.common.HalFilterRequest.Builder
Number of results per page.
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.
Params() - Constructor for class com.vonage.client.conversations.Callback.Params
 
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
 
PARTIAL_SUCCESS - Enum constant in enum class com.vonage.client.insight.LookupOutcome
 
partialCaptions() - Method in class com.vonage.client.video.CaptionsRequest
Whether faster captioning is enabled at the cost of some degree of inaccuracies.
partialCaptions(boolean) - Method in class com.vonage.client.video.CaptionsRequest.Builder
Whether to enable this to faster captioning at the cost of some degree of inaccuracies.
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.
password(String) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) The password corresponding to the username for to be used in the SIP INVITE 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
 
PAUSED - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive is in progress and no clients are publishing streams to the session.
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
 
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
 
PERSONAL - Enum constant in enum class com.vonage.client.numberinsight2.PhoneType
 
phone(String...) - Method in class com.vonage.client.conversations.Conversation.Builder
Sets the PSTN numbers for this conversation.
Phone - Class in com.vonage.client.numberinsight2
Represents details of the phone number in FraudCheckResponse.getPhone().
Phone() - Constructor for class com.vonage.client.numberinsight2.Phone
 
PHONE - Enum constant in enum class com.vonage.client.common.ChannelType
 
PHONE - Enum constant in enum class com.vonage.client.voice.EndpointType
 
PhoneEndpoint - Class in com.vonage.client.voice.ncco
Represents a phone endpoint used in a ConnectAction.
PhoneEndpoint - Class in com.vonage.client.voice
 
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.
PhoneType - Enum Class in com.vonage.client.numberinsight2
Represents the phone type in Phone.getType().
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
 
PIP - Enum constant in enum class com.vonage.client.video.ScreenLayoutType
Picture-in-picture
playId(String) - Method in class com.vonage.client.conversations.AudioPlayStopEvent.Builder
Unique audio play identifier.
playId(UUID) - Method in class com.vonage.client.conversations.AudioPlayStopEvent.Builder
Unique audio play identifier.
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
 
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.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.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
Deprecated.
This will be removed in favour of returning the list of countries' pricing directly.
PrefixPricingResponse() - Constructor for class com.vonage.client.account.PrefixPricingResponse
Deprecated.
 
premium(boolean) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Whether to use the premium version of the text-to-speech voice.
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
 
PREPAID - Enum constant in enum class com.vonage.client.numberinsight2.PhoneType
 
PricingResponse - Class in com.vonage.client.account
Pricing information for a specific country.
PricingResponse() - Constructor for class com.vonage.client.account.PricingResponse
Deprecated.
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
Deprecated.
This API is sunset and will be removed in the next major release.
ProactiveConnectClient(HttpWrapper) - Constructor for class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Constructor.
ProactiveConnectResponseException - Exception Class in com.vonage.client.proactiveconnect
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
ProactiveConnectResponseException() - Constructor for exception class 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.
ProjectDetails - Class in com.vonage.client.video
Represents properties of a video project.
ProjectDetails() - Constructor for class com.vonage.client.video.ProjectDetails
 
ProjectEnvironment - Enum Class in com.vonage.client.video
Represents the project environment type.
ProjectStatus - Enum Class in com.vonage.client.video
Represents the project status.
PROMOTION - Enum constant in enum class com.vonage.client.messages.viber.Category
 
properties(ConversationProperties) - Method in class com.vonage.client.conversations.Conversation.Builder
Properties for this conversation.
proxy(String) - Method in class com.vonage.client.HttpConfig.Builder
Sets the proxy to use for requests.
proxy(URI) - Method in class com.vonage.client.HttpConfig.Builder
Sets the proxy to use for requests.
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 (phone) channel.
PT_BR - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Brazilian Portuguese
PT_BR - Enum constant in enum class com.vonage.client.video.Language
Brazilian Portuguese
publicKey(String) - Method in class com.vonage.client.application.Application.Builder
Sets the application's public key.
PUBLISHER - Enum constant in enum class com.vonage.client.video.Role
A publisher can publish streams, subscribe to streams, and signal.
PUBLISHER_ONLY - Enum constant in enum class com.vonage.client.video.Role
A publisher-only role can publish streams, but not signal.
PUNJABI - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 
PUNJABI - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
PUT - Enum constant in enum class com.vonage.client.common.HttpMethod
 

Q

QueryParamsAuthMethod - Interface in com.vonage.client.auth
Auth methods that are appended to the request's query parameters.
QueryParamsRequest - Interface in com.vonage.client
Indicates that a request object has query parameters.
queue(boolean) - Method in class com.vonage.client.conversations.AudioPlayEvent.Builder
Whether to queue the audio.
queue(boolean) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Whether to queue the audio.

R

RANDOM - Enum constant in enum class com.vonage.client.common.MessageType
 
randomFromNumber(boolean) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
Use a random phone number as from.
RCS - Enum constant in enum class com.vonage.client.messages.Channel
 
RcsCustomRequest - Class in com.vonage.client.messages.rcs
RcsCustomRequest.Builder - Class in com.vonage.client.messages.rcs
 
RcsFileRequest - Class in com.vonage.client.messages.rcs
RcsFileRequest.Builder - Class in com.vonage.client.messages.rcs
 
RcsImageRequest - Class in com.vonage.client.messages.rcs
RcsImageRequest.Builder - Class in com.vonage.client.messages.rcs
 
RcsRequest - Class in com.vonage.client.messages.rcs
Base class for RCS messages.
RcsRequest(RcsRequest.Builder<?, ?>, MessageType) - Constructor for class com.vonage.client.messages.rcs.RcsRequest
 
RcsRequest.Builder<M,B> - Class in com.vonage.client.messages.rcs
 
RcsTextRequest - Class in com.vonage.client.messages.rcs
RcsTextRequest.Builder - Class in com.vonage.client.messages.rcs
 
RcsVideoRequest - Class in com.vonage.client.messages.rcs
RcsVideoRequest.Builder - Class in com.vonage.client.messages.rcs
 
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
 
REACT - Enum constant in enum class com.vonage.client.messages.whatsapp.Reaction.Action
React to a message.
reaction - Variable in class com.vonage.client.messages.InboundMessage
 
reaction(String) - Method in class com.vonage.client.messages.whatsapp.WhatsappReactionRequest.Builder
(REQUIRED unless WhatsappReactionRequest.Builder.unreact() is called) Set the reaction to the message.
Reaction - Class in com.vonage.client.messages.whatsapp
Represents a MessageType.REACTION message.
Reaction() - Constructor for class com.vonage.client.messages.whatsapp.Reaction
Unreact to a message.
Reaction(String) - Constructor for class com.vonage.client.messages.whatsapp.Reaction
Create a new reaction to a message.
REACTION - Enum constant in enum class com.vonage.client.common.MessageType
 
REACTION - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
Reaction.Action - Enum Class in com.vonage.client.messages.whatsapp
Represents the action to be taken.
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
Set to true to record this conversation.
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
Builder for a RecordAction.
RecordEvent - Class in com.vonage.client.incoming
Deprecated.
RecordEvent() - Constructor for class com.vonage.client.incoming.RecordEvent
Deprecated.
 
recordId(String) - Method in class com.vonage.client.conversations.AudioRecordStopEvent.Builder
Unique recording identifier.
recordId(UUID) - Method in class com.vonage.client.conversations.AudioRecordStopEvent.Builder
Unique recording identifier.
recordIndex(Integer) - Method in class com.vonage.client.voice.CallsFilter.Builder
 
Recording - Class in com.vonage.client.meetings
 
Recording() - Constructor for class com.vonage.client.meetings.Recording
 
RECORDING - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
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
A client for talking to the Vonage Redact API.
RedactClient(HttpWrapper) - Constructor for class com.vonage.client.redact.RedactClient
 
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
 
RedactResponseException - Exception Class in com.vonage.client.redact
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
RedactResponseException() - Constructor for exception class com.vonage.client.redact.RedactResponseException
 
redactTransaction(RedactRequest) - Method in class com.vonage.client.redact.RedactClient
Submit a request to the Redact API to redact a transaction.
redactTransaction(String, RedactRequest.Product) - Method in class com.vonage.client.redact.RedactClient
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
Submit a request to the Redact API to redact a transaction.
redirectUri(String) - Method in class com.vonage.client.application.capabilities.NetworkApis.Builder
Sets the Redirect URL.
redirectUri(URI) - Method in class com.vonage.client.application.capabilities.NetworkApis.Builder
Sets the Redirect URL.
redirectUrl(String) - Method in class com.vonage.client.verify2.SilentAuthWorkflow.Builder
(OPTIONAL) Final redirect after VerificationResponse.getCheckUrl().
reference(String) - Method in class com.vonage.client.subaccounts.MoneyTransfer.Builder
(OPTIONAL) Reference for the transfer.
referral - Variable in class com.vonage.client.messages.InboundMessage.Whatsapp
 
Referral - Class in com.vonage.client.messages.whatsapp
This is only present for situations where a user has clicked on a 'WhatsApp' button embedded in an advertisement or post on Facebook.
REFERRAL_CONVERSION - Enum constant in enum class com.vonage.client.messages.whatsapp.ConversationType
 
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.
regionalUriGetter(Function<ApiRegion, String>) - Method in class com.vonage.client.HttpConfig.Builder
Sets a function to get the base URI for a given region.
REJECTED - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
REJECTED - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
REJECTED - Enum constant in enum class com.vonage.client.voice.CallStatus
The call was rejected by Vonage before it was connected.
RELAYED - Enum constant in enum class com.vonage.client.video.MediaMode
The session will attempt to transmit streams directly between clients.
removeArchiveStream(String, String) - Method in class com.vonage.client.video.VideoClient
Removes a stream from a composed archive that was started with the streamMode set to StreamMode.MANUAL.
removeBroadcastStream(String, String) - Method in class com.vonage.client.video.VideoClient
Removes a stream from a live broadcast that was started with the streamMode set to StreamMode.MANUAL.
removeCapabilities(Capability.Type...) - Method in class com.vonage.client.application.Application.Builder
Removes the specified capabilities from the application.
removeCapability(Capability.Type) - Method in class com.vonage.client.application.Application.Builder
Remove a capability from the application.
removeDtmfListener(String) - Method in class com.vonage.client.voice.VoiceClient
Stop receiving updates for asynchronous DTMF events sent by a caller to an InputAction NCCO, when the InputAction.Builder.mode(InputMode) is InputMode.ASYNCHRONOUS.
removeTypeField() - Method in class com.vonage.client.users.channels.Channel
This method makes Channel.getType() return null; effectively the opposite of Channel.setTypeField().
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
 
RenderRequest - Class in com.vonage.client.video
Defines the parameters for starting an Experience Composer session.
RenderRequest.Builder - Class in com.vonage.client.video
Builder for defining the parameters of RenderRequest.
RenderRequest.Properties - Class in com.vonage.client.video
Publisher initial configuration properties for the composed output stream.
RenderResponse - Class in com.vonage.client.video
Represents an Experience Composer response.
RenderResponse() - Constructor for class com.vonage.client.video.RenderResponse
 
RenderStatus - Enum Class in com.vonage.client.video
Represents the possible states in RenderResponse.getStatus().
Reply - Class in com.vonage.client.messages.whatsapp
Used for inbound interactive messages.
REPLY - Enum constant in enum class com.vonage.client.common.MessageType
 
REPLY - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
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
 
RequestQueryParams - Class in com.vonage.client.auth
Represents query parameters in a HTTP request without depending on a specific implementation.
RequestQueryParams() - Constructor for class com.vonage.client.auth.RequestQueryParams
 
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
 
resolution - Variable in class com.vonage.client.video.StreamComposition.Builder
 
resolution - Variable in class com.vonage.client.video.StreamComposition
 
resolution(Resolution) - Method in class com.vonage.client.video.Archive.Builder
Sets the resolution of the archive.
resolution(Resolution) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) The resolution of the broadcast: either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
resolution(Resolution) - Method in class com.vonage.client.video.RenderRequest.Builder
(OPTIONAL) Resolution of the display area for the composition. 1280x720 is the default.
Resolution - Enum Class in com.vonage.client.video
Defines valid video resolutions for an archive.
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
Replaces the base URI used in "rest" endpoints.
RestEndpoint<T,R> - Interface in com.vonage.client
Internal interface for defining endpoints.
RESTRICTED - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Rejected by carrier.
RESTRICTED - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
Rejected by carrier.
Result - Class in com.vonage.client.incoming
Deprecated.
Result() - Constructor for class com.vonage.client.incoming.Result
Deprecated.
 
RETRIEVE_SIM_SWAP_DATE - Enum constant in enum class com.vonage.client.auth.camara.FraudPreventionDetectionScope
 
retrieveSimSwapDate(String) - Method in class com.vonage.client.camara.simswap.SimSwapClient
Get timestamp of last MSISDN to IMSI pairing change for a mobile user account.
revokeOutboundMessage(String, ApiRegion) - Method in class com.vonage.client.messages.MessagesClient
Revokes an outbound message.
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.
ringbackTone(String) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
A URL value that points to a ringback tone to be played back on repeat to the caller, so they don't hear silence.
RINGING - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
RINGING - Enum constant in enum class com.vonage.client.voice.CallStatus
The call is ringing.
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’.
RiskLabel - Enum Class in com.vonage.client.numberinsight2
Represents the risk score values in FraudScore.getLabel().
RiskRecommendation - Enum Class in com.vonage.client.numberinsight2
Represents the risk recommendation in FraudScore.getRiskRecommendation().
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.
role(Role) - Method in class com.vonage.client.video.TokenOptions.Builder
Sets the role for the token.
Role - Enum Class in com.vonage.client.video
Defines values for the role parameter of the TokenOptions.Builder.role(Role role) method.
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
 
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.
ROUTED - Enum constant in enum class com.vonage.client.video.MediaMode
The session will transmit streams using the Media Server.
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
RTC_ANSWER - Enum constant in enum class com.vonage.client.conversations.EventType
RTC call answer.
RTC_ANSWERED - Enum constant in enum class com.vonage.client.conversations.EventType
RTC call has been answered.
RTC_HANGUP - Enum constant in enum class com.vonage.client.conversations.EventType
RTC call has hung up.
RTC_RINGING - Enum constant in enum class com.vonage.client.conversations.EventType
RTC call is ringing.
RTC_STATUS - Enum constant in enum class com.vonage.client.conversations.EventType
RTC status.
RTC_TRANSFER - Enum constant in enum class com.vonage.client.conversations.EventType
RTC call transfer.
Rtc.Builder - Class in com.vonage.client.application.capabilities
 
rtcId(String) - Method in class com.vonage.client.conversations.AudioEarmuffOffEvent.Builder
Unique audio RTC identifier.
rtcId(String) - Method in class com.vonage.client.conversations.AudioEarmuffOnEvent.Builder
Unique audio RTC identifier.
rtcId(String) - Method in class com.vonage.client.conversations.AudioMuteOffEvent.Builder
Unique audio RTC identifier.
rtcId(String) - Method in class com.vonage.client.conversations.AudioMuteOnEvent.Builder
Unique audio RTC identifier.
rtcId(UUID) - Method in class com.vonage.client.conversations.AudioEarmuffOffEvent.Builder
Unique audio RTC identifier.
rtcId(UUID) - Method in class com.vonage.client.conversations.AudioEarmuffOnEvent.Builder
Unique audio RTC identifier.
rtcId(UUID) - Method in class com.vonage.client.conversations.AudioMuteOffEvent.Builder
Unique audio RTC identifier.
rtcId(UUID) - Method in class com.vonage.client.conversations.AudioMuteOnEvent.Builder
Unique audio RTC identifier.
Rtmp - Class in com.vonage.client.video
Represents an RTMP stream in a video session.
Rtmp() - Constructor for class com.vonage.client.video.Rtmp
 
Rtmp(Rtmp.Builder) - Constructor for class com.vonage.client.video.Rtmp
 
Rtmp.Builder - Class in com.vonage.client.video
 
RtmpStatus - Enum Class in com.vonage.client.video
Represents the status of an RTMP stream.
rtmpStreams(Collection<Rtmp>) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL, but REQUIRED if HLS is unspecified) You can specify up to five target RTMP streams (or just one).
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
 

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.
sandbox(boolean) - Method in class com.vonage.client.verify2.SilentAuthWorkflow.Builder
(OPTIONAL) Whether the Vonage Sandbox should be used (for testing purposes).
saveAudio(boolean) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Controls whether the speech input recording (recording_url) is sent to your webhook endpoint at eventUrl.
saveRecording(String, Path) - Method in class com.vonage.client.voice.VoiceClient
Download a recording and save it to a file.
sayId(String) - Method in class com.vonage.client.conversations.AudioSayStopEvent.Builder
Unique audio say identifier.
sayId(UUID) - Method in class com.vonage.client.conversations.AudioSayStopEvent.Builder
Unique audio say identifier.
SCOTTISH_ENGLISH - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
SCREEN - Enum constant in enum class com.vonage.client.video.VideoType
Uses screen sharing on the publisher as the video source.
ScreenLayoutType - Enum Class in com.vonage.client.video
Represents the available layout types for archives in StreamCompositionLayout.
screenshareType(ScreenLayoutType) - Method in class com.vonage.client.video.StreamCompositionLayout.Builder
(OPTIONAL) The layout type to use when there is a screen-sharing stream in the session.
SD_LANDSCAPE - Enum constant in enum class com.vonage.client.video.Resolution
480p landscape (640x480)
SD_PORTRAIT - Enum constant in enum class com.vonage.client.video.Resolution
480p portrait (480x640)
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
Deprecated.
Use SearchNumbersFilter.builder(). This will be removed in the next major release.
SearchNumbersFilter.Builder - Class in com.vonage.client.numbers
Builder for setting the parameters of SearchNumbersFilter.
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.
searchRoomsByTheme(UUID) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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
Represents metadata about an API account secret.
SecretResponse() - Constructor for class com.vonage.client.account.SecretResponse
 
secure(boolean) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) Flag that indicates whether the media must be transmitted encrypted (true) or not (false, the default).
SEGMENTATION - Enum constant in enum class com.vonage.client.proactiveconnect.SourceType
Segmentation
sendDtmf(String, String) - Method in class com.vonage.client.video.VideoClient
Play DTMF tones into a SIP call.
sendDtmf(String, String) - Method in class com.vonage.client.voice.VoiceClient
Send DTMF codes to an ongoing call.
sendDtmf(String, String, String) - Method in class com.vonage.client.video.VideoClient
Play DMTF tones into a specific connection.
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.
sensitivity(int) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Audio sensitivity used to differentiate noise from speech.
sentimentAnalysis(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether to enable sentiment analysis in the recording transcription.
sentimentAnalysis(boolean) - Method in class com.vonage.client.voice.ncco.TranscriptionSettings.Builder
Whether to perform sentiment analysis on the call recording transcription segments.
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
 
SERBIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
serverUrl(String) - Method in class com.vonage.client.video.Rtmp.Builder
(REQUIRED) The RTMP server URL.
SERVICE - Enum constant in enum class com.vonage.client.messages.whatsapp.ConversationType
 
ServiceType - Enum Class in com.vonage.client.account
Represents the service type for pricing requests.
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.
sessionId - Variable in class com.vonage.client.video.StreamComposition.Builder
 
sessionId - Variable in class com.vonage.client.video.StreamComposition
 
sessionId(String) - Method in class com.vonage.client.video.ConnectRequest.Builder
The Vonage Video session ID that includes the Vonage Video streams you want to include in the WebSocket stream.
sessionId(String) - Method in class com.vonage.client.video.ListStreamCompositionsRequest.Builder
Set a sessionId query parameter to list compositions for a specific session ID.
sessionsCallbackUrl(String) - Method in class com.vonage.client.meetings.CallbackUrls.Builder
 
SessionStream - Class in com.vonage.client.video
Represents a stream's metadata in a Vonage Video session.
SessionStream() - Constructor for class com.vonage.client.video.SessionStream
 
SessionStream(SessionStream.Builder) - Constructor for class com.vonage.client.video.SessionStream
 
SessionStream.Builder - Class in com.vonage.client.video
 
setAuthCollection(AuthCollection) - Method in class com.vonage.client.HttpWrapper
Deprecated.
setBinaryData(byte[], byte[]) - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
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
Deprecated.
 
setConfidence(String) - Method in class com.vonage.client.incoming.Result
Deprecated.
This setter will be removed in a future release.
setContentId(String) - Method in class com.vonage.client.sms.messages.Message
 
setContext(Collection<String>) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Deprecated.
Use SpeechSettings.Builder.context(Collection). This will be removed in a future release.
setConversationUuid(String) - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
setCost(String) - Method in class com.vonage.client.numbers.AvailableNumber
Deprecated.
setCountry(String) - Method in class com.vonage.client.numbers.AvailableNumber
Deprecated.
setCountry(String) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setEndOnSilence(Integer) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Deprecated.
Use SpeechSettings.Builder.endOnSilence(double). This will be removed in a future release.
setEntityId(String) - Method in class com.vonage.client.sms.messages.Message
 
setFeatures(String[]) - Method in class com.vonage.client.numbers.AvailableNumber
Deprecated.
setFeatures(String[]) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setFeatures(String[]) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Deprecated.
setHttpClient(HttpClient) - Method in class com.vonage.client.HttpWrapper
Deprecated.
setHttpConfig(HttpConfig) - Method in class com.vonage.client.HttpWrapper
Deprecated.
setIndex(Integer) - Method in class com.vonage.client.numbers.ListNumbersFilter
Deprecated.
setIndex(Integer) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Deprecated.
setLanguage(SpeechSettings.Language) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Deprecated.
Use SpeechSettings.Builder.language(Language). This will be removed in a future release.
setMaxDigits(Integer) - Method in class com.vonage.client.voice.ncco.DtmfSettings
Deprecated.
Use the DtmfSettings.builder(). This will be removed in the next major release.
setMaxDuration(Integer) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Deprecated.
Use SpeechSettings.Builder.maxDuration(int). This will be removed in a future release.
setMessageClass(Message.MessageClass) - Method in class com.vonage.client.sms.messages.Message
 
setMessagesCallbackValue(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
setMoHttpUrl(String) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setMoHttpUrl(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
setMoSmppSysType(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
setMsisdn(String) - Method in class com.vonage.client.numbers.AvailableNumber
Deprecated.
setMsisdn(String) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setNetworkAuth(BackendAuthRequest) - Method in class com.vonage.client.camara.NetworkApiClient
 
setNetworkAuth(TokenRequest) - Method in class com.vonage.client.camara.NetworkApiClient
 
setNetworkCode(String) - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
setPattern(String) - Method in class com.vonage.client.numbers.ListNumbersFilter
Deprecated.
setPattern(String) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Deprecated.
setPayload(Map<String, Object>) - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
setProtocolId(int) - Method in class com.vonage.client.sms.messages.BinaryMessage
 
setResults(Collection<Result>) - Method in class com.vonage.client.incoming.SpeechResults
Deprecated.
This setter will be removed in a future release.
setSearchPattern(SearchPattern) - Method in class com.vonage.client.numbers.ListNumbersFilter
Deprecated.
Use BaseNumbersFilter.Builder.pattern(SearchPattern, String). This will be removed in the next major release.
setSearchPattern(SearchPattern) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Deprecated.
Use BaseNumbersFilter.Builder.pattern(SearchPattern, String). This will be removed in the next major release.
setSessionId(String) - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
setSize(Integer) - Method in class com.vonage.client.numbers.ListNumbersFilter
Deprecated.
setSize(Integer) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Deprecated.
setStartTimeout(Integer) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Deprecated.
Use SpeechSettings.Builder.startTimeout(int). This will be removed in a future release.
setStatusReportRequired(boolean) - Method in class com.vonage.client.sms.messages.Message
Set the value of the 'status-report-req' parameter.
setStreamLayout(String, SessionStream...) - Method in class com.vonage.client.video.VideoClient
Use this method to change layout classes for a Vonage Video stream.
setStreamLayout(String, List<SessionStream>) - Method in class com.vonage.client.video.VideoClient
Use this method to change layout classes for a Vonage Video stream.
setSubmitOnHash(Boolean) - Method in class com.vonage.client.voice.ncco.DtmfSettings
Deprecated.
Use the DtmfSettings.builder(). This will be removed in the next major release.
setText(String) - Method in class com.vonage.client.incoming.Result
Deprecated.
This setter will be removed in a future release.
setTextData(String, String) - Method in class com.vonage.client.sms.callback.messages.MO
Deprecated.
 
setTimeOut(Integer) - Method in class com.vonage.client.voice.ncco.DtmfSettings
Deprecated.
Use the DtmfSettings.builder(). This will be removed in the next major release.
setTimeoutReason(SpeechResults.TimeoutReason) - Method in class com.vonage.client.incoming.SpeechResults
Deprecated.
This setter will be removed in a future release.
setTimestamp(Date) - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
setTimeToLive(Long) - Method in class com.vonage.client.sms.messages.Message
 
SettingsRequest - Class in com.vonage.client.account
Deprecated.
This will be made package-private in the next major release.
SettingsRequest(String, String) - Constructor for class com.vonage.client.account.SettingsRequest
Deprecated.
Constructor.
SettingsResponse - Class in com.vonage.client.account
Details of the configured account settings.
SettingsResponse() - Constructor for class com.vonage.client.account.SettingsResponse
Deprecated.
setType(Type) - Method in class com.vonage.client.numbers.SearchNumbersFilter
Deprecated.
setType(RedactRequest.Type) - Method in class com.vonage.client.redact.RedactRequest
 
setType(String) - Method in class com.vonage.client.numbers.AvailableNumber
Deprecated.
setType(String) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setTypeField() - Method in class com.vonage.client.users.channels.Channel
Sets the Channel.getType() based on this class's type.
setUuid(Collection<String>) - Method in class com.vonage.client.voice.ncco.SpeechSettings
Deprecated.
Use SpeechSettings.Builder.uuid(String). This will be removed in a future release.
setVoiceCallbackType(UpdateNumberRequest.CallbackType) - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
setVoiceCallbackType(String) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setVoiceCallbackValue(String) - Method in class com.vonage.client.numbers.OwnedNumber
Deprecated.
setVoiceCallbackValue(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
setVoiceStatusCallback(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
shortCompanyUrl(String) - Method in class com.vonage.client.meetings.Theme.Builder
(OPTIONAL) The short company URL.
signal(String, String, SignalRequest) - Method in class com.vonage.client.video.VideoClient
Sends signal to a specific participant in an active Vonage Video session.
signalAll(String, SignalRequest) - Method in class com.vonage.client.video.VideoClient
Sends signals to all participants in an active Vonage Video session.
SignalRequest - Class in com.vonage.client.video
 
SignalRequest.Builder - Class in com.vonage.client.video
 
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.Rtc.Builder
Set whether to use signed webhooks.
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.
SilentAuthWorkflow(String, boolean, String) - Constructor for class com.vonage.client.verify2.SilentAuthWorkflow
Constructs a new Silent Auth verification workflow.
SilentAuthWorkflow.Builder - Class in com.vonage.client.verify2
Builder for constructing a Silent Authentication workflow.
SIM_SWAP - Enum constant in enum class com.vonage.client.numberinsight2.Insight
 
SimSwap - Class in com.vonage.client.numberinsight2
Represents the sim swap insight results in FraudCheckResponse.getSimSwap().
SimSwap() - Constructor for class com.vonage.client.numberinsight2.SimSwap
 
SimSwapClient - Class in com.vonage.client.camara.simswap
A client for communicating with the Vonage SIM Swap API.
SimSwapClient(HttpWrapper) - Constructor for class com.vonage.client.camara.simswap.SimSwapClient
Create a new SimSwapClient.
SimSwapStatus - Enum Class in com.vonage.client.numberinsight2
Represents the status in SimSwap.getStatus().
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.common.ChannelType
 
SIP - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
SIP - Enum constant in enum class com.vonage.client.voice.EndpointType
 
SIP_AMD_MACHINE - Enum constant in enum class com.vonage.client.conversations.EventType
SIP call encountered machine using Advanced Machine Detection.
SIP_ANSWERED - Enum constant in enum class com.vonage.client.conversations.EventType
SIP call has been answered.
SIP_HANGUP - Enum constant in enum class com.vonage.client.conversations.EventType
SIP call has been hung up.
SIP_MACHINE - Enum constant in enum class com.vonage.client.conversations.EventType
SIP call encountered machine.
SIP_RINGING - Enum constant in enum class com.vonage.client.conversations.EventType
SIP call is ringing.
SIP_STATUS - Enum constant in enum class com.vonage.client.conversations.EventType
Status of SIP.
sipDial(SipDialRequest) - Method in class com.vonage.client.video.VideoClient
Use this method to connect your SIP platform to a Vonage video session.
SipDialRequest - Class in com.vonage.client.video
Represents an outbound SIP dial request's properties.
SipDialRequest.Builder - Class in com.vonage.client.video
Used to create an SipDialRequest object.
SipDialResponse - Class in com.vonage.client.video
Represents a Vonage Video SIP call.
SipDialResponse() - Constructor for class com.vonage.client.video.SipDialResponse
 
SipEndpoint - Class in com.vonage.client.voice.ncco
Represents a SIP endpoint used in a ConnectAction.
SipEndpoint - Class in com.vonage.client.voice
Endpoint for connecting to a SIP URI.
SipEndpoint() - Constructor for class com.vonage.client.voice.SipEndpoint
 
SipEndpoint(String) - Constructor for class com.vonage.client.voice.SipEndpoint
Creates a new SIP endpoint request.
SipEndpoint(String, String) - Constructor for class com.vonage.client.voice.SipEndpoint
Creates a new SIP endpoint request.
SipEndpoint(String, Map<String, ?>) - Constructor for class com.vonage.client.voice.SipEndpoint
Creates a new SIP endpoint request.
SipEndpoint(String, Map<String, ?>, String) - Constructor for class com.vonage.client.voice.SipEndpoint
Creates a new SIP endpoint request.
SipEndpoint.Builder - Class in com.vonage.client.voice.ncco
 
SipHeader - Enum Class in com.vonage.client.voice
Represents standard headers for SIP Connect endpoint.
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.common.ChannelType
 
SMS - Enum constant in enum class com.vonage.client.conversion.ConversionRequest.Type
Deprecated.
 
SMS - Enum constant in enum class com.vonage.client.messages.Channel
 
SMS - Enum constant in enum class com.vonage.client.numbers.Feature
 
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 - Enum constant in enum class com.vonage.client.verify2.FragmentChannel
 
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
Deprecated.
This will be made private in the next major release.
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
Deprecated.
SmsWorkflow(String, String, String) - Constructor for class com.vonage.client.verify2.SmsWorkflow
Deprecated.
SmsWorkflow.Builder - Class in com.vonage.client.verify2
Builder class for an SMS workflow.
socketTimeout(int) - Method in class com.vonage.client.common.Webhook.Builder
Deprecated.
(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.
SortOrder - Enum Class in com.vonage.client.common
Represents the sort order for resources returned.
SortOrder - Enum Class in com.vonage.client.proactiveconnect
Deprecated.
Replaced by SortOrder and will be removed in future release.
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_GALICIAN - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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.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.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_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
Automatic Speech Recognition (ASR) settings to enable speech input.
SpeechResults - Class in com.vonage.client.incoming
Deprecated.
SpeechResults - Class in com.vonage.client.voice
Represents the speech recognition results in EventWebhook.getSpeech().
SpeechResults() - Constructor for class com.vonage.client.incoming.SpeechResults
Deprecated.
 
SpeechResults() - Constructor for class com.vonage.client.voice.SpeechResults
 
SpeechResults.TimeoutReason - Enum Class in com.vonage.client.incoming
Deprecated.
Represents the timeout reason in SpeechResults.getTimeoutReason().
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
Deprecated.
This will be made private in a future release. Use SpeechSettings.builder().
SpeechSettings.Builder - Class in com.vonage.client.voice.ncco
Builder for customising SpeechSettings parameters.
SpeechSettings.Language - Enum Class in com.vonage.client.voice.ncco
 
SpeechTimeoutReason - Enum Class in com.vonage.client.voice
Represents the timeout reason in SpeechResults.getTimeoutReason().
SpeechTranscript - Class in com.vonage.client.voice
Represents speech to text data contained in SpeechResults.getResults().
SpeechTranscript() - Constructor for class com.vonage.client.voice.SpeechTranscript
 
split(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether the recording should be split.
split(SplitRecording) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
SplitRecording - Enum Class in com.vonage.client.voice.ncco
 
ssml(boolean) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Whether to enable Synthesized Speech Markup Language (SSML).
STANDARD - Enum constant in enum class com.vonage.client.video.ProjectEnvironment
 
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
Deprecated.
 
START_TIMEOUT - Enum constant in enum class com.vonage.client.voice.SpeechTimeoutReason
 
startCaptions(CaptionsRequest) - Method in class com.vonage.client.video.VideoClient
Start real-time Live Captions for a Vonage Video Session.
startDate - Variable in class com.vonage.client.common.HalFilterRequest.Builder
 
startDate - Variable in class com.vonage.client.common.HalFilterRequest
 
startDate(Instant) - Method in class com.vonage.client.common.HalFilterRequest.Builder
Filter records that occurred after this point in time.
startDate(Instant) - Method in class com.vonage.client.conversations.ListConversationsRequest.Builder
 
startDate(Instant) - Method in class com.vonage.client.conversations.ListUserConversationsRequest.Builder
 
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
Deprecated.
 
STARTED - Enum constant in enum class com.vonage.client.meetings.RecordingStatus
 
STARTED - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive recording has started and is in progress.
STARTED - Enum constant in enum class com.vonage.client.video.BroadcastStatus
The broadcast is live (started).
STARTED - Enum constant in enum class com.vonage.client.video.RenderStatus
The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to a Vonage Video stream.
STARTED - Enum constant in enum class com.vonage.client.voice.CallStatus
Indicates that the call has been created.
startId(int) - Method in class com.vonage.client.conversations.ListEventsRequest.Builder
The ID to start returning events at.
STARTING - Enum constant in enum class com.vonage.client.video.RenderStatus
The Vonage Video API platform is in the process of connecting to the remote application at the URL provided.
startOnEnter(Boolean) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
The default value of true ensures that the conversation starts when this caller joins the conversation.
startRender(RenderRequest) - Method in class com.vonage.client.video.VideoClient
Create an Experience Composer for a Vonage Video session.
STARTS_WITH - Enum constant in enum class com.vonage.client.numbers.SearchPattern
Search for numbers that start with the pattern (Note: all numbers are in E.164 format, so the starting pattern includes the country code, such as 1 for USA).
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
startTimeout(int) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
Controls how long the system will wait for the user to start speaking.
state(MemberState) - Method in class com.vonage.client.conversations.ListUserConversationsRequest.Builder
Only include conversations with this member state.
state(MemberState) - Method in class com.vonage.client.conversations.Member.Builder
(REQUIRED) Invite or join a member to a conversation.
state(MemberState) - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
(REQUIRED) State to transition the member into.
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
Deprecated.
 
statusCallbackUrl(String) - Method in class com.vonage.client.video.CaptionsRequest.Builder
A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
statusCode - Variable in exception class 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.common.MessageType
 
STICKER - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
stopArchive(String) - Method in class com.vonage.client.video.VideoClient
Archives stop recording after 4 hours (14,400 seconds), or 60 seconds after the last client disconnects from the session, or 60 minutes after the last client stops publishing.
stopBroadcast(String) - Method in class com.vonage.client.video.VideoClient
Stop a live broadcast.
stopCaptions(String) - Method in class com.vonage.client.video.VideoClient
Stop live captions for a session.
STOPPED - Enum constant in enum class com.vonage.client.meetings.RecordingStatus
 
STOPPED - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive recording has stopped, but the file is not available.
STOPPED - Enum constant in enum class com.vonage.client.video.BroadcastStatus
The broadcast has ended (stopped).
STOPPED - Enum constant in enum class com.vonage.client.video.RenderStatus
The Experience Composer has stopped.
stopRender(String) - Method in class com.vonage.client.video.VideoClient
Stop an active Experience Composer.
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
 
StreamComposition - Class in com.vonage.client.video
Base class for Broadcast and Archive.
StreamComposition() - Constructor for class com.vonage.client.video.StreamComposition
 
StreamComposition(StreamComposition.Builder) - Constructor for class com.vonage.client.video.StreamComposition
 
StreamComposition.Builder - Class in com.vonage.client.video
 
StreamCompositionLayout - Class in com.vonage.client.video
StreamCompositionLayout() - Constructor for class com.vonage.client.video.StreamCompositionLayout
 
StreamCompositionLayout.Builder - Class in com.vonage.client.video
 
streamed(boolean) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Whether the audio recording is streamed.
streamMode - Variable in class com.vonage.client.video.StreamComposition.Builder
 
streamMode - Variable in class com.vonage.client.video.StreamComposition
 
streamMode(StreamMode) - Method in class com.vonage.client.video.Archive.Builder
Sets the stream mode for this archive.
streamMode(StreamMode) - Method in class com.vonage.client.video.Broadcast.Builder
(OPTIONAL) Whether streams included in the broadcast are selected automatically ("auto", the default) or manually ("manual").
StreamMode - Enum Class in com.vonage.client.video
Defines values for how streams will be selected for broadcasts and archives.
streamName(String) - Method in class com.vonage.client.video.Rtmp.Builder
(REQUIRED) Sets the stream name, such as the YouTube Live stream name or the Facebook stream key.
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
 
streams - Variable in class com.vonage.client.video.StreamComposition
 
streams(String...) - Method in class com.vonage.client.video.ConnectRequest.Builder
(OPTIONAL) An array of stream IDs for the Vonage Video streams you want to include in the WebSocket audio.
streams(Collection<String>) - Method in class com.vonage.client.video.ConnectRequest.Builder
A collection of stream IDs for the Vonage Video streams you want to include in the WebSocket audio.
streamUrl(String) - Method in class com.vonage.client.conversations.AudioPlayEvent.Builder
Source URL of the audio to play.
streamUrl(String...) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
streamUrl(URI) - Method in class com.vonage.client.conversations.AudioPlayEvent.Builder
Source URL of the audio to play.
streamUrl(Collection<String>) - Method in class com.vonage.client.voice.ncco.StreamAction.Builder
 
style(int) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
Text-to-speech voice style.
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
 
stylesheet(String) - Method in class com.vonage.client.video.StreamCompositionLayout.Builder
Used for the ScreenLayoutType.CUSTOM layout to define the visual layout.
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 Class in com.vonage.client.subaccounts
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
SubaccountsResponseException() - Constructor for exception class 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.
submitOnHash(boolean) - Method in class com.vonage.client.voice.ncco.DtmfSettings.Builder
Set to true so the callee's activity is sent to your webhook endpoint at eventUrl after they press #.
SUBMITTED - Enum constant in enum class com.vonage.client.messages.MessageStatus.Status
 
submittedAt - Variable in class com.vonage.client.verify2.VerificationCallback
 
SUBSCRIBER - Enum constant in enum class com.vonage.client.video.Role
A subscriber can only subscribe to streams.
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.
SUSPENDED - Enum constant in enum class com.vonage.client.video.ProjectStatus
Suspended (you will not be able to use the project API key).
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
 
SYNCHRONOUS - Enum constant in enum class com.vonage.client.voice.ncco.EventType
 
SYNCHRONOUS - Enum constant in enum class com.vonage.client.voice.ncco.InputMode
Process input synchronously (the default).
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 - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
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
 
TELUGU - Enum constant in enum class com.vonage.client.voice.TextToSpeechLanguage
 
Template - Class in com.vonage.client.messages.whatsapp
 
Template - Class in com.vonage.client.verify2
Represents a custom template.
TEMPLATE - Enum constant in enum class com.vonage.client.common.MessageType
 
TEMPLATE - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
TemplateFragment - Class in com.vonage.client.verify2
Represents a custom template fragment.
TemplateFragment(FragmentChannel, String, String) - Constructor for class com.vonage.client.verify2.TemplateFragment
Create a new template fragment.
terminateCall(String) - Method in class com.vonage.client.voice.VoiceClient
Modify a call with the ModifyCallAction.HANGUP action.
text - Variable in class com.vonage.client.messages.InboundMessage
 
text(String) - Method in class com.vonage.client.conversations.AudioSayEvent.Builder
(REQUIRED) Text to be spoken.
text(String) - Method in class com.vonage.client.conversations.MessageEvent.Builder
Sets the message text, if the type is MessageType.TEXT.
text(String) - Method in class com.vonage.client.conversations.UpdateMemberRequest.Builder
Reason text for leaving.
text(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(REQUIRED) Sets the text field.
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.rcs.RcsTextRequest.Builder
The text of the message to send.
text(String) - Method in class com.vonage.client.messages.sms.SmsTextRequest.Builder
(REQUIRED) Sets the text field.
text(String) - Method in interface com.vonage.client.messages.TextMessageRequest.Builder
Sets the text of the message request.
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.TalkAction.Builder
 
TEXT - Enum constant in enum class com.vonage.client.common.MessageType
 
TEXT - Enum constant in enum class com.vonage.client.incoming.MessageType
Deprecated.
 
TEXT - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
TEXT - Enum constant in enum class com.vonage.client.messages.sms.EncodingType
 
TEXT - Enum constant in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
Deprecated.
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
TEXT - Enum constant in enum class com.vonage.client.sms.MessageType
 
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
TextMessageRequest - Interface in com.vonage.client.messages
Convenience interface to indicate that MessageRequest.getMessageType() is MessageType.TEXT.
TextMessageRequest.Builder<B> - Interface in com.vonage.client.messages
Interface for builders where MessageRequest.getMessageType() is MessageType.TEXT.
TextToSpeechLanguage - Enum Class in com.vonage.client.voice
Enum representing the available TTS language options.
TH_TH - Enum constant in enum class com.vonage.client.video.Language
Thai
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
 
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(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(int) - Method in class com.vonage.client.voice.ncco.DtmfSettings.Builder
The result of the callee's activity is sent to the eventUrl webhook endpoint timeOut seconds after the last action.
timeOut(Integer) - Method in class com.vonage.client.voice.ncco.ConnectAction.Builder
If the call is unanswered, set the number in seconds before Vonage stops ringing endpoint.
timeOut(Integer) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
 
TIMEOUT - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
TIMEOUT - Enum constant in enum class com.vonage.client.voice.CallStatus
The duration of the ringing phase exceeded the specified ringing timeout duration.
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 class com.vonage.client.VonageApiResponseException
 
to - Variable in class com.vonage.client.messages.InboundMessage
 
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.Builder
 
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.
to(String) - Method in class com.vonage.client.verify2.Workflow.Builder
 
toByteArray() - Method in interface com.vonage.client.BinaryRequest
Serialises this request to a byte array.
toChannel(Channel) - Method in class com.vonage.client.conversations.Member.Builder
(OPTIONAL) Concrete channel to use when receiving messages.
toJson() - Method in interface com.vonage.client.Jsonable
Serialises this class to a JSON payload.
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.ncco.Ncco
 
toJson() - Method in exception class com.vonage.client.VonageApiResponseException
Generates JSON from this object.
token(String) - Method in class com.vonage.client.video.ConnectRequest.Builder
(REQUIRED) A valid Vonage Video token for the Audio Connector connection to the Vonage Video Session.
TokenOptions - Class in com.vonage.client.video
Defines values for the options parameter of the VideoClient.generateToken(String sessionId, TokenOptions tokenOptions) method.
TokenOptions.Builder - Class in com.vonage.client.video
Use this class to create a TokenOptions object.
TokenRequest - Class in com.vonage.client.auth.camara
Represents the request parameters for the intermediate (second) step in an OAuth2 three-legged workflow.
TokenRequest(String) - Constructor for class com.vonage.client.auth.camara.TokenRequest
Creates a new Back-End token request.
TokenRequest(URI, String) - Constructor for class com.vonage.client.auth.camara.TokenRequest
Creates a new Front-End token request.
TokenResponse - Class in com.vonage.client.auth.camara
 
TOLL_FREE - Enum constant in enum class com.vonage.client.numberinsight2.PhoneType
 
toLog() - Method in class com.vonage.client.voice.AppEndpoint
 
toLog() - Method in interface com.vonage.client.voice.Endpoint
Deprecated.
This method will be removed in the next major release.
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
 
toMap() - Method in class com.vonage.client.auth.RequestQueryParams
 
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.
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.ApiRegion
 
toString() - Method in enum class com.vonage.client.application.capabilities.Region
 
toString() - Method in enum class com.vonage.client.auth.camara.FraudPreventionDetectionScope
 
toString() - Method in enum class com.vonage.client.common.ChannelType
 
toString() - Method in class com.vonage.client.common.E164
 
toString() - Method in enum class com.vonage.client.common.MessageType
 
toString() - Method in enum class com.vonage.client.common.SortOrder
 
toString() - Method in enum class com.vonage.client.conversations.ConversationStatus
 
toString() - Method in enum class com.vonage.client.conversations.EventType
 
toString() - Method in enum class com.vonage.client.conversations.OrderBy
 
toString() - Method in class com.vonage.client.incoming.NotifyEvent
Deprecated.
 
toString() - Method in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
Deprecated.
 
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 class com.vonage.client.JsonableBaseObject
 
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.meetings.ThemeDomain
 
toString() - Method in enum class com.vonage.client.messages.Channel
 
toString() - Method in enum class com.vonage.client.messages.MessageStatus.Status
 
toString() - Method in enum class com.vonage.client.messages.MessagesVersion
 
toString() - Method in enum class com.vonage.client.messages.MessageType
Deprecated.
 
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.sms.EncodingType
 
toString() - Method in enum class com.vonage.client.messages.viber.Category
 
toString() - Method in enum class com.vonage.client.messages.whatsapp.ContextStatus
 
toString() - Method in enum class com.vonage.client.messages.whatsapp.ConversationType
 
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.messages.whatsapp.Reaction.Action
 
toString() - Method in enum class com.vonage.client.numberinsight2.Insight
 
toString() - Method in enum class com.vonage.client.numbers.Feature
 
toString() - Method in enum class com.vonage.client.numbers.Type
 
toString() - Method in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
 
toString() - Method in enum class com.vonage.client.proactiveconnect.EventType
 
toString() - Method in enum class com.vonage.client.proactiveconnect.SortOrder
Deprecated.
 
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 enum class com.vonage.client.sms.MessageType
 
toString() - Method in class com.vonage.client.sms.SmsSubmissionResponseMessage
 
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.FragmentChannel
 
toString() - Method in enum class com.vonage.client.verify2.VerificationStatus
 
toString() - Method in enum class com.vonage.client.video.ArchiveMode
 
toString() - Method in enum class com.vonage.client.video.ArchiveStatus
 
toString() - Method in enum class com.vonage.client.video.BroadcastStatus
 
toString() - Method in enum class com.vonage.client.video.Language
 
toString() - Method in enum class com.vonage.client.video.MediaMode
 
toString() - Method in enum class com.vonage.client.video.OutputMode
 
toString() - Method in enum class com.vonage.client.video.ProjectEnvironment
 
toString() - Method in enum class com.vonage.client.video.ProjectStatus
 
toString() - Method in enum class com.vonage.client.video.RenderStatus
 
toString() - Method in enum class com.vonage.client.video.Resolution
 
toString() - Method in enum class com.vonage.client.video.Role
 
toString() - Method in enum class com.vonage.client.video.RtmpStatus
 
toString() - Method in enum class com.vonage.client.video.ScreenLayoutType
 
toString() - Method in enum class com.vonage.client.video.StreamMode
 
toString() - Method in enum class com.vonage.client.video.VideoType
 
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.CallStatusDetail
 
toString() - Method in enum class com.vonage.client.voice.EndpointType
 
toString() - Method in enum class com.vonage.client.voice.MachineDetection
 
toString() - Method in enum class com.vonage.client.voice.MachineDetectionStatus
 
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.InputMode
 
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.SipHeader
 
toString() - Method in enum class com.vonage.client.voice.SpeechTimeoutReason
 
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
 
transcription(TranscriptionSettings) - Method in class com.vonage.client.voice.ncco.ConversationAction.Builder
Transcription settings.
transcription(TranscriptionSettings) - Method in class com.vonage.client.voice.ncco.RecordAction.Builder
Set this parameter to a non-null value to transcribe the recording.
TranscriptionSettings - Class in com.vonage.client.voice.ncco
Customisable settings for call recording transcription.
TranscriptionSettings.Builder - Class in com.vonage.client.voice.ncco
Builder for setting the TranscriptionSettings parameters.
TRANSFER - Enum constant in enum class com.vonage.client.voice.CallStatus
A leg has been transferred from one conversation to another.
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) - Method in class com.vonage.client.voice.VoiceClient
Transfer a call to a different NCCO.
transferCall(String, String) - Method in class com.vonage.client.voice.VoiceClient
Transfer a call to a different NCCO endpoint.
transferCredit(MoneyTransfer) - Method in class com.vonage.client.subaccounts.SubaccountsClient
Transfer credit limit between the primary account and one of its subaccounts.
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.MessageRequest
 
ttl - Variable in class com.vonage.client.messages.viber.ViberRequest.Builder
 
ttl(int) - Method in class com.vonage.client.messages.MessageRequest.Builder
(OPTIONAL) The duration in milliseconds the delivery of a message will be attempted.
ttl(int) - Method in class com.vonage.client.messages.mms.MmsRequest.Builder
(OPTIONAL) Time-To-Live (how long a message should exist before it is delivered successfully) in seconds.
ttl(int) - Method in class com.vonage.client.messages.rcs.RcsRequest.Builder
 
ttl(int) - Method in class com.vonage.client.messages.sms.SmsTextRequest.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.
ttl(Integer) - Method in class com.vonage.client.conversations.ConversationProperties.Builder
Number of seconds after which an empty conversation is deleted.
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
 
type - Variable in class com.vonage.client.proactiveconnect.Datasource
 
type - Variable in class com.vonage.client.users.channels.Channel
 
type - Variable in class com.vonage.client.verify2.VerificationCallback
 
type - Variable in exception class com.vonage.client.VonageApiResponseException
 
type(RoomType) - Method in class com.vonage.client.meetings.MeetingRoom.Builder
Type of room.
type(Type) - Method in class com.vonage.client.numbers.SearchNumbersFilter.Builder
Set this parameter to filter the type of number, such as mobile or landline.
type(String) - Method in class com.vonage.client.conversations.ConversationProperties.Builder
Conversation type.
type(String) - Method in class com.vonage.client.video.SignalRequest.Builder
(REQUIRED) Type of data that is being sent to the client.
type(Collection<String>) - Method in class com.vonage.client.voice.ncco.InputAction.Builder
Deprecated.
Use InputAction.Builder.dtmf(DtmfSettings) and InputAction.Builder.speech(SpeechSettings) instead. The type will be set automatically based on the provided settings.
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
Deprecated.
 
UNANSWERED - Enum constant in enum class com.vonage.client.voice.CallStatus
Either the recipient is unreachable or the recipient declined the call.
UNAVAILABLE - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Callee is temporarily unavailable.
UNAVAILABLE - Enum constant in enum class com.vonage.client.messages.whatsapp.ContextStatus
 
UNAVAILABLE - Enum constant in enum class com.vonage.client.voice.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
 
unearmuffCall(String) - Method in class com.vonage.client.voice.VoiceClient
Modify a call with the ModifyCallAction.UNEARMUFF action.
UNICODE - Enum constant in enum class com.vonage.client.incoming.MessageType
Deprecated.
 
UNICODE - Enum constant in enum class com.vonage.client.messages.sms.EncodingType
 
UNICODE - Enum constant in enum class com.vonage.client.sms.callback.messages.MO.MESSAGE_TYPE
Deprecated.
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
UNICODE - Enum constant in enum class com.vonage.client.sms.MessageType
 
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
Deprecated.
 
UNKNOWN - Enum constant in enum class com.vonage.client.conversations.EventType
Event type is not defined in this enum.
UNKNOWN - Enum constant in enum class com.vonage.client.conversations.MemberState
 
UNKNOWN - Enum constant in enum class com.vonage.client.incoming.CallDirection
Deprecated.
 
UNKNOWN - Enum constant in enum class com.vonage.client.incoming.CallStatus
Deprecated.
 
UNKNOWN - Enum constant in enum class com.vonage.client.incoming.MessageType
Deprecated.
 
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.sms.MessageType
 
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 status or event.
UNKNOWN - Enum constant in enum class com.vonage.client.voice.MachineDetection
 
UNKNOWN - Enum constant in enum class com.vonage.client.voice.MachineDetectionStatus
Unmapped value.
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.SpeechTimeoutReason
 
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 - Enum constant in enum class com.vonage.client.numberinsight2.PhoneType
 
UNMAPPED_DETAIL - Enum constant in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Detail present, but has not been mapped to an enum yet.
UNMAPPED_DETAIL - Enum constant in enum class com.vonage.client.voice.CallStatusDetail
Detail present, but has not been mapped to an enum yet.
UNMUTE - Enum constant in enum class com.vonage.client.voice.ModifyCallAction
 
unmuteCall(String) - Method in class com.vonage.client.voice.VoiceClient
Modify a call with the ModifyCallAction.UNMUTE action.
unreact() - Method in class com.vonage.client.messages.whatsapp.WhatsappReactionRequest.Builder
(REQUIRED unless WhatsappReactionRequest.Builder.reaction(String) is called) Unreact to the message.
UNREACT - Enum constant in enum class com.vonage.client.messages.whatsapp.Reaction.Action
Remove a reaction to a message.
UNSUPPORTED - Enum constant in enum class com.vonage.client.common.MessageType
 
UNSUPPORTED - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
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
Deprecated.
Update an existing application.
UpdateApplicationRequest - Class in com.vonage.client.meetings
 
UpdateApplicationRequest.Builder - Class in com.vonage.client.meetings
 
updateArchiveLayout(String, StreamCompositionLayout) - Method in class com.vonage.client.video.VideoClient
Dynamically change the layout type of a composed archive while it is being recorded.
updateBroadcastLayout(String, StreamCompositionLayout) - Method in class com.vonage.client.video.VideoClient
Dynamically change the layout type of a live streaming broadcast.
updateConversation(String, Conversation) - Method in class com.vonage.client.conversations.ConversationsClient
Update an existing conversation's settings / parameters.
updateDeliveryReceiptUrl(String) - Method in class com.vonage.client.account.AccountClient
Updates the account-level delivery receipt URL (mainly used by the SMS API).
updateFromJson(String) - Method in class com.vonage.client.incoming.MessageEvent
Deprecated.
 
updateFromJson(String) - Method in interface com.vonage.client.Jsonable
Updates this class's fields from the JSON payload.
updateFromJson(String) - Method in class com.vonage.client.verify.CheckResponse
 
updateFromJson(String) - Method in class com.vonage.client.verify.SearchVerifyResponse
 
updateFromJson(String) - Method in class com.vonage.client.verify2.Template
 
updateFromJson(String) - Method in class com.vonage.client.verify2.TemplateFragment
 
updateList(UUID, ContactsList) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Update an existing list.
updateListItem(UUID, UUID, Map<String, ?>) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
Update an existing list item.
updateMember(UpdateMemberRequest) - Method in class com.vonage.client.conversations.ConversationsClient
Update an existing member's state.
UpdateMemberRequest - Class in com.vonage.client.conversations
Options for updating a membership using ConversationsClient.updateMember(UpdateMemberRequest).
UpdateMemberRequest.Builder - Class in com.vonage.client.conversations
Builder for constructing an UpdateMemberRequest.
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
Defines properties for updating an existing owned number.
UpdateNumberRequest(String, String) - Constructor for class com.vonage.client.numbers.UpdateNumberRequest
Deprecated.
Use UpdateNumberRequest.builder(String, String). This will be removed in the next major release.
UpdateNumberRequest.Builder - Class in com.vonage.client.numbers
Builder for specifying the properties of the number to update.
UpdateNumberRequest.CallbackType - Enum Class in com.vonage.client.numbers
Represents the callback type for voice.
updateRoom(UUID, UpdateRoomRequest) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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
Updates the account-level incoming SMS URL, as used by the SMS API.
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
 
updateTemplate(UUID, String, Boolean) - Method in class com.vonage.client.verify2.Verify2Client
Update an existing template.
updateTemplateFragment(UUID, UUID, String) - Method in class com.vonage.client.verify2.Verify2Client
Update an existing template fragment.
updateTheme(UUID, Theme) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
Update an existing theme.
updateThemeLogo(UUID, LogoType, Path) - Method in class com.vonage.client.meetings.MeetingsClient
Deprecated.
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
 
UPLOADED - Enum constant in enum class com.vonage.client.video.ArchiveStatus
The archive is available for download from the upload target Amazon S3 bucket or Windows Azure container you set up for your Vonage video project.
uploadListItems(UUID, Path) - Method in class com.vonage.client.proactiveconnect.ProactiveConnectClient
Deprecated.
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.video.ConnectRequest.Builder
(REQUIRED) A publicly reachable WebSocket URI to be used for the destination of the audio stream.
uri(String) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
Sets the URI.
uri(String) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
uri(URI) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
Sets the URI.
uri(URI) - Method in class com.vonage.client.voice.ncco.WebSocketEndpoint.Builder
 
uri(URI, boolean) - Method in class com.vonage.client.video.SipDialRequest.Builder
(REQUIRED) The SIP URI to be used as destination of the SIP call initiated from Vonage to your SIP platform.
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.conversations.Callback.Builder
Event URL for the callback.
url(String) - Method in class com.vonage.client.conversations.MessageEvent.Builder
Sets the URL, if appropriate for the type.
url(String) - Method in interface com.vonage.client.messages.MediaMessageRequest.Builder
Sets the media URL of the message request.
url(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(REQUIRED) Sets the media URL.
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.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.rcs.RcsFileRequest.Builder
(REQUIRED) The publicly accessible URL of the file attachment.
url(String) - Method in class com.vonage.client.messages.rcs.RcsImageRequest.Builder
(REQUIRED) The publicly accessible URL of the image attachment.
url(String) - Method in class com.vonage.client.messages.rcs.RcsVideoRequest.Builder
(REQUIRED) Publicly accessible 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.
url(String) - Method in class com.vonage.client.video.RenderRequest.Builder
(REQUIRED) URL of the customer service where the callbacks will be received.
UrlContainer - Class in com.vonage.client.common
Represents a link under the _links section of a HAL response.
UrlContainer() - Constructor for class com.vonage.client.common.UrlContainer
 
urlFormEncodedContentType(boolean) - Method in class com.vonage.client.DynamicEndpoint.Builder
 
UrlWrapper() - Constructor for class com.vonage.client.messages.InboundMessage.UrlWrapper
 
UrlWrapperWithCaption() - Constructor for class com.vonage.client.messages.InboundMessage.UrlWrapperWithCaption
 
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.conversations.Member.Builder
(REQUIRED) Either the user ID or unique name is required.
user(String) - Method in class com.vonage.client.voice.ncco.AppEndpoint.Builder
Deprecated.
User - Class in com.vonage.client.users
Represents a Vonage User (both request and response).
User() - Constructor for class com.vonage.client.users.User
 
User(User.Builder) - Constructor for class com.vonage.client.users.User
 
USER_REJECTED - Enum constant in enum class com.vonage.client.verify2.VerificationStatus
User rejected.
USER_TO_USER - Enum constant in enum class com.vonage.client.voice.SipHeader
 
User.Builder - Class in com.vonage.client.users
 
UserConversation - Class in com.vonage.client.conversations
Response object when querying a user's conversations.
UserConversation() - Constructor for class com.vonage.client.conversations.UserConversation
 
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.
userId - Variable in class com.vonage.client.conversations.ListUserConversationsRequest
 
username(String) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL, but REQUIRED if SipDialRequest.Builder.password(String) is provided) The username to be used in the SIP INVITE request for HTTP digest authentication, if it is required by your SIP platform.
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 Class in com.vonage.client.users
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
UsersResponseException() - Constructor for exception class com.vonage.client.users.UsersResponseException
 
userToUserHeader(String) - Method in class com.vonage.client.voice.ncco.SipEndpoint.Builder
(OPTIONAL) The User-to-User header, as per RFC 7433.
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.
UTILITY - Enum constant in enum class com.vonage.client.messages.whatsapp.ConversationType
 
uuid(String) - Method in class com.vonage.client.voice.ncco.SpeechSettings.Builder
The unique ID of the Call leg for the user to capture the speech of.
UZBEK - Enum constant in enum class com.vonage.client.messages.whatsapp.Locale
 

V

V0_1 - Enum constant in enum class com.vonage.client.messages.MessagesVersion
v0.1
V1 - Enum constant in enum class com.vonage.client.messages.MessagesVersion
v1
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
 
validateFrom(String) - Method in class com.vonage.client.verify2.WhatsappCodelessWorkflow
 
validateFrom(String) - Method in class com.vonage.client.verify2.WhatsappWorkflow
 
validateFrom(String) - Method in class com.vonage.client.verify2.SmsWorkflow
 
validateFrom(String) - Method in class com.vonage.client.verify2.Workflow
 
validatePage(Integer) - Method in class com.vonage.client.common.HalFilterRequest
 
validatePageSize(Integer) - Method in class com.vonage.client.common.HalFilterRequest
 
validatePageSize(Integer) - Method in class com.vonage.client.conversations.ListConversationsRequest
 
validatePageSize(Integer) - Method in class com.vonage.client.conversations.ListEventsRequest
 
validatePageSize(Integer) - Method in class com.vonage.client.conversations.ListMembersRequest
 
validatePageSize(Integer) - Method in class com.vonage.client.conversations.ListUserConversationsRequest
 
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
 
validateTo(String) - Method in class com.vonage.client.verify2.SilentAuthWorkflow
 
validateTo(String) - Method in class com.vonage.client.verify2.SmsWorkflow
 
validateTo(String) - Method in class com.vonage.client.verify2.VoiceWorkflow
 
validateTo(String) - Method in class com.vonage.client.verify2.WhatsappCodelessWorkflow
 
validateTo(String) - Method in class com.vonage.client.verify2.WhatsappWorkflow
 
validateTo(String) - Method in class com.vonage.client.verify2.Workflow
 
validateUrlExtension(String...) - Method in class com.vonage.client.messages.internal.MessagePayload
 
validateUrlLength(int, int) - Method in class com.vonage.client.messages.internal.MessagePayload
 
validity(int) - Method in class com.vonage.client.conversations.AudioRecordEvent.Builder
Audio recording validity parameter.
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.ApiRegion
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.camara.FraudPreventionDetectionScope
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.ChannelType
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.MessageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.common.SortOrder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.common.Webhook.Type
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.conversations.ConversationStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.conversations.EventType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.conversations.MemberState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.conversations.OrderBy
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.conversion.ConversionRequest.Type
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.CallDirection
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.CallStatus
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.CallStatusDetail
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.MessageType
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.incoming.SpeechResults.TimeoutReason
Deprecated.
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.MessagesVersion
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.MessageType
Deprecated.
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.sms.EncodingType
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.ContextStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.messages.whatsapp.ConversationType
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.messages.whatsapp.Reaction.Action
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numberinsight2.FraudScoreStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numberinsight2.Insight
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numberinsight2.PhoneType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numberinsight2.RiskLabel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numberinsight2.RiskRecommendation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numberinsight2.SimSwapStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.numbers.Feature
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
Deprecated.
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
Deprecated.
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.sms.MessageType
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.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.FragmentChannel
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.video.ArchiveMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.ArchiveStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.BroadcastStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.Language
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.MediaMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.OutputMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.ProjectEnvironment
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.ProjectStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.RenderStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.Resolution
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.Role
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.RtmpStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.ScreenLayoutType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.StreamMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.VideoType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.video.Websocket.AudioRate
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
Deprecated.
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.CallStatusDetail
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.EndpointType
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.MachineDetectionStatus
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.InputMode
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.SipHeader
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vonage.client.voice.SpeechTimeoutReason
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.
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.ApiRegion
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.camara.FraudPreventionDetectionScope
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.ChannelType
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.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.common.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.common.Webhook.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.conversations.ConversationStatus
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.conversations.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.conversations.MemberState
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.conversations.OrderBy
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
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.incoming.CallDirection
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.incoming.CallStatus
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.incoming.CallStatusDetail
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.incoming.MessageType
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.incoming.SpeechResults.TimeoutReason
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.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.MessagesVersion
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
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.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.sms.EncodingType
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.ContextStatus
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.ConversationType
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.messages.whatsapp.Reaction.Action
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.numberinsight2.FraudScoreStatus
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.numberinsight2.Insight
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.numberinsight2.PhoneType
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.numberinsight2.RiskLabel
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.numberinsight2.RiskRecommendation
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.numberinsight2.SimSwapStatus
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.Feature
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
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.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
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.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.sms.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.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.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.FragmentChannel
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.video.ArchiveMode
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.video.ArchiveStatus
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.video.BroadcastStatus
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.video.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.video.MediaMode
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.video.OutputMode
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.video.ProjectEnvironment
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.video.ProjectStatus
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.video.RenderStatus
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.video.Resolution
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.video.Role
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.video.RtmpStatus
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.video.ScreenLayoutType
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.video.StreamMode
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.video.VideoType
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.video.Websocket.AudioRate
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
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.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.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.voice.EndpointType
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.MachineDetectionStatus
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.InputMode
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.SipHeader
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.SpeechTimeoutReason
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.
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
VBC - Enum constant in enum class com.vonage.client.common.ChannelType
 
VBC - Enum constant in enum class com.vonage.client.meetings.ThemeDomain
 
VBC - Enum constant in enum class com.vonage.client.voice.EndpointType
 
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
Builder for specifying properties of a VBC endpoint.
vcard - Variable in class com.vonage.client.messages.InboundMessage
 
VCARD - Enum constant in enum class com.vonage.client.common.MessageType
 
VCARD - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
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 - Class in com.vonage.client.application.capabilities
Verify capability configuration settings.
VERIFY - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
Verify API
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
 
Verify.Builder - Class in com.vonage.client.application.capabilities
 
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) - 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.
VerifyCodeResponse - Class in com.vonage.client.verify2
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 Class in com.vonage.client.verify
 
VerifyException(String, String) - Constructor for exception class com.vonage.client.verify.VerifyException
 
verifyNumber(String) - Method in class com.vonage.client.camara.numberverification.NumberVerificationClient
Exchanges the code for an access token, makes the API call to the Number Verification API's "verify" endpoint and extracts the result.
verifyNumber(String, URI, String) - Method in class com.vonage.client.camara.numberverification.NumberVerificationClient
Stateless implementation of NumberVerificationClient.verifyNumber(String), which creates a new request without having to call NumberVerificationClient.initiateVerification(String, URI, String) first.
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.Workflow - Enum Class in com.vonage.client.verify
Enumeration representing different verification workflows.
verifyRequestSignature(InputStream, String, Map<String, String[]>, String) - Static method in class com.vonage.client.auth.RequestSigning
Verifies the signature in an HttpServletRequest.
verifyRequestSignature(String, InputStream, Map<String, String[]>, String, long) - Static method in class com.vonage.client.auth.RequestSigning
Verifies the signature in an HttpServletRequest.
VerifyResponse - Class in com.vonage.client.verify
 
VerifyResponse(VerifyStatus) - Constructor for class com.vonage.client.verify.VerifyResponse
 
VerifyResponseException - Exception Class in com.vonage.client.verify2
Response returned when verification fails (i.e. returns a non-2xx status code).
VerifyResponseException() - Constructor for exception class com.vonage.client.verify2.VerifyResponseException
 
verifySignature(String, String) - Static method in class com.vonage.client.messages.MessagesClient
Utility method for verifying whether a token was signed by a secret.
verifySignature(String, String) - Static method in class com.vonage.client.voice.VoiceClient
Utility method for verifying whether a token was signed by a secret.
VerifyStatus - Enum Class in com.vonage.client.verify
 
VERTICAL - Enum constant in enum class com.vonage.client.video.ScreenLayoutType
Vertical presentation
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.common.ChannelType
 
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,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(boolean) - Method in class com.vonage.client.video.SipDialRequest.Builder
(OPTIONAL) Flag that indicates whether the SIP call will include video (true) or not (false, the default).
Video - Class in com.vonage.client.messages.viber
 
VIDEO - Enum constant in enum class com.vonage.client.common.MessageType
 
VIDEO - Enum constant in enum class com.vonage.client.messages.MessageType
Deprecated.
 
videoBaseUri(String) - Method in class com.vonage.client.HttpConfig.Builder
Replaces the base URI used in "video" endpoints.
VideoClient - Class in com.vonage.client.video
A client for using the Vonage Video API.
VideoClient(HttpWrapper) - Constructor for class com.vonage.client.video.VideoClient
Constructor.
VideoResponseException - Exception Class in com.vonage.client.video
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
VideoResponseException() - Constructor for exception class com.vonage.client.video.VideoResponseException
 
VideoStream - Class in com.vonage.client.video
 
VideoStream() - Constructor for class com.vonage.client.video.VideoStream
 
VideoType - Enum Class in com.vonage.client.video
Represents the video types returned in GetStreamResponse.getVideoType().
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
 
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 - Enum constant in enum class com.vonage.client.account.ServiceType
 
VOICE - Enum constant in enum class com.vonage.client.application.capabilities.Capability.Type
Voice API
VOICE - Enum constant in enum class com.vonage.client.conversion.ConversionRequest.Type
Deprecated.
 
VOICE - Enum constant in enum class com.vonage.client.numbers.Feature
 
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 - Enum constant in enum class com.vonage.client.verify2.FragmentChannel
 
Voice.Builder - Class in com.vonage.client.application.capabilities
 
voiceCallback(UpdateNumberRequest.CallbackType, String) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the voice callback type and value (either SIP or PSTN).
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.
VoiceResponseException - Exception Class in com.vonage.client.voice
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
VoiceResponseException() - Constructor for exception class com.vonage.client.voice.VoiceResponseException
 
voiceStatusCallback(String) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the webhook URI for Vonage to send a request to when a call ends.
voiceStatusCallback(URI) - Method in class com.vonage.client.numbers.UpdateNumberRequest.Builder
Sets the webhook URI for Vonage to send a request to when a call ends.
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.
VOIP - Enum constant in enum class com.vonage.client.numberinsight2.PhoneType
 
VonageApiResponseException - Exception Class in com.vonage.client
Base class for exceptions which represent an error API response conforming to RFC 7807 standard.
VonageApiResponseException() - Constructor for exception class com.vonage.client.VonageApiResponseException
 
VonageApiResponseException(String) - Constructor for exception class com.vonage.client.VonageApiResponseException
 
VonageApiResponseException(String, Throwable) - Constructor for exception class com.vonage.client.VonageApiResponseException
 
VonageApiResponseException(Throwable) - Constructor for exception class com.vonage.client.VonageApiResponseException
 
VonageAuthException - Exception Class in com.vonage.client.auth
 
VonageAuthException() - Constructor for exception class com.vonage.client.auth.VonageAuthException
 
VonageAuthException(String) - Constructor for exception class com.vonage.client.auth.VonageAuthException
 
VonageAuthException(String, Throwable) - Constructor for exception class com.vonage.client.auth.VonageAuthException
 
VonageAuthException(Throwable) - Constructor for exception class com.vonage.client.auth.VonageAuthException
 
VonageBadRequestException - Exception Class in com.vonage.client
Deprecated.
VonageBadRequestException() - Constructor for exception class com.vonage.client.VonageBadRequestException
Deprecated.
 
VonageBadRequestException(String) - Constructor for exception class com.vonage.client.VonageBadRequestException
Deprecated.
 
VonageBadRequestException(String, Throwable) - Constructor for exception class com.vonage.client.VonageBadRequestException
Deprecated.
 
VonageBadRequestException(Throwable) - Constructor for exception class com.vonage.client.VonageBadRequestException
Deprecated.
 
VonageCallbackRequestValidationException - Exception Class in com.vonage.client.sms.callback
Deprecated.
This class will be removed in the next major release.
VonageCallbackRequestValidationException() - Constructor for exception class com.vonage.client.sms.callback.VonageCallbackRequestValidationException
Deprecated.
 
VonageCallbackRequestValidationException(String) - Constructor for exception class com.vonage.client.sms.callback.VonageCallbackRequestValidationException
Deprecated.
 
VonageCallbackRequestValidationException(String, Throwable) - Constructor for exception class com.vonage.client.sms.callback.VonageCallbackRequestValidationException
Deprecated.
 
VonageCallbackRequestValidationException(Throwable) - Constructor for exception class com.vonage.client.sms.callback.VonageCallbackRequestValidationException
Deprecated.
 
VonageClient - Class in com.vonage.client
Top-level Vonage API client object.
VonageClient.Builder - Class in com.vonage.client
Builder for specifying the properties of the client.
VonageClientCreationException - Exception Class in com.vonage.client
Indicates that there was a failure during VonageClient creation.
VonageClientCreationException(String, Throwable) - Constructor for exception class com.vonage.client.VonageClientCreationException
 
VonageClientException - Exception Class in com.vonage.client
 
VonageClientException() - Constructor for exception class com.vonage.client.VonageClientException
 
VonageClientException(String) - Constructor for exception class com.vonage.client.VonageClientException
 
VonageClientException(String, Throwable) - Constructor for exception class com.vonage.client.VonageClientException
 
VonageClientException(Throwable) - Constructor for exception class com.vonage.client.VonageClientException
 
VonageMethodFailedException - Exception Class in com.vonage.client
 
VonageMethodFailedException() - Constructor for exception class com.vonage.client.VonageMethodFailedException
 
VonageMethodFailedException(String) - Constructor for exception class com.vonage.client.VonageMethodFailedException
 
VonageMethodFailedException(String, Throwable) - Constructor for exception class com.vonage.client.VonageMethodFailedException
 
VonageMethodFailedException(Throwable) - Constructor for exception class com.vonage.client.VonageMethodFailedException
 
VonageResponseParseException - Exception Class in com.vonage.client
An exception that indicates the contents of an HttpResponse could not be parsed.
VonageResponseParseException(String) - Constructor for exception class com.vonage.client.VonageResponseParseException
 
VonageResponseParseException(String, Throwable) - Constructor for exception class com.vonage.client.VonageResponseParseException
 
VonageResponseParseException(Throwable) - Constructor for exception class com.vonage.client.VonageResponseParseException
 
VonageUnableToReadPrivateKeyException - Exception Class in com.vonage.client
 
VonageUnableToReadPrivateKeyException(String, Throwable) - Constructor for exception class com.vonage.client.VonageUnableToReadPrivateKeyException
 
VonageUnacceptableAuthException - Exception Class in com.vonage.client.auth
 
VonageUnacceptableAuthException(Collection<AuthMethod>, Collection<Class<? extends AuthMethod>>) - Constructor for exception class com.vonage.client.auth.VonageUnacceptableAuthException
 
VonageUnexpectedException - Exception Class in com.vonage.client
VonageUnexpectedException indicates an exception that should not happen in an ideal world.
VonageUnexpectedException() - Constructor for exception class com.vonage.client.VonageUnexpectedException
 
VonageUnexpectedException(String) - Constructor for exception class com.vonage.client.VonageUnexpectedException
 
VonageUnexpectedException(String, Throwable) - Constructor for exception class com.vonage.client.VonageUnexpectedException
 
VonageUnexpectedException(Throwable) - Constructor for exception class com.vonage.client.VonageUnexpectedException
 
VXML - Enum constant in enum class com.vonage.client.numbers.UpdateNumberRequest.CallbackType
Deprecated.

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.
WAV - Enum constant in enum class com.vonage.client.voice.ncco.RecordingFormat
 
Webhook - Class in com.vonage.client.common
Deprecated.
Will be moved to the com.vonage.client.application package.
Webhook() - Constructor for class com.vonage.client.common.Webhook
Deprecated.
 
Webhook(String, HttpMethod) - Constructor for class com.vonage.client.common.Webhook
Deprecated.
 
Webhook.Builder - Class in com.vonage.client.common
Deprecated.
Builder for configuring Webhook object.
Webhook.Type - Enum Class in com.vonage.client.common
Deprecated.
Represents the webhook URL type.
webhooks - Variable in class com.vonage.client.application.capabilities.Capability
 
webhookUrl(String) - Method in class com.vonage.client.messages.MessageRequest.Builder
(OPTIONAL) Specifies the URL to which Status Webhook messages will be sent for this particular message.
webhookVersion(MessagesVersion) - Method in class com.vonage.client.messages.MessageRequest.Builder
Specifies which version of the Messages API will be used to send Status Webhook messages for this particular message.
Websocket - Class in com.vonage.client.users.channels
Represents a Websocket channel.
Websocket - Class in com.vonage.client.video
Defines the properties in ConnectRequest.getWebsocket().
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 - Enum constant in enum class com.vonage.client.common.ChannelType
 
WEBSOCKET - Enum constant in enum class com.vonage.client.voice.EndpointType
 
Websocket.AudioRate - Enum Class in com.vonage.client.video
Represents the possible audio sampling rate values for a WebSocket connection.
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, 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
 
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.messages.InboundMessage.Whatsapp
 
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.common.ChannelType
 
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).
WHATSAPP_VOICE - Enum constant in enum class com.vonage.client.common.ChannelType
 
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
Deprecated.
This no longer works and will be removed in a future release.
WhatsappCodelessWorkflow(String, 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
 
whatsappContextStatus - 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
 
WhatsappReactionRequest - Class in com.vonage.client.messages.whatsapp
WhatsappReactionRequest.Builder - Class in com.vonage.client.messages.whatsapp
 
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,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
 
WhatsappVoice - Class in com.vonage.client.users.channels
Represents a WhatsApp Voice channel.
WhatsappVoice() - Constructor for class com.vonage.client.users.channels.WhatsappVoice
 
WhatsappVoice(String) - Constructor for class com.vonage.client.users.channels.WhatsappVoice
Creates a new WhatsApp Voice channel.
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
Deprecated.
This no longer works and will be removed in a future release.
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
Deprecated.
This will be removed in the next major release.
withIncomingSmsUrl(String) - Static method in class com.vonage.client.account.SettingsRequest
Deprecated.
This will be removed in the next major release.
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(Workflow.Builder<?, ?>) - Constructor for class com.vonage.client.verify2.Workflow
 
WORKFLOW - Enum constant in enum class com.vonage.client.redact.RedactRequest.Product
 
Workflow.Builder<W,B> - Class in com.vonage.client.verify2
Builder class for an SMS workflow.
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.

Z

ZH_CN - Enum constant in enum class com.vonage.client.meetings.RoomLanguage
Chinese (Mainland)
ZH_CN - Enum constant in enum class com.vonage.client.video.Language
Simplified Chinese
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 Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form