Package com.vonage.client.messages

Class InboundMessage

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.messages.InboundMessage

All Implemented Interfaces:

Jsonable

public class InboundMessage
extends JsonableBaseObject

Convenience class representing an inbound message webhook. This maps all known fields for all message types.

Refer to the Messages API Webhook reference for more details on the response object structure.

Since:

7.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	InboundMessage.Origin
protected static class	InboundMessage.UrlWrapper
protected static class	InboundMessage.UrlWrapperWithCaption
protected static class	InboundMessage.Whatsapp

Field Summary

Fields

Modifier and Type	Field	Description
protected InboundMessage.UrlWrapper	audio
protected Button	button
protected Channel	channel
protected String	clientRef
protected List<Content>	content
protected InboundMessage.UrlWrapper	file
protected String	from
protected InboundMessage.UrlWrapperWithCaption	image
protected MessageType	messageType
protected UUID	messageUuid
protected InboundMessage.Origin	origin
protected Reaction	reaction
protected SmsInboundMetadata	smsMetadata
protected InboundMessage.UrlWrapper	sticker
protected String	text
protected Instant	timestamp
protected String	to
protected Map<String,Object>	unknownProperties
protected MessageStatus.Usage	usage
protected InboundMessage.UrlWrapper	vcard
protected InboundMessage.UrlWrapper	video
protected Context	whatsappContext
protected ContextStatus	whatsappContextStatus
protected Location	whatsappLocation
protected Order	whatsappOrder
protected Profile	whatsappProfile
protected Reply	whatsappReply

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InboundMessage()

Method Summary

Modifier and Type	Method	Description
static InboundMessage	fromJson(String json)	Constructs an instance of this class from a JSON payload.
URI	getAudioUrl()	If getMessageType() is MessageType.AUDIO, returns the URL of the audio.
Button	getButton()	If getMessageType() is MessageType.BUTTON, returns the button.
Channel	getChannel()	The service used to send the message.
String	getClientRef()	The client reference will be present if set in the original outbound message.
List<Content>	getContent()	If the getChannel() is Channel.MMS, returns a list of one or more objects representing image, audio, video, vCard, or file attachments.
URI	getFileUrl()	If getMessageType() is MessageType.FILE, returns the URL of the file.
String	getFrom()	The number this message was sent from.
String	getImageCaption()	Additional text accompanying the image.
URI	getImageUrl()	If getMessageType() is MessageType.IMAGE, returns the URL of the image.
MessageType	getMessageType()	The media type of the message.
UUID	getMessageUuid()	Unique identifier of the message that was sent.
String	getNetworkCode()	If the getChannel() is Channel.SMS or Channel.MMS, return the network code from which the message originated (if available).
String	getProviderMessage()	If getChannel() is Channel.WHATSAPP, returns the provider_message field.
Reaction	getReaction()	If getMessageType() is MessageType.REACTION, returns the reaction.
URI	getSelfUrl()	The URL for the message resource, including the geo-specific base URI.
SmsInboundMetadata	getSmsMetadata()	If the getChannel() is Channel.SMS, returns additional information about the message.
URI	getStickerUrl()	If getMessageType() is MessageType.STICKER, returns the URL of the sticker.
String	getText()	If getMessageType() is MessageType.TEXT, returns the message text.
Instant	getTimestamp()	The datetime of when the event occurred.
String	getTo()	The number this message was sent to.
Map<String,?>	getUnmappedProperties()	This is a catch-all method which encapsulates all fields in the response JSON that are not already a field in this class.
MessageStatus.Usage	getUsage()	If the getChannel() is Channel.SMS, returns the usage information (charged incurred for the message).
String	getVcardName()	If getMessageType() is MessageType.VCARD and getChannel() is Channel.RCS, returns the name of the vCard.
URI	getVcardUrl()	If getMessageType() is MessageType.VCARD, returns the URL of the vCard.
URI	getVideoUrl()	If getMessageType() is MessageType.VIDEO, returns the URL of the video.
Context	getWhatsappContext()	If the getChannel() is Channel.WHATSAPP, returns the WhatsApp message context.
ContextStatus	getWhatsappContextStatus()	If the getChannel() is Channel.WHATSAPP, returns an enum indicating whether there is a context for this inbound message.
Location	getWhatsappLocation()	If getMessageType() is MessageType.LOCATION and getChannel() is Channel.WHATSAPP, returns the location.
Order	getWhatsappOrder()	If getMessageType() is MessageType.ORDER and getChannel() is Channel.WHATSAPP, returns the order.
Profile	getWhatsappProfile()	If the getChannel() is Channel.WHATSAPP, returns information about the sender's WhatsApp profile.
Referral	getWhatsappReferral()	If the 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.
Reply	getWhatsappReply()	If getMessageType() is MessageType.REPLY and getChannel() is Channel.WHATSAPP, returns the reply.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Field Details

unknownProperties

protected Map<String,Object> unknownProperties

timestamp

protected Instant timestamp

channel

protected Channel channel

messageType

protected MessageType messageType

messageUuid

protected UUID messageUuid

to

protected String to

from

protected String from

clientRef

protected String clientRef

text

protected String text

image

protected InboundMessage.UrlWrapperWithCaption image

audio

protected InboundMessage.UrlWrapper audio

video

protected InboundMessage.UrlWrapper video

file

protected InboundMessage.UrlWrapper file

vcard

protected InboundMessage.UrlWrapper vcard

sticker

protected InboundMessage.UrlWrapper sticker

reaction

protected Reaction reaction

button

protected Button button

whatsappProfile

protected Profile whatsappProfile

whatsappContextStatus

protected ContextStatus whatsappContextStatus

whatsappContext

protected Context whatsappContext

whatsappLocation

protected Location whatsappLocation

whatsappReply

protected Reply whatsappReply

whatsappOrder

protected Order whatsappOrder

usage

protected MessageStatus.Usage usage

smsMetadata

protected SmsInboundMetadata smsMetadata

origin

protected InboundMessage.Origin origin

content

protected List<Content> content

Constructor Details

InboundMessage

protected InboundMessage()

Method Details

getUnmappedProperties

public Map<String,?> getUnmappedProperties()

This is a catch-all method which encapsulates all fields in the response JSON that are not already a field in this class.

Returns:

The Map of unknown properties to their values.

getMessageType

public MessageType getMessageType()

The media type of the message.

Returns:

The message type, as an enum.

getChannel

public Channel getChannel()

The service used to send the message.

Returns:

The channel, as an enum.

getMessageUuid

public UUID getMessageUuid()

Unique identifier of the message that was sent.

Returns:

The UUID of the message.

getTo

public String getTo()

The number this message was sent to.

Returns:

The recipient number or ID.

getFrom

public String getFrom()

The number this message was sent from.

Returns:

The sender number or ID.

getTimestamp

public Instant getTimestamp()

The datetime of when the event occurred.

Returns:

The timestamp as an Instant.

getClientRef

public String getClientRef()

The client reference will be present if set in the original outbound message.

Returns:

The client reference, or null if unset.

getSelfUrl

public URI getSelfUrl()

The URL for the message resource, including the geo-specific base URI.

Returns:

The _self.href property as a URI, or null if absent.

Since:

8.11.0

getText

public String getText()

If getMessageType() is MessageType.TEXT, returns the message text.

Returns:

The message text, or null if not applicable.

getImageUrl

public URI getImageUrl()

If getMessageType() is MessageType.IMAGE, returns the URL of the image.

Returns:

The image URL, or null if not applicable.

getImageCaption

public String getImageCaption()

Additional text accompanying the image. Applicable to MMS image messages only.

Returns:

The image caption if present, or null if not applicable.

Since:

8.1.0

getAudioUrl

public URI getAudioUrl()

If getMessageType() is MessageType.AUDIO, returns the URL of the audio.

Returns:

The audio URL, or null if not applicable.

getVideoUrl

public URI getVideoUrl()

If getMessageType() is MessageType.VIDEO, returns the URL of the video.

Returns:

The video URL, or null if not applicable.

getFileUrl

public URI getFileUrl()

If getMessageType() is MessageType.FILE, returns the URL of the file.

Returns:

The file URL, or null if not applicable.

getVcardUrl

public URI getVcardUrl()

If getMessageType() is MessageType.VCARD, returns the URL of the vCard.

Returns:

The vCard URL, or null if not applicable.

getVcardName

public String getVcardName()

If getMessageType() is MessageType.VCARD and getChannel() is Channel.RCS, returns the name of the vCard.

Returns:

The vCard attachment file name, or null if absent / not applicable.

Since:

8.11.0

getStickerUrl

public URI getStickerUrl()

If getMessageType() is MessageType.STICKER, returns the URL of the sticker.

Returns:

The sticker URL, or null if not applicable.

getReaction

public Reaction getReaction()

If getMessageType() is MessageType.REACTION, returns the reaction.

Returns:

The reaction details, or null if not applicable.

Since:

8.11.0

getButton

public Button getButton()

If getMessageType() is MessageType.BUTTON, returns the button.

Returns:

The button details, or null if not applicable.

Since:

8.11.0

getProviderMessage

public String getProviderMessage()

If getChannel() is Channel.WHATSAPP, returns the provider_message field. This is a message from the channel provider, which may contain a description, error codes or other information.

Returns:

The provider message or null if not applicable.

getWhatsappLocation

public Location getWhatsappLocation()

If getMessageType() is MessageType.LOCATION and getChannel() is Channel.WHATSAPP, returns the location.

Returns:

The deserialized WhatsApp location, or null if not applicable.

getWhatsappReply

public Reply getWhatsappReply()

If getMessageType() is MessageType.REPLY and getChannel() is Channel.WHATSAPP, returns the reply.

Returns:

The deserialized WhatsApp reply, or null if not applicable.

getWhatsappOrder

public Order getWhatsappOrder()

If getMessageType() is MessageType.ORDER and getChannel() is Channel.WHATSAPP, returns the order.

Returns:

The deserialized WhatsApp order, or null if not applicable.

getWhatsappProfile

public Profile getWhatsappProfile()

If the getChannel() is Channel.WHATSAPP, returns information about the sender's WhatsApp profile.

Returns:

The deserialized WhatsApp profile, or null if not applicable.

getWhatsappContext

public Context getWhatsappContext()

If the getChannel() is Channel.WHATSAPP, returns the WhatsApp message context. This is only present where the user is quoting another message. It provides information about the quoted message and/or the product message being responded to.

Returns:

The deserialized WhatsApp context, or null if not applicable.

getWhatsappContextStatus

public ContextStatus getWhatsappContextStatus()

If the getChannel() is Channel.WHATSAPP, returns an enum indicating whether there is a context for this inbound message. If there is a context, and it is available, the context details will be contained in a context object. If there is a context, but it is unavailable,or if there is no context for message (ContextStatus.NONE), then there will be no context object included in the body.

Returns:

The deserialized WhatsApp context status, or null if not applicable.

Since:

8.1.0

getUsage

public MessageStatus.Usage getUsage()

If the getChannel() is Channel.SMS, returns the usage information (charged incurred for the message).

Returns:

The deserialized usage object, or null if not applicable.

getSmsMetadata

public SmsInboundMetadata getSmsMetadata()

If the getChannel() is Channel.SMS, returns additional information about the message.

Returns:

The SMS metadata, or null if not applicable.

getNetworkCode

public String getNetworkCode()

If the getChannel() is Channel.SMS or Channel.MMS, return the network code from which the message originated (if available).

Returns:

The origin network code if applicable, or null if unknown.

Since:

8.7.0

getWhatsappReferral

public Referral getWhatsappReferral()

If the 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.

Returns:

The Whatsapp referral object, or null if not present or applicable.

Since:

8.1.0

getContent

public List<Content> getContent()

If the getChannel() is Channel.MMS, returns a list of one or more objects representing image, audio, video, vCard, or file attachments. Only present for messages that have more than one attachment.

Returns:

The list of MMS attachments, or null if not applicable.

Since:

8.11.0

fromJson

public static InboundMessage fromJson(String json)

Constructs an instance of this class from a JSON payload. Known fields will be mapped, whilst unknown fields can be manually obtained through the getUnmappedProperties() method.

Parameters:

json - The webhook response JSON string.

Returns:

The deserialized webhook response object.

Throws:

VonageResponseParseException - If the response could not be deserialized.