Package com.vonage.client.sms

Enum Class MessageStatus

java.lang.Object

java.lang.Enum<MessageStatus>

com.vonage.client.sms.MessageStatus

All Implemented Interfaces:

Serializable, Comparable<MessageStatus>, java.lang.constant.Constable

public enum MessageStatus
extends Enum<MessageStatus>

Enum representing the error status of an SMS message. See the documentation for more details.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCOUNT_NOT_HTTP	This account is not provisioned for the SMS API.
COMMS_FAILURE	Deprecated.
FACILITY_NOT_ALLOWED	Deprecated.
INTERNAL_ERROR	An error has occurred in the platform whilst processing this message.
INVALID_CALLBACK	The callback URL supplied was either too long or contained illegal characters.
INVALID_CREDENTIALS	Your API key and/or secret are incorrect, invalid or disabled.
INVALID_FROM_ADDRESS	You are using a non-authorized sender ID in the from field.
INVALID_MESSAGE	The platform was unable to process this message, for example, an un-recognized number prefix.
INVALID_MESSAGE_CLASS	Deprecated.
INVALID_NETWORK_CODE	The network code supplied was either not recognized, or does not match the country of the destination address.
INVALID_PARAMS	The value of one or more parameters is invalid.
INVALID_SIGNATURE	The signature supplied could not be verified.
INVALID_TTL	Deprecated.
MESSAGE_TOO_LONG	The message length exceeds the maximum allowed.
MISSING_PARAMS	Your request is missing one of the required parameters from, to, api_key, api_secret or text.
NON_WHITELISTED_DESTINATION	Your Vonage account is still in demo mode.
NUMBER_BARRED	The number you are trying to send messages to is blacklisted and may not receive them.
NUMBER_DEACTIVATED	The number you are trying to send messages to is de-activated and may not receive them.
NUMBER_UNREACHABLE	Deprecated.
OK	A status of zero does not indicate that Vonage delivered your message.
PARTNER_ACCOUNT_BARRED	Your Vonage account has been suspended.
PARTNER_QUOTA_EXCEEDED	You do not have sufficient credit to send the message.
SIGNATURE_API_SECRET_DISALLOWED	A signed request may not also present an api_secret.
THROTTLED	You are sending SMS faster than the account limit.
TOO_MANY_BINDS	The number of simultaneous connections to the platform exceeds your account allocation.
TOO_MANY_DESTINATIONS	Deprecated.
UNKNOWN	Unknown status code.

Method Summary

Modifier and Type	Method	Description
static MessageStatus	fromInt(int messageStatus)	Look up the MessageStatus based on the int value.
int	getMessageStatus()
static MessageStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final MessageStatus OK

A status of zero does not indicate that Vonage delivered your message. Instead, this status indicates the absence of an error - i.e. the REST call succeeded.

THROTTLED

public static final MessageStatus THROTTLED

You are sending SMS faster than the account limit.

MISSING_PARAMS

public static final MessageStatus MISSING_PARAMS

Your request is missing one of the required parameters from, to, api_key, api_secret or text.

INVALID_PARAMS

public static final MessageStatus INVALID_PARAMS

The value of one or more parameters is invalid.

INVALID_CREDENTIALS

public static final MessageStatus INVALID_CREDENTIALS

Your API key and/or secret are incorrect, invalid or disabled.

INTERNAL_ERROR

public static final MessageStatus INTERNAL_ERROR

An error has occurred in the platform whilst processing this message.

INVALID_MESSAGE

public static final MessageStatus INVALID_MESSAGE

The platform was unable to process this message, for example, an un-recognized number prefix.

NUMBER_BARRED

public static final MessageStatus NUMBER_BARRED

The number you are trying to send messages to is blacklisted and may not receive them.

PARTNER_ACCOUNT_BARRED

public static final MessageStatus PARTNER_ACCOUNT_BARRED

Your Vonage account has been suspended.

PARTNER_QUOTA_EXCEEDED

public static final MessageStatus PARTNER_QUOTA_EXCEEDED

You do not have sufficient credit to send the message.

TOO_MANY_BINDS

public static final MessageStatus TOO_MANY_BINDS

The number of simultaneous connections to the platform exceeds your account allocation.

ACCOUNT_NOT_HTTP

public static final MessageStatus ACCOUNT_NOT_HTTP

This account is not provisioned for the SMS API.

MESSAGE_TOO_LONG

public static final MessageStatus MESSAGE_TOO_LONG

The message length exceeds the maximum allowed.

COMMS_FAILURE

@Deprecated
public static final MessageStatus COMMS_FAILURE

Deprecated.

No longer used.

INVALID_SIGNATURE

public static final MessageStatus INVALID_SIGNATURE

The signature supplied could not be verified.

INVALID_FROM_ADDRESS

public static final MessageStatus INVALID_FROM_ADDRESS

You are using a non-authorized sender ID in the from field.

INVALID_TTL

@Deprecated
public static final MessageStatus INVALID_TTL

Deprecated.

No longer used.

NUMBER_UNREACHABLE

@Deprecated
public static final MessageStatus NUMBER_UNREACHABLE

Deprecated.

No longer used.

TOO_MANY_DESTINATIONS

@Deprecated
public static final MessageStatus TOO_MANY_DESTINATIONS

Deprecated.

No longer used.

FACILITY_NOT_ALLOWED

@Deprecated
public static final MessageStatus FACILITY_NOT_ALLOWED

Deprecated.

No longer used.

INVALID_MESSAGE_CLASS

@Deprecated
public static final MessageStatus INVALID_MESSAGE_CLASS

Deprecated.

No longer used.

INVALID_NETWORK_CODE

public static final MessageStatus INVALID_NETWORK_CODE

The network code supplied was either not recognized, or does not match the country of the destination address.

INVALID_CALLBACK

public static final MessageStatus INVALID_CALLBACK

The callback URL supplied was either too long or contained illegal characters.

NON_WHITELISTED_DESTINATION

public static final MessageStatus NON_WHITELISTED_DESTINATION

Your Vonage account is still in demo mode. While in demo mode you must add target numbers to your whitelisted destination list.

SIGNATURE_API_SECRET_DISALLOWED

public static final MessageStatus SIGNATURE_API_SECRET_DISALLOWED

A signed request may not also present an api_secret.

NUMBER_DEACTIVATED

public static final MessageStatus NUMBER_DEACTIVATED

The number you are trying to send messages to is de-activated and may not receive them.

UNKNOWN

public static final MessageStatus UNKNOWN

Unknown status code.

Method Details

values

public static MessageStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MessageStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromInt

public static MessageStatus fromInt(int messageStatus)

Look up the MessageStatus based on the int value.

Parameters:

messageStatus - the int value of the message status.

Returns:

MessageStatus based on the int value given.

getMessageStatus

public int getMessageStatus()