Uses of Interface
com.vonage.client.Jsonable
Packages that use Jsonable
Package
Description
The root of the Vonage client library, containing
VonageClient class, which is probably what
you want.Implementation of the Application API.
This package contains classes to support usage of the
Vonage Network Auth API.
This package contains classes and subpackages to support usage of the
Vonage Network APIs.
Implementation of the Conversation API.
This package contains classes and sub-packages to support usage of the
Meetings API.
This package contains classes and sub-packages to support usage of the
Vonage Messages API.
Implementation of the
Number Insight v2 API.
This package contains classes and sub-packages to support usage of the
Vonage Proactive Connect API.
This package contains classes and sub-packages to support usage of the
Vonage SMS API.
Implementation of the Subaccounts API.
Implementation of the Verify v2 API.
This package contains classes to support usage of the Video API.
Implementation of the Vonage Voice API.
Provides useful NCCO classes which can be serialized using Jackson when
implementing webhooks to drive the Vonage Voice API.
-
Uses of Jsonable in com.vonage.client
Classes in com.vonage.client that implement JsonableModifier and TypeClassDescriptionclassBase class for requests and responses which are serialised and parsed to and from JSON.classBase class for exceptions which represent an error API response conforming to RFC 7807 standard.Methods in com.vonage.client with type parameters of type JsonableModifier and TypeMethodDescriptionstatic <J extends Jsonable>
JDelegates to fromJson(String, Class), using the type varargs for inferring the class.static <J extends Jsonable>
JCreates a new instance of the designated Jsonable class, calling its no-args constructor followed byupdateFromJson(String).Methods in com.vonage.client with parameters of type JsonableModifier and TypeMethodDescriptionstatic <J extends Jsonable>
JDelegates to fromJson(String, Class), using the type varargs for inferring the class. -
Uses of Jsonable in com.vonage.client.account
Classes in com.vonage.client.account that implement JsonableModifier and TypeClassDescriptionfinal classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classResponse data for theAccountClient.getBalance()method.classGroups the country details inPricingResponse.classHAL response forAccountClient.listSecrets(String).classRepresents a network inPricingResponse.classDeprecated.This will be removed in favour of returning the list of countries' pricing directly.classPricing information for a specific country.classRepresents metadata about an API account secret.classDetails of the configured account settings. -
Uses of Jsonable in com.vonage.client.application
Classes in com.vonage.client.application that implement JsonableModifier and TypeClassDescriptionclassRepresents a Vonage Application (both request and response).static classstatic classRepresents the cryptographic keys of an Application.static classApplication privacy configuration settings.classHAL response returned fromApplicationClient.listApplications(ListApplicationRequest).final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code). -
Uses of Jsonable in com.vonage.client.application.capabilities
Classes in com.vonage.client.application.capabilities that implement JsonableModifier and TypeClassDescriptionclassRepresents a capability of a Vonage Applicationfinal classMessages capability configuration settings.final classNetwork APIs capability configuration settings.final classRtc capability configuration settings.final classVBC capability configuration settings.final classVerify capability configuration settings.final classVoice capability configuration settings. -
Uses of Jsonable in com.vonage.client.auth.camara
Classes in com.vonage.client.auth.camara that implement JsonableModifier and TypeClassDescriptionfinal classRepresents the response from the first step in an OAuth2 three-legged workflow.final classResponse returned when an authentication request fails (i.e. returns a non-2xx status code).final class -
Uses of Jsonable in com.vonage.client.camara
Classes in com.vonage.client.camara that implement JsonableModifier and TypeClassDescriptionclassResponse returned when a network request fails (i.e. returns a non-2xx status code). -
Uses of Jsonable in com.vonage.client.common
Classes in com.vonage.client.common that implement JsonableModifier and TypeClassDescriptionclassRepresents the_linkssection of a HAL response.classAbstract base class for responses that conform to the HAL specification.classRepresents a link under the_linkssection of a HAL response.classDeprecated.Will be moved to thecom.vonage.client.applicationpackage. -
Uses of Jsonable in com.vonage.client.conversations
Classes in com.vonage.client.conversations that implement JsonableModifier and TypeClassDescriptionfinal classRepresents anEventType.AUDIO_EARMUFF_OFFevent.final classRepresents anEventType.AUDIO_EARMUFF_ONevent.final classRepresents anEventType.AUDIO_MUTE_OFFevent.final classRepresents anEventType.AUDIO_MUTE_ONevent.final classRepresents anEventType.AUDIO_PLAY_DONEevent.final classRepresents anEventType.AUDIO_PLAYevent.final classRepresents anEventType.AUDIO_PLAY_STOPevent.final classRepresents anEventType.AUDIO_RECORDevent.final classRepresents anEventType.AUDIO_RECORD_STOPevent.final classRepresents anEventType.AUDIO_SAY_DONEevent.final classRepresents anEventType.AUDIO_SAYevent.final classRepresents anEventType.AUDIO_SAY_STOPevent.classRepresents the main attributes of a conversation.classRepresents the basic conversation member attributes, as returned fromListMembersResponse.getMembers().final classCallback properties for aConversation.static classclassRepresents a Conversation (request and response).classAdditional properties for a Conversation.final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classRepresents the timestamps inBaseConversation.getTimestamp().final classRepresents aEventType.CONVERSATION_UPDATEDevent.final classRepresents a Custom event.final classRepresents an Ephemeral event.classEvents are actions that occur within a conversation.final classRepresents aEventType.EVENT_DELETEevent.classfinal classHAL response forConversationsClient.listConversations(ListConversationsRequest).final classHAL response forConversationsClient.listEvents(String, ListEventsRequest).final classHAL response forConversationsClient.listMembers(String, ListMembersRequest).final classHAL response forConversationsClient.listUserConversations(String).final classDescribes parameters for a Location message inMessageEvent.getLocation().classRepresents the audio options inMemberMedia.getAudioSettings().classRepresents a conversation membership.classContains the channel properties forMember.getChannel().classfinal classContains the media properties forMember.getMedia().classRepresents the timestamps inMember.getTimestamp().final classRepresents aEventType.MESSAGE_DELIVEREDevent.final classRepresents aEventType.MESSAGEevent.final classRepresents aEventType.MESSAGE_REJECTEDevent.final classRepresents aEventType.MESSAGE_SEENevent.final classRepresents aEventType.MESSAGE_SUBMITTEDevent.final classRepresents aEventType.MESSAGE_UNDELIVERABLEevent.final classOptions for updating a membership usingConversationsClient.updateMember(UpdateMemberRequest).classResponse object when querying a user's conversations. -
Uses of Jsonable in com.vonage.client.incoming
Classes in com.vonage.client.incoming that implement JsonableModifier and TypeClassDescriptionclassDeprecated.UseEventWebhook.classDeprecated.UseEventWebhook.classDeprecated.Moved toMessageEvent.classDeprecated.UseEventWebhook.classDeprecated.UseEventWebhook. -
Uses of Jsonable in com.vonage.client.insight
Classes in com.vonage.client.insight that implement JsonableModifier and TypeClassDescriptionclassResponse object constructed from the JSON payload returned for Advanced number insight requests.classResponse object constructed from the JSON payload returned for Basic number insight requests.classclassclassReal time data about the number.classInformation about the roaming status for number.classResponse object constructed from the JSON payload returned for Standard number insight requests. -
Uses of Jsonable in com.vonage.client.meetings
Classes in com.vonage.client.meetings that implement JsonableModifier and TypeClassDescriptionclassclassclassclassDetails about a number that that can be used to dial into a meeting.classclassstatic classclassclassRepresents a deserialized callback response webhook for event updates from the Meetings API.final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classclassclassclassclassclassclass -
Uses of Jsonable in com.vonage.client.messages
Classes in com.vonage.client.messages that implement JsonableModifier and TypeClassDescriptionfinal classUsed for inbound Button messages.classConvenience class representing an inbound message webhook.protected static classprotected static classprotected static classprotected static classclassAbstract base class of all Messages sent via the Messages v1 API.classResponse returned when sending a message.final classResponse returned when sending a message fails (i.e. returns a non-2xx status code).classThis class represents the data of a callback which is invoked after a message has been sent.static final classDescribes the error that was encountered when sending the message.static final classDescribes the charge incurred for sending the message. -
Uses of Jsonable in com.vonage.client.messages.internal
Classes in com.vonage.client.messages.internal that implement JsonableModifier and TypeClassDescriptionclassContainer object for audio, video, image and file message payload contents. -
Uses of Jsonable in com.vonage.client.messages.messenger
Classes in com.vonage.client.messages.messenger that implement JsonableModifier and TypeClassDescriptionfinal classfinal classfinal classfinal classclassfinal classfinal class -
Uses of Jsonable in com.vonage.client.messages.mms
Classes in com.vonage.client.messages.mms that implement JsonableModifier and TypeClassDescriptionclassRepresents file attachments inInboundMessage.getContent().final classfinal classclassfinal classfinal class -
Uses of Jsonable in com.vonage.client.messages.rcs
Classes in com.vonage.client.messages.rcs that implement JsonableModifier and TypeClassDescriptionfinal classChannel.RCS,MessageType.CUSTOMrequest.final classChannel.RCS,MessageType.FILErequest.final classChannel.RCS,MessageType.IMAGErequest.classBase class for RCS messages.final classChannel.RCS,MessageType.TEXTrequest.final classChannel.RCS,MessageType.VIDEOrequest. -
Uses of Jsonable in com.vonage.client.messages.sms
Classes in com.vonage.client.messages.sms that implement JsonableModifier and TypeClassDescriptionfinal classRepresents optional settings for the SMS message inSmsTextRequest.final classUsed to describe inbound SMS metadata.final class -
Uses of Jsonable in com.vonage.client.messages.viber
Classes in com.vonage.client.messages.viber that implement JsonableModifier and TypeClassDescriptionfinal classfinal classfinal classclassfinal classfinal classfinal classfinal class -
Uses of Jsonable in com.vonage.client.messages.whatsapp
Classes in com.vonage.client.messages.whatsapp that implement JsonableModifier and TypeClassDescriptionfinal classThis is only present for the Inbound Message where the user is quoting another message.final classWhatsapp Location message parameters.final classUsed for inbound product orders.final classUsed for inbound product orders.final classUsed for inbound messages.final classRepresents a MessageType.REACTION message.final classThis is only present for situations where a user has clicked on a 'WhatsApp' button embedded in an advertisement or post on Facebook.final classContains details of a product from a product message being quoted or replied to using the 'Message Business' option.final classUsed for inbound interactive messages.final classfinal classfinal classfinal classfinal classfinal classfinal classfinal classfinal classfinal classChannel.WHATSAPP,MessageType.REACTIONrequest.classfinal classfinal classSee the documentation for more information on sending stickers.final classfinal classfinal class -
Uses of Jsonable in com.vonage.client.numberinsight2
Classes in com.vonage.client.numberinsight2 that implement JsonableModifier and TypeClassDescriptionclassFraud check results as obtained fromNumberInsight2Client.fraudCheck(String, Insight, Insight...).classRepresents the fraud score insight results inFraudCheckResponse.getFraudScore().final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classRepresents details of the phone number inFraudCheckResponse.getPhone().classRepresents the sim swap insight results inFraudCheckResponse.getSimSwap(). -
Uses of Jsonable in com.vonage.client.numbers
Classes in com.vonage.client.numbers that implement JsonableModifier and TypeClassDescriptionclassRepresents a number that is available to buy.classResponse from a request to list the numbers currently being rented buy an account.final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classRepresents a number that is being rented by your account.classRepresents the response to a "searchNumbers" request from the Vonage API. -
Uses of Jsonable in com.vonage.client.proactiveconnect
Classes in com.vonage.client.proactiveconnect that implement JsonableModifier and TypeClassDescriptionclassRepresents a Proactive Connect list.classBase class for datasource types used in Proactive Connect lists.classRepresents an event in the Proactive Connect API.classRepresents a Proactive Connect list'sattributesproperty.classRepresents a list item in the Proactive Connect API.final classHAL response forProactiveConnectClient.listItems(UUID, int, int, SortOrder).final classHAL response forProactiveConnectClient.listLists(int, int, SortOrder).classRepresents themanualdatasource type for a Proactive Connect list.final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classRepresents thesalesforcedatasource type for a Proactive Connect list.classProvides info on list changes compared to the latest sync.classResults from list upload. -
Uses of Jsonable in com.vonage.client.redact
Classes in com.vonage.client.redact that implement JsonableModifier and TypeClassDescriptionclassRepresents a request to the Redact API.final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code). -
Uses of Jsonable in com.vonage.client.sms
Classes in com.vonage.client.sms that implement Jsonable -
Uses of Jsonable in com.vonage.client.subaccounts
Classes in com.vonage.client.subaccounts that implement JsonableModifier and TypeClassDescriptionclassRepresents a subaccount.classclassResponse container forSubaccountsClient.listSubaccounts().classRepresents a credit or balance transfer between accounts.classfinal classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).class -
Uses of Jsonable in com.vonage.client.users
Classes in com.vonage.client.users that implement JsonableModifier and TypeClassDescriptionclassRepresents the main attributes of a User.classPaginated HAL response forUsersClient.listUsers(ListUsersRequest).classRepresents a Vonage User (both request and response).final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code). -
Uses of Jsonable in com.vonage.client.users.channels
Classes in com.vonage.client.users.channels that implement JsonableModifier and TypeClassDescriptionclassBase class for channels.final classRepresents the "channels" field onUser.classRepresents a Facebook Messenger channel.classRepresents a Multimedia Messaging Service (MMS) channel.classRepresents a Public Switched Telephone Network (PSTN) channel.classRepresents a Session Initiation Protocol (SIP) channel.classRepresents a Short Messaging Service (SMS) channel.classRepresents a Vonage Business Cloud (VBC) channel.classRepresents a Viber channel.classRepresents a Websocket channel.classRepresents a WhatsApp channel.classRepresents a WhatsApp Voice channel. -
Uses of Jsonable in com.vonage.client.verify
Classes in com.vonage.client.verify that implement JsonableModifier and TypeClassDescriptionclassclassclassclassclassclass -
Uses of Jsonable in com.vonage.client.verify2
Classes in com.vonage.client.verify2 that implement JsonableModifier and TypeClassDescriptionfinal classDefines properties for sending a verification code to a user via e-mail.final classRepresents a response page for listing template fragments.final classRepresents a response page for listing templates.final classDefines properties for mobile network-based authentication.final classDefines workflow properties for sending a verification code to a user via SMS.final classRepresents a custom template.final classRepresents a custom template fragment.classWebhook for verification status updates and events.classDefines properties for a verify request to be sent to the user.classMetadata about an outbound verification request.final classRepresents the response fromVerify2Client.checkVerificationCode(UUID, String).final classResponse returned when verification fails (i.e. returns a non-2xx status code).final classDefines workflow properties for sending a verification code to a user over a voice call.final classDefines 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 classDefines properties for sending a verification code to a user over a WhatsApp message.classBase workflow.classDescribes the status of a workflow. -
Uses of Jsonable in com.vonage.client.video
Classes in com.vonage.client.video that implement JsonableModifier and TypeClassDescriptionclassRepresents an archive of a video session.classRepresents properties of a live-streaming broadcast.classContainer for details about the HLS and RTMP broadcasts.final classDefines the captioning properties used inVideoClient.startCaptions(CaptionsRequest).final classRepresents the response fromVideoClient.startCaptions(CaptionsRequest).final classDefines properties used for Audio Connector.final classRepresents the response fromVideoClient.startCaptions(CaptionsRequest).classclassRepresents details of a stream, as returned fromVideoClient.getStream(String, String).classRepresents HTTP Live Streaming (HLS) options for aBroadcast.classRepresents properties of a video project.final classDefines the parameters for starting an Experience Composer session.static final classPublisher initial configuration properties for the composed output stream.classRepresents an Experience Composer response.classRepresents an RTMP stream in a video session.classRepresents a stream's metadata in a Vonage Video session.classclassRepresents an outbound SIP dial request's properties.classRepresents a Vonage Video SIP call.classclassDefines the properties used forVideoClient.updateArchiveLayout(String, StreamCompositionLayout).final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).classfinal classDefines the properties inConnectRequest.getWebsocket(). -
Uses of Jsonable in com.vonage.client.voice
Classes in com.vonage.client.voice that implement JsonableModifier and TypeClassDescriptionclassConfigure the behavior of Vonage's advanced machine detection.classMaps the fields for data sent to theanswer_urlconfigured in your voice application.classRepresents an app-to-app call type.classCall encapsulates the information required to create a call usingVoiceClient.createCall(Call)classRepresents metadata about a call.classCallInfo holds the information related to a call.classclassResponse if DTMF tones were successfully sent to an activeCall.classRepresents the DTMF event results inEventWebhook.getDtmf().classclassRepresents all call events sent to theevent_urlwebhook configured in your Voice application settings.classclassDeprecated.Will be replaced byHalLinksin a future release.classclassEndpoint for connecting to a SIP URI.classRepresents the speech recognition results inEventWebhook.getSpeech().classRepresents speech to text data contained inSpeechResults.getResults().classResponse from successfully streaming an audio file or stopping a stream to an activeCall.final classDefines the text-to-speech properties.classResponse from successfully sending a synthesized speech message or stopping a message to an activeCall.classRepresents a VBC call type.final classResponse returned when an error is encountered (i.e. the API returns a non-2xx status code).class -
Uses of Jsonable in com.vonage.client.voice.ncco
Classes in com.vonage.client.voice.ncco that implement JsonableModifier and TypeClassDescriptionclassRepresents an app endpoint used in aConnectAction.classAn NCCO connect action that allows for the establishment of a connection to variousEndpoint.classAn NCCO conversation action which enables the ability to host conference calls.classDTMF (Dial Tone Multi Frequency) settings for Input Actions that will be added to a NCCO object.classAn NCCO input action which allows for the collection of digits and automatic speech recognition from a person.classVonage Call Control Object for controlling the flow of a Voice API call.classAn NCCO notify action which allows for custom events to be sent to a configured webhook.classRepresents a phone endpoint used in aConnectAction.final classAn NCCO record action which allows for the call to be recorded.classRepresents a SIP endpoint used in aConnectAction.classASR (Automatic Speech Recognition) settings for Input Actions that will be added to a NCCO object.classAn NCCO stream action which allows for media to be streamed to a call.classAn NCCO talk action which allows for synthesized speech to be sent to a call.final classCustomisable settings for call recording transcription.classRepresents a VBC endpoint used in aConnectAction.classRepresents a web socket endpoint used in aConnectAction.