Uses of Class
com.vonage.client.JsonableBaseObject

Packages that use JsonableBaseObject

Package	Description
com.vonage.client.account
com.vonage.client.application	Implementation of the Application API.
com.vonage.client.application.capabilities
com.vonage.client.auth.camara	This package contains classes to support usage of the Vonage Network Auth API.
com.vonage.client.common
com.vonage.client.conversations	Implementation of the Conversation API.
com.vonage.client.insight
com.vonage.client.meetings	This package contains classes and sub-packages to support usage of the Meetings API.
com.vonage.client.messages	This package contains classes and sub-packages to support usage of the Vonage Messages API.
com.vonage.client.messages.internal
com.vonage.client.messages.messenger
com.vonage.client.messages.mms
com.vonage.client.messages.rcs
com.vonage.client.messages.sms
com.vonage.client.messages.viber
com.vonage.client.messages.whatsapp
com.vonage.client.numberinsight2	Implementation of the Number Insight v2 API.
com.vonage.client.numbers
com.vonage.client.proactiveconnect	This package contains classes and sub-packages to support usage of the Vonage Proactive Connect API.
com.vonage.client.sms	This package contains classes and sub-packages to support usage of the Vonage SMS API.
com.vonage.client.subaccounts	Implementation of the Subaccounts API.
com.vonage.client.users	This package contains classes and sub-packages to support usage of the Vonage Users API.
com.vonage.client.users.channels
com.vonage.client.verify
com.vonage.client.verify2	Implementation of the Verify v2 API.
com.vonage.client.video	This package contains classes to support usage of the Video API.
com.vonage.client.voice	Implementation of the Vonage Voice API.
com.vonage.client.voice.ncco	Provides useful NCCO classes which can be serialized using Jackson when implementing webhooks to drive the Vonage Voice API.

Uses of JsonableBaseObject in com.vonage.client.account

Subclasses of JsonableBaseObject in com.vonage.client.account

Modifier and Type	Class	Description
class	BalanceResponse	Response data for the AccountClient.getBalance() method.
class	Country	Groups the country details in PricingResponse.
class	ListSecretsResponse	HAL response for AccountClient.listSecrets(String).
class	Network	Represents a network in PricingResponse.
class	PrefixPricingResponse	Deprecated. This will be removed in favour of returning the list of countries' pricing directly.
class	PricingResponse	Pricing information for a specific country.
class	SecretResponse	Represents metadata about an API account secret.
class	SettingsResponse	Details of the configured account settings.

Uses of JsonableBaseObject in com.vonage.client.application

Subclasses of JsonableBaseObject in com.vonage.client.application

Modifier and Type	Class	Description
class	Application	Represents a Vonage Application (both request and response).
static class	Application.Capabilities
static class	Application.Keys	Represents the cryptographic keys of an Application.
static class	Application.Privacy	Application privacy configuration settings.
class	ApplicationList	HAL response returned from ApplicationClient.listApplications(ListApplicationRequest).

Uses of JsonableBaseObject in com.vonage.client.application.capabilities

Subclasses of JsonableBaseObject in com.vonage.client.application.capabilities

Modifier and Type	Class	Description
class	Capability	Represents a capability of a Vonage Application
final class	Messages	Messages capability configuration settings.
final class	NetworkApis	Network APIs capability configuration settings.
final class	Rtc	Rtc capability configuration settings.
final class	Vbc	VBC capability configuration settings.
final class	Verify	Verify capability configuration settings.
final class	Voice	Voice capability configuration settings.

Uses of JsonableBaseObject in com.vonage.client.auth.camara

Subclasses of JsonableBaseObject in com.vonage.client.auth.camara

Modifier and Type	Class	Description
final class	BackendAuthResponse	Represents the response from the first step in an OAuth2 three-legged workflow.
final class	TokenResponse

Uses of JsonableBaseObject in com.vonage.client.common

Subclasses of JsonableBaseObject in com.vonage.client.common

Modifier and Type	Class	Description
class	HalLinks	Represents the _links section of a HAL response.
class	HalPageResponse	Abstract base class for responses that conform to the HAL specification.
class	UrlContainer	Represents a link under the _links section of a HAL response.
class	Webhook	Deprecated. Will be moved to the com.vonage.client.application package.

Uses of JsonableBaseObject in com.vonage.client.conversations

Subclasses of JsonableBaseObject in com.vonage.client.conversations

Modifier and Type	Class	Description
final class	AudioEarmuffOffEvent	Represents an EventType.AUDIO_EARMUFF_OFF event.
final class	AudioEarmuffOnEvent	Represents an EventType.AUDIO_EARMUFF_ON event.
final class	AudioMuteOffEvent	Represents an EventType.AUDIO_MUTE_OFF event.
final class	AudioMuteOnEvent	Represents an EventType.AUDIO_MUTE_ON event.
final class	AudioPlayDoneEvent	Represents an EventType.AUDIO_PLAY_DONE event.
final class	AudioPlayEvent	Represents an EventType.AUDIO_PLAY event.
final class	AudioPlayStopEvent	Represents an EventType.AUDIO_PLAY_STOP event.
final class	AudioRecordEvent	Represents an EventType.AUDIO_RECORD event.
final class	AudioRecordStopEvent	Represents an EventType.AUDIO_RECORD_STOP event.
final class	AudioSayDoneEvent	Represents an EventType.AUDIO_SAY_DONE event.
final class	AudioSayEvent	Represents an EventType.AUDIO_SAY event.
final class	AudioSayStopEvent	Represents an EventType.AUDIO_SAY_STOP event.
class	BaseConversation	Represents the main attributes of a conversation.
class	BaseMember	Represents the basic conversation member attributes, as returned from ListMembersResponse.getMembers().
final class	Callback	Callback properties for a Conversation.
static class	Callback.Params
class	Conversation	Represents a Conversation (request and response).
class	ConversationProperties	Additional properties for a Conversation.
class	ConversationTimestamp	Represents the timestamps in BaseConversation.getTimestamp().
final class	ConversationUpdatedEvent	Represents a EventType.CONVERSATION_UPDATED event.
final class	CustomEvent	Represents a Custom event.
final class	EphemeralEvent	Represents an Ephemeral event.
class	Event	Events are actions that occur within a conversation.
final class	EventDeleteEvent	Represents a EventType.EVENT_DELETE event.
class	GenericEvent
final class	ListConversationsResponse	HAL response for ConversationsClient.listConversations(ListConversationsRequest).
final class	ListEventsResponse	HAL response for ConversationsClient.listEvents(String, ListEventsRequest).
final class	ListMembersResponse	HAL response for ConversationsClient.listMembers(String, ListMembersRequest).
final class	ListUserConversationsResponse	HAL response for ConversationsClient.listUserConversations(String).
final class	Location	Describes parameters for a Location message in MessageEvent.getLocation().
class	MediaAudioSettings	Represents the audio options in MemberMedia.getAudioSettings().
class	Member	Represents a conversation membership.
class	MemberChannel	Contains the channel properties for Member.getChannel().
class	MemberInitiator
final class	MemberMedia	Contains the media properties for Member.getMedia().
class	MemberTimestamp	Represents the timestamps in Member.getTimestamp().
final class	MessageDeliveredEvent	Represents a EventType.MESSAGE_DELIVERED event.
final class	MessageEvent	Represents a EventType.MESSAGE event.
final class	MessageRejectedEvent	Represents a EventType.MESSAGE_REJECTED event.
final class	MessageSeenEvent	Represents a EventType.MESSAGE_SEEN event.
final class	MessageSubmittedEvent	Represents a EventType.MESSAGE_SUBMITTED event.
final class	MessageUndeliverableEvent	Represents a EventType.MESSAGE_UNDELIVERABLE event.
class	UserConversation	Response object when querying a user's conversations.

Uses of JsonableBaseObject in com.vonage.client.insight

Subclasses of JsonableBaseObject in com.vonage.client.insight

Modifier and Type	Class	Description
class	AdvancedInsightResponse	Response object constructed from the JSON payload returned for Advanced number insight requests.
class	BasicInsightResponse	Response object constructed from the JSON payload returned for Basic number insight requests.
class	CallerIdentity
class	CarrierDetails
class	RealTimeData	Real time data about the number.
class	RoamingDetails	Information about the roaming status for number.
class	StandardInsightResponse	Response object constructed from the JSON payload returned for Standard number insight requests.

Uses of JsonableBaseObject in com.vonage.client.meetings

Subclasses of JsonableBaseObject in com.vonage.client.meetings

Modifier and Type	Class	Description
class	Application
class	AvailableFeatures
class	CallbackUrls
class	DialInNumber	Details about a number that that can be used to dial into a meeting.
class	InitialJoinOptions
class	LogoUploadsUrlResponse
static class	LogoUploadsUrlResponse.Fields
class	MeetingRoom
class	MeetingsEventCallback	Represents a deserialized callback response webhook for event updates from the Meetings API.
class	Recording
class	RecordingOptions
class	RoomLinks
class	Theme
class	UISettings

Uses of JsonableBaseObject in com.vonage.client.messages

Subclasses of JsonableBaseObject in com.vonage.client.messages

Modifier and Type	Class	Description
final class	Button	Used for inbound Button messages.
class	InboundMessage	Convenience class representing an inbound message webhook.
protected static class	InboundMessage.Origin
protected static class	InboundMessage.UrlWrapper
protected static class	InboundMessage.UrlWrapperWithCaption
protected static class	InboundMessage.Whatsapp
class	MessageRequest	Abstract base class of all Messages sent via the Messages v1 API.
class	MessageResponse	Response returned when sending a message.
class	MessageStatus	This class represents the data of a callback which is invoked after a message has been sent.
static final class	MessageStatus.Error	Describes the error that was encountered when sending the message.
static final class	MessageStatus.Usage	Describes the charge incurred for sending the message.

Uses of JsonableBaseObject in com.vonage.client.messages.internal

Subclasses of JsonableBaseObject in com.vonage.client.messages.internal

Modifier and Type	Class	Description
class	MessagePayload	Container object for audio, video, image and file message payload contents.

Uses of JsonableBaseObject in com.vonage.client.messages.messenger

Subclasses of JsonableBaseObject in com.vonage.client.messages.messenger

Modifier and Type	Class	Description
final class	Messenger
final class	MessengerAudioRequest
final class	MessengerFileRequest
final class	MessengerImageRequest
class	MessengerRequest
final class	MessengerTextRequest
final class	MessengerVideoRequest

Uses of JsonableBaseObject in com.vonage.client.messages.mms

Subclasses of JsonableBaseObject in com.vonage.client.messages.mms

Modifier and Type	Class	Description
class	Content	Represents file attachments in InboundMessage.getContent().
final class	MmsAudioRequest
final class	MmsImageRequest
class	MmsRequest
final class	MmsVcardRequest
final class	MmsVideoRequest

Uses of JsonableBaseObject in com.vonage.client.messages.rcs

Subclasses of JsonableBaseObject in com.vonage.client.messages.rcs

Modifier and Type	Class	Description
final class	RcsCustomRequest	Channel.RCS, MessageType.CUSTOM request.
final class	RcsFileRequest	Channel.RCS, MessageType.FILE request.
final class	RcsImageRequest	Channel.RCS, MessageType.IMAGE request.
class	RcsRequest	Base class for RCS messages.
final class	RcsTextRequest	Channel.RCS, MessageType.TEXT request.
final class	RcsVideoRequest	Channel.RCS, MessageType.VIDEO request.

Uses of JsonableBaseObject in com.vonage.client.messages.sms

Subclasses of JsonableBaseObject in com.vonage.client.messages.sms

Modifier and Type	Class	Description
final class	OutboundSettings	Represents optional settings for the SMS message in SmsTextRequest.
final class	SmsInboundMetadata	Used to describe inbound SMS metadata.
final class	SmsTextRequest

Uses of JsonableBaseObject in com.vonage.client.messages.viber

Subclasses of JsonableBaseObject in com.vonage.client.messages.viber

Modifier and Type	Class	Description
final class	Action
final class	ViberFileRequest
final class	ViberImageRequest
class	ViberRequest
final class	ViberService
final class	ViberTextRequest
final class	ViberVideoRequest
final class	Video

Uses of JsonableBaseObject in com.vonage.client.messages.whatsapp

Subclasses of JsonableBaseObject in com.vonage.client.messages.whatsapp

Modifier and Type	Class	Description
final class	Context	This is only present for the Inbound Message where the user is quoting another message.
final class	Location	Whatsapp Location message parameters.
final class	Order	Used for inbound product orders.
final class	ProductItem	Used for inbound product orders.
final class	Profile	Used for inbound messages.
final class	Reaction	Represents a MessageType.REACTION message.
final class	Referral	This is only present for situations where a user has clicked on a 'WhatsApp' button embedded in an advertisement or post on Facebook.
final class	ReferredProduct	Contains details of a product from a product message being quoted or replied to using the 'Message Business' option.
final class	Reply	Used for inbound interactive messages.
final class	Sticker
final class	Template
final class	Whatsapp
final class	WhatsappAudioRequest
final class	WhatsappCustomRequest
final class	WhatsappFileRequest
final class	WhatsappImageRequest
final class	WhatsappLocationRequest
final class	WhatsappMultiProductRequest	See WhatsApp Product Messages documentation for details.
final class	WhatsappReactionRequest	Channel.WHATSAPP, MessageType.REACTION request.
class	WhatsappRequest
final class	WhatsappSingleProductRequest	See WhatsApp Product Messages documentation for details.
final class	WhatsappStickerRequest	See the documentation for more information on sending stickers.
final class	WhatsappTemplateRequest
final class	WhatsappTextRequest
final class	WhatsappVideoRequest

Uses of JsonableBaseObject in com.vonage.client.numberinsight2

Subclasses of JsonableBaseObject in com.vonage.client.numberinsight2

Modifier and Type	Class	Description
class	FraudCheckResponse	Fraud check results as obtained from NumberInsight2Client.fraudCheck(String, Insight, Insight...).
class	FraudScore	Represents the fraud score insight results in FraudCheckResponse.getFraudScore().
class	Phone	Represents details of the phone number in FraudCheckResponse.getPhone().
class	SimSwap	Represents the sim swap insight results in FraudCheckResponse.getSimSwap().

Uses of JsonableBaseObject in com.vonage.client.numbers

Subclasses of JsonableBaseObject in com.vonage.client.numbers

Modifier and Type	Class	Description
class	AvailableNumber	Represents a number that is available to buy.
class	ListNumbersResponse	Response from a request to list the numbers currently being rented buy an account.
class	OwnedNumber	Represents a number that is being rented by your account.
class	SearchNumbersResponse	Represents the response to a "searchNumbers" request from the Vonage API.

Uses of JsonableBaseObject in com.vonage.client.proactiveconnect

Subclasses of JsonableBaseObject in com.vonage.client.proactiveconnect

Modifier and Type	Class	Description
class	ContactsList	Represents a Proactive Connect list.
class	Datasource	Base class for datasource types used in Proactive Connect lists.
class	Event	Represents an event in the Proactive Connect API.
class	ListAttribute	Represents a Proactive Connect list's attributes property.
class	ListItem	Represents a list item in the Proactive Connect API.
final class	ListItemsResponse	HAL response for ProactiveConnectClient.listItems(UUID, int, int, SortOrder).
final class	ListListsResponse	HAL response for ProactiveConnectClient.listLists(int, int, SortOrder).
class	ManualDatasource	Represents the manual datasource type for a Proactive Connect list.
class	SalesforceDatasource	Represents the salesforce datasource type for a Proactive Connect list.
class	SyncStatus	Provides info on list changes compared to the latest sync.
class	UploadListItemsResponse	Results from list upload.

Uses of JsonableBaseObject in com.vonage.client.sms

Subclasses of JsonableBaseObject in com.vonage.client.sms

Modifier and Type	Class	Description
final class	MessageEvent	Represents an Inbound SMS webhook.
class	SmsSubmissionResponse
class	SmsSubmissionResponseMessage

Uses of JsonableBaseObject in com.vonage.client.subaccounts

Subclasses of JsonableBaseObject in com.vonage.client.subaccounts

Modifier and Type	Class	Description
class	Account	Represents a subaccount.
class	CreateSubaccountRequest
class	ListSubaccountsResponse	Response container for SubaccountsClient.listSubaccounts().
class	MoneyTransfer	Represents a credit or balance transfer between accounts.
class	NumberTransfer
class	UpdateSubaccountRequest

Uses of JsonableBaseObject in com.vonage.client.users

Subclasses of JsonableBaseObject in com.vonage.client.users

Modifier and Type	Class	Description
class	BaseUser	Represents the main attributes of a User.
class	ListUsersResponse	Paginated HAL response for UsersClient.listUsers(ListUsersRequest).
class	User	Represents a Vonage User (both request and response).

Uses of JsonableBaseObject in com.vonage.client.users.channels

Subclasses of JsonableBaseObject in com.vonage.client.users.channels

Modifier and Type	Class	Description
class	Channel	Base class for channels.
final class	Channels	Represents the "channels" field on User.
class	Messenger	Represents a Facebook Messenger channel.
class	Mms	Represents a Multimedia Messaging Service (MMS) channel.
class	Pstn	Represents a Public Switched Telephone Network (PSTN) channel.
class	Sip	Represents a Session Initiation Protocol (SIP) channel.
class	Sms	Represents a Short Messaging Service (SMS) channel.
class	Vbc	Represents a Vonage Business Cloud (VBC) channel.
class	Viber	Represents a Viber channel.
class	Websocket	Represents a Websocket channel.
class	Whatsapp	Represents a WhatsApp channel.
class	WhatsappVoice	Represents a WhatsApp Voice channel.

Uses of JsonableBaseObject in com.vonage.client.verify

Subclasses of JsonableBaseObject in com.vonage.client.verify

Modifier and Type	Class	Description
class	CheckResponse
class	ControlResponse
class	SearchVerifyResponse
class	VerifyCheck
class	VerifyDetails
class	VerifyResponse

Uses of JsonableBaseObject in com.vonage.client.verify2

Subclasses of JsonableBaseObject in com.vonage.client.verify2

Modifier and Type	Class	Description
final class	EmailWorkflow	Defines properties for sending a verification code to a user via e-mail.
final class	ListTemplateFragmentsResponse	Represents a response page for listing template fragments.
final class	ListTemplatesResponse	Represents a response page for listing templates.
final class	SilentAuthWorkflow	Defines properties for mobile network-based authentication.
final class	SmsWorkflow	Defines workflow properties for sending a verification code to a user via SMS.
final class	Template	Represents a custom template.
final class	TemplateFragment	Represents a custom template fragment.
class	VerificationCallback	Webhook for verification status updates and events.
class	VerificationResponse	Metadata about an outbound verification request.
final class	VerifyCodeResponse	Represents the response from Verify2Client.checkVerificationCode(UUID, String).
final class	VoiceWorkflow	Defines workflow properties for sending a verification code to a user over a voice call.
final class	WhatsappCodelessWorkflow	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.
final class	WhatsappWorkflow	Defines properties for sending a verification code to a user over a WhatsApp message.
class	Workflow	Base workflow.
class	WorkflowStatus	Describes the status of a workflow.

Uses of JsonableBaseObject in com.vonage.client.video

Subclasses of JsonableBaseObject in com.vonage.client.video

Modifier and Type	Class	Description
class	Archive	Represents an archive of a video session.
class	Broadcast	Represents properties of a live-streaming broadcast.
class	BroadcastUrls	Container for details about the HLS and RTMP broadcasts.
final class	CaptionsRequest	Defines the captioning properties used in VideoClient.startCaptions(CaptionsRequest).
final class	CaptionsResponse	Represents the response from VideoClient.startCaptions(CaptionsRequest).
final class	ConnectRequest	Defines properties used for Audio Connector.
final class	ConnectResponse	Represents the response from VideoClient.startCaptions(CaptionsRequest).
class	CreateSessionResponse
class	GetStreamResponse	Represents details of a stream, as returned from VideoClient.getStream(String, String).
class	Hls	Represents HTTP Live Streaming (HLS) options for a Broadcast.
class	ProjectDetails	Represents properties of a video project.
final class	RenderRequest	Defines the parameters for starting an Experience Composer session.
static final class	RenderRequest.Properties	Publisher initial configuration properties for the composed output stream.
class	RenderResponse	Represents an Experience Composer response.
class	Rtmp	Represents an RTMP stream in a video session.
class	SessionStream	Represents a stream's metadata in a Vonage Video session.
class	SignalRequest
class	SipDialRequest	Represents an outbound SIP dial request's properties.
class	SipDialResponse	Represents a Vonage Video SIP call.
class	StreamComposition	Base class for Broadcast and Archive.
class	StreamCompositionLayout	Defines the properties used for VideoClient.updateArchiveLayout(String, StreamCompositionLayout).
class	VideoStream
final class	Websocket	Defines the properties in ConnectRequest.getWebsocket().

Uses of JsonableBaseObject in com.vonage.client.voice

Subclasses of JsonableBaseObject in com.vonage.client.voice

Modifier and Type	Class	Description
class	AdvancedMachineDetection	Configure the behavior of Vonage's advanced machine detection.
class	AnswerWebhook	Maps the fields for data sent to the answer_url configured in your voice application.
class	AppEndpoint	Represents an app-to-app call type.
class	Call	Call encapsulates the information required to create a call using VoiceClient.createCall(Call)
class	CallEvent	Represents metadata about a call.
class	CallInfo	CallInfo holds the information related to a call.
class	CallInfoPage
class	DtmfResponse	Response if DTMF tones were successfully sent to an active Call.
class	DtmfResult	Represents the DTMF event results in EventWebhook.getDtmf().
class	EmbeddedCalls
class	EventWebhook	Represents all call events sent to the event_url webhook configured in your Voice application settings.
class	PageLink
class	PageLinks	Deprecated. Will be replaced by HalLinks in a future release.
class	PhoneEndpoint
class	SipEndpoint	Endpoint for connecting to a SIP URI.
class	SpeechResults	Represents the speech recognition results in EventWebhook.getSpeech().
class	SpeechTranscript	Represents speech to text data contained in SpeechResults.getResults().
class	StreamResponse	Response from successfully streaming an audio file or stopping a stream to an active Call.
final class	TalkPayload	Defines the text-to-speech properties.
class	TalkResponse	Response from successfully sending a synthesized speech message or stopping a message to an active Call.
class	VbcEndpoint	Represents a VBC call type.
class	WebSocketEndpoint

Uses of JsonableBaseObject in com.vonage.client.voice.ncco

Subclasses of JsonableBaseObject in com.vonage.client.voice.ncco

Modifier and Type	Class	Description
class	AppEndpoint	Represents an app endpoint used in a ConnectAction.
class	ConnectAction	An NCCO connect action that allows for the establishment of a connection to various Endpoint.
class	ConversationAction	An NCCO conversation action which enables the ability to host conference calls.
class	DtmfSettings	DTMF (Dial Tone Multi Frequency) settings for Input Actions that will be added to a NCCO object.
class	InputAction	An NCCO input action which allows for the collection of digits and automatic speech recognition from a person.
class	NotifyAction	An NCCO notify action which allows for custom events to be sent to a configured webhook.
class	PhoneEndpoint	Represents a phone endpoint used in a ConnectAction.
final class	RecordAction	An NCCO record action which allows for the call to be recorded.
class	SipEndpoint	Represents a SIP endpoint used in a ConnectAction.
class	SpeechSettings	ASR (Automatic Speech Recognition) settings for Input Actions that will be added to a NCCO object.
class	StreamAction	An NCCO stream action which allows for media to be streamed to a call.
class	TalkAction	An NCCO talk action which allows for synthesized speech to be sent to a call.
final class	TranscriptionSettings	Customisable settings for call recording transcription.
class	VbcEndpoint	Represents a VBC endpoint used in a ConnectAction.
class	WebSocketEndpoint	Represents a web socket endpoint used in a ConnectAction.