All Classes and Interfaces
Class
Description
Base class for all AuthMethod implementations.
Deprecated.
This class will be made package-private in the next major release.
Abstract class to assist in implementing a call against a REST endpoint.
Represents a subaccount.
A client for talking to the Vonage Account API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
An NCCO action.
Response object constructed from the JSON payload returned for Advanced number insight requests.
Configure the behavior of Vonage's advanced machine detection.
Builder for specifying the Advanced Machine Detection properties.
Represents the beep detection mode.
Maps the fields for data sent to the
answer_url configured in your voice application.Signifies that the auth method has an API key.
API key and secret in the header.
API key and secret in query parameters.
Enum representing the different regions that the Vonage API can be accessed from.
Represents an app-to-app call type.
Represents an app endpoint used in a
ConnectAction.Represents a Vonage Application (both request and response).
Represents the cryptographic keys of an Application.
Application privacy configuration settings.
A client for talking to the Vonage Application API.
HAL response returned from
ApplicationClient.listApplications(ListApplicationRequest).Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Represents an archive of a video session.
Used to construct an Archive object.
Defines values for the archiveMode parameter of the
CreateSessionRequest.Builder.archiveMode(ArchiveMode archiveMode) method.Defines values returned by the
Archive.getStatus() method.Represents an
EventType.AUDIO_EARMUFF_OFF event.Represents an
EventType.AUDIO_EARMUFF_ON event.Represents an
EventType.AUDIO_MUTE_OFF event.Represents an
EventType.AUDIO_MUTE_ON event.Represents an
EventType.AUDIO_PLAY_DONE event.Represents an
EventType.AUDIO_PLAY event.Represents an
EventType.AUDIO_PLAY_STOP event.Represents an
EventType.AUDIO_RECORD event.Builder for setting the Audio Record event parameters.
Represents an
EventType.AUDIO_RECORD_STOP event.Represents an
EventType.AUDIO_SAY_DONE event.Represents an
EventType.AUDIO_SAY event.Represents an
EventType.AUDIO_SAY_STOP event.Internal class, managing a collection of
AuthMethods.Base request query parameters for the intermediate three-legged OAuth2 check network authentication.
Represents a number that is available to buy.
Back-End auth request parameters for the first step in an OAuth2 three-legged check workflow.
Represents the response from the first step in an OAuth2 three-legged workflow.
Response data for the
AccountClient.getBalance() method.Represents the main attributes of a conversation.
Represents the basic conversation member attributes, as returned from
ListMembersResponse.getMembers().Base request class for
VerifyRequest and Psd2Request.Represents the main attributes of a User.
Base class for auth methods which use the
Authorization: Basic header.Response object constructed from the JSON payload returned for Basic number insight requests.
Base class for auth methods which use the
Authorization: Bearer header.A binary message to be submitted via the Vonage SMS API.
Indicates that a class used for request is to be serialised as binary data (e.g. for uploads).
Represents properties of a live-streaming broadcast.
Used to construct a Broadcast object.
Defines values returned by the
Broadcast.getStatus() method.Container for details about the HLS and RTMP broadcasts.
Used for inbound Button messages.
Call encapsulates the information required to create a call using
VoiceClient.createCall(Call)Builder for constructing a Call object.
Callback properties for a
Conversation.Builder for creating Callback settings.
Represents the type of webhook in
VerificationCallback.getType().Deprecated.
Use
CallDirection.Represents the type of the number's owner as an enum.
Deprecated.
Use
EventWebhook.Represents metadata about a call.
CallInfo holds the information related to a call.
Deprecated.
Replaced by
SortOrder.Filter options for
VoiceClient.listCalls(CallsFilter).Deprecated.
Use
CallStatus.Describes the status of the call, and also the event in
EventWebhook.getStatus().Deprecated.
Use
CallStatusDetail.Represents the
detail field in EventWebhook.getDetail().Response returned when a network request fails (i.e. returns a non-2xx status code).
Represents a capability of a Vonage Application
Represents the API this capability relates to.
Convenience interface to indicate that a media message may have a caption.
Interface for builders with a media URL and caption.
Defines the captioning properties used in
VideoClient.startCaptions(CaptionsRequest).Builder for defining the fields in a StartCaptionsRequest object.
Represents the response from
VideoClient.startCaptions(CaptionsRequest).Enum representing the type of network that the number is associated with.
See the
Facebook documentation
for details on what these mean.
The use of different category tags enables the business to send messages for different use cases.
Represents the services available for sending messages.
Base class for channels.
Represents the verification channel type in a Workflow.
Represents the "channels" field on
User.Represents the various available channel types.
Deprecated.
This will be made package-private in the next major release.
An NCCO connect action that allows for the establishment of a connection to various
Endpoint.Defines properties used for Audio Connector.
Builder for defining the fields in a ConnectRequest object.
Represents the response from
VideoClient.startCaptions(CaptionsRequest).Represents a Proactive Connect list.
Represents file attachments in
InboundMessage.getContent().This is only present for the Inbound Message where the user is quoting another message.
Represents the WhatsApp
context_status field in InboundMessage.Represents a Conversation (request and response).
Builder for creating or updating a Conversation.
An NCCO conversation action which enables the ability to host conference calls.
Builder for specifying the properties of a Conversation NCCO.
Additional properties for a Conversation.
A client for communicating with the Vonage Conversations API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Represents the status of a Conversation.
Represents the timestamps in
BaseConversation.getTimestamp().Represents the conversation category as returned by
MessageStatus.getWhatsappConversationType().Represents a
EventType.CONVERSATION_UPDATED event.A client for talking to the Vonage Conversion API.
Deprecated.
This class will be made package-private in the next major release.
This enum will be moved to its own class in the next major release.
Groups the country details in
PricingResponse.Defines the properties used to create a new video session.
Builder for constructing CreateSessionRequest.
Represents a Custom event.
Base class for datasource types used in Proactive Connect lists.
Details about a number that that can be used to dial into a meeting.
Response if DTMF tones were successfully sent to an active
Call.Deprecated.
Use
DtmfResult.Represents the DTMF event results in
EventWebhook.getDtmf().DTMF (Dial Tone Multi Frequency) settings for Input Actions that will be added to a NCCO object.
Builder for specifying DTMF settings.
Enables convenient declaration of endpoints without directly implementing
AbstractMethod.Utility class for validating and sanitising phone numbers to be compliant with the E164 format.
Defines properties for sending a verification code to a user via e-mail.
Represents the encoding type for an SMS text message.
An endpoint for a
ConnectAction to connect to.Represents the various types of call endpoints supported by the Voice API.
Represents an Ephemeral event.
Events are actions that occur within a conversation.
Represents an event in the Proactive Connect API.
Builder for constructing an event request's parameters.
Represents a
EventType.EVENT_DELETE event.The type of request to use when connecting to an event URL.
Represents the possible types of events in
Event.getType().Represents the event type in
MeetingsEventCallback.getEvent().Represents values for
Event.getType().The type of event to use.
Represents all call events sent to the
event_url webhook configured in your Voice application settings.Represents the capabilities of a phone number.
Represents the template channel type in a
TemplateFragment.Fraud check results as obtained from
NumberInsight2Client.fraudCheck(String, Insight, Insight...).Represents the fraud score insight results in
FraudCheckResponse.getFraudScore().Represents the status in
FraudScore.getStatus().Front-End auth request parameters for the first step in an OAuth2 three-legged check workflow.
Represents details of a stream, as returned from
VideoClient.getStream(String, String).Provides basic filtering parameters for HAL resources.
Represents the
_links section of a HAL response.Abstract base class for responses that conform to the
HAL specification.
Utility methods for hashing strings.
Interface for auth methods which use the
Authorization: header.Represents HTTP Live Streaming (HLS) options for a
Broadcast.Used to create the Hls object.
Deprecated.
This class will be made package-private in the next major release.
Deprecated.
This class will be made package-private in the next major release.
Deprecated.
This class will be made package-private in the next major release.
Deprecated.
This class will be made package-private in the next major release.
Builder for configuring the base URI and timeout of the client.
Enumeration representing various HTTP request methods used in Vonage APIs.
Internal class that holds available authentication methods and a shared HttpClient.
Convenience class representing an inbound message webhook.
An NCCO input action which allows for the collection of digits and automatic speech recognition from a person.
Builder for specifying the properties of an InputAction.
Deprecated.
Use
EventWebhook.Represents the input mode for
InputAction.Represents the type of insights used for a fraud check request.
A client for talking to the Vonage Number Insight API.
Represents the level of approval needed to join the meeting in the room.
Indicates that a class can be serialized to and parsed from JSON.
Base class for requests and responses which are serialised and parsed to and from JSON.
Represents the supported BCP-47 language codes for Live Captions.
Query parameters for
ApplicationClient.listApplications(ListApplicationRequest).Represents a Proactive Connect list's
attributes property.Filters results for
ConversationsClient.listConversations(ListConversationsRequest).HAL response for
ConversationsClient.listConversations(ListConversationsRequest).Filter options for finding events using
listEvents(ListEventsFilter).Builder for specifying options to filter events by.
Filters results for
ConversationsClient.listEvents(String, ListEventsRequest).HAL response for
ConversationsClient.listEvents(String, ListEventsRequest).Represents a list item in the Proactive Connect API.
HAL response for
listItems(UUID, int, int, SortOrder).HAL response for
listLists(int, int, SortOrder).Represents filter options for
ConversationsClient.listMembers(String, ListMembersRequest).HAL response for
ConversationsClient.listMembers(String, ListMembersRequest).Filter criteria used in
NumbersClient.listNumbers(ListNumbersFilter).Builder for setting the parameters of ListNumbersFilter.
Response from a request to list the numbers currently being rented buy an account.
HAL response for
AccountClient.listSecrets(String).Filter properties and pagination for
VideoClient.listArchives(ListStreamCompositionsRequest)
and VideoClient.listBroadcasts(ListStreamCompositionsRequest).Response container for
SubaccountsClient.listSubaccounts().Represents a response page for listing template fragments.
Represents a response page for listing templates.
Represents filter options for
ConversationsClient.listUserConversations(String, ListUserConversationsRequest).HAL response for
ConversationsClient.listUserConversations(String).Query parameters for
UsersClient.listUsers(ListUsersRequest).Represents the sort order for events.
Paginated HAL response for
UsersClient.listUsers(ListUsersRequest).Enum representing BCP-47 locales supported by WhatsApp.
Describes parameters for a Location message in
MessageEvent.getLocation().Whatsapp Location message parameters.
Builder for setting Location parameters.
Represents the type of logo returned in
LogoUploadsUrlResponse.Fields.Enum representing whether all information about a phone number has been returned.
Represents machine detection behaviour.
Represents event substates for advanced machine detection in
EventWebhook.getMachineDetectionSubstate().Represents the
manual datasource type for a Proactive Connect list.Represents the audio options in
MemberMedia.getAudioSettings().Convenience interface to indicate that
MessageRequest.getMessageType() is media (has a URL).Interface for builders with a media URL.
Defines values for the mediaMode parameter of the
CreateSessionRequest.Builder.mediaMode(MediaMode mediaMode) method.Deprecated.
Support for this API will be removed in the next major release.
Represents a deserialized callback response webhook for event updates from the Meetings API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Represents a conversation membership.
Contains the channel properties for
Member.getChannel().Contains the media properties for
Member.getMedia().Builder for constructing MemberMedia.
Represents the state of a conversation member.
Represents the timestamps in
Member.getTimestamp().Represents the details common to any message that is to be submitted to the Vonage SMS API.
An enum of the valid values that may be supplied to as the message-class parameter of a rest submission.
Represents a
EventType.MESSAGE_DELIVERED event.Builder for configuring parameters of the event request.
Represents a
EventType.MESSAGE event.Deprecated.
Moved to
MessageEvent.Represents an Inbound SMS webhook.
Builder for configuring parameters of the event request.
Container object for audio, video, image and file message payload contents.
Represents a
EventType.MESSAGE_REJECTED event.Builder for configuring parameters of the event request.
Abstract base class of all Messages sent via the Messages v1 API.
Mutable Builder class, designed to simulate named parameters to allow for convenient
construction of MessageRequests.
Response returned when sending a message.
Response returned when sending a message fails (i.e. returns a non-2xx status code).
Messages capability configuration settings.
Represents a
EventType.MESSAGE_SEEN event.Builder for configuring parameters of the event request.
This class represents the data of a callback which is invoked after a message has been sent.
Enum representing the error status of an SMS message.
Describes the error that was encountered when sending the message.
Describes the charge incurred for sending the message.
Represents a
EventType.MESSAGE_SUBMITTED event.Builder for configuring parameters of the event request.
Represents the possible versions used for webhooks in the Messages API.
Represents a message media type.
Deprecated.
Deprecated.
Will be replaced by
MessageType in the next major release.Represents the SMS message type.
Represents a
EventType.MESSAGE_UNDELIVERABLE event.Builder for configuring parameters of the event request.
Represents a Facebook Messenger channel.
Set the default microphone option for users in the pre-join screen of this room.
Represents a Multimedia Messaging Service (MMS) channel.
Deprecated.
This class is not maintained and will be removed in the next major release.
Describes the type of payload this message carries
Enum representing call modification actions.
Represents a credit or balance transfer between accounts.
Vonage Call Control Object for controlling the flow of a Voice API call.
Represents a network in
PricingResponse.Represents the type of network.
Base class for Vonage Network API clients.
Network APIs capability configuration settings.
Used for obtaining access tokens for use with Vonage CAMARA APIs.
Auth method for Vonage Network APIs.
Response returned when an authentication request fails (i.e. returns a non-2xx status code).
Represents a no-op AuthMethod, for when no authentication is necessary.
An NCCO notify action which allows for custom events to be sent to a configured webhook.
Deprecated.
Use
EventWebhook.A client for talking to the Vonage NumberInsight2Client API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
A client for accessing the Vonage API calls that manage phone numbers.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
A client for communicating with the Vonage Number Verification API.
Used for inbound product orders.
Result ordering options for
ListUserConversationsRequest.Represents optional settings for the SMS message in
SmsTextRequest.Defines values used in the
Archive.Builder.outputMode(OutputMode) method and returned by the
Archive.getOutputMode() method.Represents a number that is being rented by your account.
Deprecated.
Will be replaced by
HalLinks in a future release.Represents details of the phone number in
FraudCheckResponse.getPhone().Represents a phone endpoint used in a
ConnectAction.An object containing a required url key.
Represents the phone type in
Phone.getType().Represents the policy for resolving what language template to use.
Enum representing whether the user has changed carrier for the number.
Deprecated.
This will be removed in favour of returning the list of countries' pricing directly.
Pricing information for a specific country.
Deprecated.
This API is sunset and will be removed in the next major release.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Used for inbound product orders.
Used for inbound messages.
Represents properties of a video project.
Represents the project environment type.
Represents the project status.
Describes a PSD2 verify request.
Enumeration representing different verification workflows.
Represents a Public Switched Telephone Network (PSTN) channel.
Auth methods that are appended to the request's query parameters.
Indicates that a request object has query parameters.
Channel.RCS, MessageType.CUSTOM request.Channel.RCS, MessageType.FILE request.Channel.RCS, MessageType.IMAGE request.Base class for RCS messages.
Channel.RCS, MessageType.TEXT request.Channel.RCS, MessageType.VIDEO request.Enum representing whether you can call number now.
Represents a MessageType.REACTION message.
Represents the action to be taken.
Real time data about the number.
An NCCO record action which allows for the call to be recorded.
Builder for a RecordAction.
Deprecated.
Use
EventWebhook.Represents the recording state of a meeting.
A client for talking to the Vonage Redact API.
Represents a request to the Redact API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
This is only present for situations where a user has clicked on a 'WhatsApp' button embedded in an advertisement
or post on Facebook.
Contains details of a product from a product message being quoted or replied to
using the 'Message Business' option.
Represents a Vonage region.
Defines the parameters for starting an Experience Composer session.
Builder for defining the parameters of
RenderRequest.Publisher initial configuration properties for the composed output stream.
Represents an Experience Composer response.
Represents the possible states in
RenderResponse.getStatus().Used for inbound interactive messages.
Represents query parameters in a HTTP request without depending on a specific implementation.
A helper class for generating or verifying MD5 signatures when signing REST requests for submission to Vonage.
Defines valid video resolutions for an archive.
Internal interface for defining endpoints.
Deprecated.
Use
SpeechTranscript.Represents the risk score values in
FraudScore.getLabel().Represents the risk recommendation in
FraudScore.getRiskRecommendation().Information about the roaming status for number.
Represents whether the number is outside its home carrier network, as an enum.
Defines values for the role parameter of the
TokenOptions.Builder.role(Role role) method.Represents the language in
UISettings.Represents the type of meeting room.
Rtc capability configuration settings.
Represents an RTMP stream in a video session.
Represents the status of an RTMP stream.
Represents the
salesforce datasource type for a Proactive Connect list.Represents the available layout types for archives in
StreamCompositionLayout.This class encapsulates a request to search for available Vonage Virtual Numbers.
Builder for setting the parameters of SearchNumbersFilter.
Represents the response to a "searchNumbers" request from the Vonage API.
Provided to calls that match substrings, to indicate which part of the string should be considered a match.
Represents metadata about an API account secret.
Represents the service type for pricing requests.
Represents a stream's metadata in a Vonage Video session.
Deprecated.
This will be made package-private in the next major release.
Details of the configured account settings.
Defines properties for mobile network-based authentication.
Builder for constructing a Silent Authentication workflow.
Represents the sim swap insight results in
FraudCheckResponse.getSimSwap().A client for communicating with the Vonage SIM Swap API.
Represents the status in
SimSwap.getStatus().Represents a Session Initiation Protocol (SIP) channel.
Represents an outbound SIP dial request's properties.
Used to create an SipDialRequest object.
Represents a Vonage Video SIP call.
Represents a SIP endpoint used in a
ConnectAction.Endpoint for connecting to a SIP URI.
Represents standard headers for SIP Connect endpoint.
Represents a Short Messaging Service (SMS) channel.
A client for talking to the Vonage Voice API.
Used to describe inbound SMS metadata.
Defines workflow properties for sending a verification code to a user via SMS.
Builder class for an SMS workflow.
Represents the sort order for resources returned.
Deprecated.
Replaced by
SortOrder and will be removed in future release.Represents source types for events.
Deprecated.
Use
SpeechResults.Represents the speech recognition results in
EventWebhook.getSpeech().Represents the timeout reason in SpeechResults.getTimeoutReason().
ASR (Automatic Speech Recognition) settings for Input Actions that will be added to a NCCO object.
Builder for customising SpeechSettings parameters.
Represents the timeout reason in
SpeechResults.getTimeoutReason().Represents speech to text data contained in
SpeechResults.getResults().Response object constructed from the JSON payload returned for Standard number insight requests.
An NCCO stream action which allows for media to be streamed to a call.
Defines the properties used for
VideoClient.updateArchiveLayout(String, StreamCompositionLayout).Defines values for how streams will be selected for broadcasts and archives.
Response from successfully streaming an audio file or stopping a stream to an active
Call.Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Provides info on list changes compared to the latest sync.
Represents the sync status values for
SyncStatus.getValue().Represents a Facebook Message Tag.
An NCCO talk action which allows for synthesized speech to be sent to a call.
Defines the text-to-speech properties.
Builder for configuring properties of TalkPayload.
Response from successfully sending a synthesized speech message or stopping a message to an active
Call.Represents a custom template.
Represents a custom template fragment.
Represents the details of a plain-text message that is to be submitted via the Vonage REST api.
Convenience interface to indicate that
MessageRequest.getMessageType() is MessageType.TEXT.Interface for builders where MessageRequest.getMessageType() is
MessageType.TEXT.Enum representing the available TTS language options.
Represents the application domain for a theme.
Defines values for the
options parameter of the
VideoClient.generateToken(String sessionId, TokenOptions tokenOptions) method.Use this class to create a TokenOptions object.
Represents the request parameters for the intermediate (second) step in an OAuth2 three-legged workflow.
Customisable settings for call recording transcription.
Builder for setting the TranscriptionSettings parameters.
Enumeration representing the type of number.
Options for updating a membership using
ConversationsClient.updateMember(UpdateMemberRequest).Builder for constructing an UpdateMemberRequest.
Defines properties for updating an existing owned number.
Builder for specifying the properties of the number to update.
Represents the callback type for voice.
Results from list upload.
Represents a link under the
_links section of a HAL response.Represents a Vonage User (both request and response).
Response object when querying a user's conversations.
A client for talking to the Vonage Users API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Enum representing the existence of a number.
VBC capability configuration settings.
Represents a Vonage Business Cloud (VBC) channel.
Represents a VBC endpoint used in a
ConnectAction.Represents a VBC call type.
Builder for specifying properties of a VBC endpoint.
Webhook for verification status updates and events.
Defines properties for a verify request to be sent to the user.
Metadata about an outbound verification request.
Represents the status of an event or update in
VerificationCallback.getStatus().Verify capability configuration settings.
A client for talking to the Vonage Verify API.
Represents the response from
Verify2Client.checkVerificationCode(UUID, String).Enum representing the control command.
Describes a Verify request.
Builder to create a Two Factor Authentication request
Enumeration representing different verification workflows.
Response returned when verification fails (i.e. returns a non-2xx status code).
Represents a Viber channel.
A client for using the Vonage Video API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Represents the video types returned in
GetStreamResponse.getVideoType().Voice capability configuration settings.
A client for talking to the Vonage Voice API.
Response returned when an error is encountered (i.e. the API returns a non-2xx status code).
Defines workflow properties for sending a verification code to a user over a voice call.
Base class for exceptions which represent an error API response conforming to
RFC 7807 standard.
Deprecated.
Deprecated.
This class will be removed in the next major release.
Top-level Vonage API client object.
Builder for specifying the properties of the client.
Indicates that there was a failure during VonageClient creation.
An exception that indicates the contents of an HttpResponse could not be parsed.
VonageUnexpectedException indicates an exception that should not happen in an ideal world.
Deprecated.
Will be moved to the
com.vonage.client.application package.Builder for configuring Webhook object.
Represents the webhook URL type.
Represents a Websocket channel.
Defines the properties in
ConnectRequest.getWebsocket().Represents the possible audio sampling rate values for a WebSocket connection.
Represents the possible content types for a Websocket.
Represents a web socket endpoint used in a
ConnectAction.Represents a WhatsApp channel.
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.
Channel.WHATSAPP, MessageType.REACTION request.See the documentation
for more information on sending stickers.
Represents a WhatsApp Voice channel.
Defines properties for sending a verification code to a user over a WhatsApp message.
Base workflow.
Builder class for an SMS workflow.
Describes the status of a workflow.