Package com.vonage.client.messages

Class MessageStatus

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.messages.MessageStatus

All Implemented Interfaces:

Jsonable

public class MessageStatus
extends JsonableBaseObject

This class represents the data of a callback which is invoked after a message has been sent. It provides metadata about the message, such as its status, how much it cost, when it was sent, what service (channel) it was sent via, sender and recipient, message response ID, client reference etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MessageStatus.Error	Describes the error that was encountered when sending the message.
static enum	MessageStatus.Status
static final class	MessageStatus.Usage	Describes the charge incurred for sending the message.

Field Summary

Fields

Modifier and Type	Field	Description
protected Channel	channel
protected String	clientRef
protected MessageStatus.Error	error
protected String	from
protected UUID	messageUuid
protected MessageStatus.Status	status
protected Instant	timestamp
protected String	to
protected Map<String,Object>	unknownProperties
protected MessageStatus.Usage	usage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageStatus()

Method Summary

Modifier and Type	Method	Description
static MessageStatus	fromJson(String json)	Creates an instance of this class from a JSON payload.
Map<String,?>	getAdditionalProperties()	Catch-all for properties which are not mapped by this class during deserialization.
Channel	getChannel()	The service used to send the message.
String	getClientRef()	Client reference of up to 40 characters.
String	getDestinationNetworkCode()	If getChannel() is Channel.SMS or Channel.MMS, returns the network code for the destination.
MessageStatus.Error	getError()	If the message encountered a problem a descriptive error will be supplied in this object.
String	getFrom()	The 'from' number used in the outbound MessageRequest.
UUID	getMessageUuid()	Unique identifier of the message that was sent, as returned in MessageResponse.getMessageUuid().
Integer	getSmsTotalCount()	getChannel() is Channel.SMS, returns the number of SMS messages concatenated together to comprise the submitted message.
MessageStatus.Status	getStatus()	The status of the message.
Instant	getTimestamp()	The datetime of when the event occurred.
String	getTo()	The 'to' number used in the outbound MessageRequest.
MessageStatus.Usage	getUsage()	Describes the cost of the message that was sent.
String	getWhatsappConversationId()	If the getChannel() is Channel.WHATSAPP and getStatus() is MessageStatus.Status.DELIVERED, returns the conversation ID of the message that triggered this callback.
ConversationType	getWhatsappConversationType()	If the getChannel() is Channel.WHATSAPP and getStatus() is MessageStatus.Status.DELIVERED, returns the conversation's origin type.

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

messageUuid

protected UUID messageUuid

to

protected String to

from

protected String from

status

protected MessageStatus.Status status

channel

protected Channel channel

clientRef

protected String clientRef

error

protected MessageStatus.Error error

usage

protected MessageStatus.Usage usage

Constructor Details

MessageStatus

protected MessageStatus()

Method Details

getMessageUuid

public UUID getMessageUuid()

Unique identifier of the message that was sent, as returned in MessageResponse.getMessageUuid().

Returns:

The UUID of the message.

getTo

public String getTo()

The 'to' number used in the outbound MessageRequest.

Returns:

The recipient number or ID.

getFrom

public String getFrom()

The 'from' number used in the outbound MessageRequest.

Returns:

The sender number or ID.

getTimestamp

public Instant getTimestamp()

The datetime of when the event occurred.

Returns:

The timestamp as an Instant.

getStatus

public MessageStatus.Status getStatus()

The status of the message.

Returns:

The message status as an enum.

getChannel

public Channel getChannel()

The service used to send the message.

Returns:

The channel, as an enum.

getClientRef

public String getClientRef()

Client reference of up to 40 characters. The reference will be present if set in the original outbound MessageRequest.

Returns:

The client reference, or null if unset.

getError

public MessageStatus.Error getError()

If the message encountered a problem a descriptive error will be supplied in this object.

Returns:

The error object, or null if there was no problem to report.

getUsage

public MessageStatus.Usage getUsage()

Describes the cost of the message that was sent.

Returns:

The usage object, or null if absent.

getDestinationNetworkCode

public String getDestinationNetworkCode()

If getChannel() is Channel.SMS or Channel.MMS, returns the network code for the destination.

Returns:

The mobile network code as a string, or null if not applicable.

Since:

8.1.0

getSmsTotalCount

public Integer getSmsTotalCount()

getChannel() is Channel.SMS, returns the number of SMS messages concatenated together to comprise the submitted message. SMS messages are 160 characters, if a submitted message exceeds that size it is sent as multiple SMS messages. This number indicates how many SMS messages are required.

Returns:

The number of SMS messages used for this message, or null if not applicable.

Since:

8.1.0

getWhatsappConversationType

public ConversationType getWhatsappConversationType()

If the getChannel() is Channel.WHATSAPP and getStatus() is MessageStatus.Status.DELIVERED, returns the conversation's origin type.

Returns:

The WhatsApp conversation category as an enum, null if absent or not applicable.

Since:

8.1.0

getWhatsappConversationId

public String getWhatsappConversationId()

If the getChannel() is Channel.WHATSAPP and getStatus() is MessageStatus.Status.DELIVERED, returns the conversation ID of the message that triggered this callback.

Returns:

The WhatsApp conversation ID, null if absent or not applicable.

Since:

8.1.0

getAdditionalProperties

public Map<String,?> getAdditionalProperties()

Catch-all for properties which are not mapped by this class during deserialization.

Returns:

Additional (unknown) properties as a Map, or null if absent.

fromJson

public static MessageStatus fromJson(String json)

Creates an instance of this class from a JSON payload.

Parameters:

json - The JSON string to parse.

Returns:

An instance of this class with the fields populated, if present.