SmsSubmissionResult (Nexmo Java SDK)

java.lang.Object
- com.nexmo.client.sms.SmsSubmissionResult

All Implemented Interfaces:

java.io.Serializable
```
public class SmsSubmissionResult
extends java.lang.Object
implements java.io.Serializable
```
Represents the result of the submission of a single sms message, or a single part of a long / multi-part message

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATUS_ACCOUNT_NOT_HTTP` Message was rejected because your account is not provisioned for submitting via the REST interface.
`static int`	`STATUS_COMMS_FAILURE` Message was not submitted because there was a communications failure.
`static int`	`STATUS_FACILITY_NOT_ALLOWED` Your request makes use of a facility that is not enabled on your account
`static int`	`STATUS_INTERNAL_ERROR` Message was rejected due to a failure within the Nexmo systems. Message can be re-submitted after a short delay
`static int`	`STATUS_INVALID_CREDENTIALS` Message was rejected due to receiving invalid account api key and/or secret
`static int`	`STATUS_INVALID_FROM_ADDRESS` The 'from' address specified in the message submission was not permitted
`static int`	`STATUS_INVALID_MESSAFE_CLASS` The message class value supplied was out of range (0 - 3)
`static int`	`STATUS_INVALID_MESSAGE` Message was rejected because the Nexmo service was unable to handle this request.
`static int`	`STATUS_INVALID_PARAMS` Message was rejected due to an illegal value in one or more elements of the submission request
`static int`	`STATUS_INVALID_SIGNATURE` Message was not submitted due to a verification failure in the submitted signature
`static int`	`STATUS_INVALID_TTL` invalid TTL -- The ttl parameter values, or combination of parameters is invalid
`static int`	`STATUS_MESSAGE_TOO_LONG` Message was rejected because it exceeds the allowable maximum length (140 octets for a binary message, or 3200 chars for a text message)
`static int`	`STATUS_MISSING_PARAMS` Message was rejected due to incomplete data in the submission request
`static int`	`STATUS_NUMBER_BARRED` Message was rejected because the phone number you tried to submit to has been blacklisted.
`static int`	`STATUS_NUMBER_UNREACHABKE` This destination cannot be delivered to at this time (if reachable=true is specified)
`static int`	`STATUS_OK` Message was successfully submitted to the Nexmo service
`static int`	`STATUS_PARTNER_ACCOUNT_BARRED` Message was rejected because your account has been barred, or has not yet been activated
`static int`	`STATUS_PARTNER_QUOTA_EXCEEDED` Message was rejected because your pre-paid balance does not contain enough credit to handle this request. Please top up your balance before re-submitting this request or subsequent requests.
`static int`	`STATUS_THROTTLED` Message was rejected due to exceeding the maximum throughput allowed for this account. Message can be re-submitted after a short delay
`static int`	`STATUS_TOO_MANY_BINDS` Message was rejected because already have the maximum number of concurrent connections allowed for your account.
`static int`	`STATUS_TOO_MANY_DESTINATIONS` There are more than the maximum allowed number of destinations in this request

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SmsSubmissionResult(int status, java.lang.String destination, java.lang.String messageId, java.lang.String errorText, java.lang.String clientReference, java.math.BigDecimal remainingBalance, java.math.BigDecimal messagePrice, boolean temporaryError, SmsSubmissionReachabilityStatus smsSubmissionReachabilityStatus, java.lang.String network)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getClientReference()`
`java.lang.String`	`getDestination()`
`java.lang.String`	`getErrorText()`
`java.lang.String`	`getMessageId()`
`java.math.BigDecimal`	`getMessagePrice()`
`java.lang.String`	`getNetwork()`
`java.math.BigDecimal`	`getRemainingBalance()`
`SmsSubmissionReachabilityStatus`	`getSmsSubmissionReachabilityStatus()`
`int`	`getStatus()`
`boolean`	`getTemporaryError()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATUS_OK
```
public static final int STATUS_OK
```
    Message was successfully submitted to the Nexmo service
    
    See Also:
    
    Constant Field Values
  - STATUS_THROTTLED
```
public static final int STATUS_THROTTLED
```
    Message was rejected due to exceeding the maximum throughput allowed for this account.
    Message can be re-submitted after a short delay
    
    See Also:
    
    Constant Field Values
  - STATUS_MISSING_PARAMS
```
public static final int STATUS_MISSING_PARAMS
```
    Message was rejected due to incomplete data in the submission request
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_PARAMS
```
public static final int STATUS_INVALID_PARAMS
```
    Message was rejected due to an illegal value in one or more elements of the submission request
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_CREDENTIALS
```
public static final int STATUS_INVALID_CREDENTIALS
```
    Message was rejected due to receiving invalid account api key and/or secret
    
    See Also:
    
    Constant Field Values
  - STATUS_INTERNAL_ERROR
```
public static final int STATUS_INTERNAL_ERROR
```
    Message was rejected due to a failure within the Nexmo systems.
    Message can be re-submitted after a short delay
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_MESSAGE
```
public static final int STATUS_INVALID_MESSAGE
```
    Message was rejected because the Nexmo service was unable to handle this request. eg, the destination was un-routable.
    
    See Also:
    
    Constant Field Values
  - STATUS_NUMBER_BARRED
```
public static final int STATUS_NUMBER_BARRED
```
    Message was rejected because the phone number you tried to submit to has been blacklisted.
    
    See Also:
    
    Constant Field Values
  - STATUS_PARTNER_ACCOUNT_BARRED
```
public static final int STATUS_PARTNER_ACCOUNT_BARRED
```
    Message was rejected because your account has been barred, or has not yet been activated
    
    See Also:
    
    Constant Field Values
  - STATUS_PARTNER_QUOTA_EXCEEDED
```
public static final int STATUS_PARTNER_QUOTA_EXCEEDED
```
    Message was rejected because your pre-paid balance does not contain enough credit to handle this request.
    Please top up your balance before re-submitting this request or subsequent requests.
    
    See Also:
    
    Constant Field Values
  - STATUS_TOO_MANY_BINDS
```
public static final int STATUS_TOO_MANY_BINDS
```
    Message was rejected because already have the maximum number of concurrent connections allowed for your account.
    
    See Also:
    
    Constant Field Values
  - STATUS_ACCOUNT_NOT_HTTP
```
public static final int STATUS_ACCOUNT_NOT_HTTP
```
    Message was rejected because your account is not provisioned for submitting via the REST interface.
    
    See Also:
    
    Constant Field Values
  - STATUS_MESSAGE_TOO_LONG
```
public static final int STATUS_MESSAGE_TOO_LONG
```
    Message was rejected because it exceeds the allowable maximum length (140 octets for a binary message, or 3200 chars for a text message)
    
    See Also:
    
    Constant Field Values
  - STATUS_COMMS_FAILURE
```
public static final int STATUS_COMMS_FAILURE
```
    Message was not submitted because there was a communications failure.
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_SIGNATURE
```
public static final int STATUS_INVALID_SIGNATURE
```
    Message was not submitted due to a verification failure in the submitted signature
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_FROM_ADDRESS
```
public static final int STATUS_INVALID_FROM_ADDRESS
```
    The 'from' address specified in the message submission was not permitted
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_TTL
```
public static final int STATUS_INVALID_TTL
```
    invalid TTL -- The ttl parameter values, or combination of parameters is invalid
    
    See Also:
    
    Constant Field Values
  - STATUS_NUMBER_UNREACHABKE
```
public static final int STATUS_NUMBER_UNREACHABKE
```
    This destination cannot be delivered to at this time (if reachable=true is specified)
    
    See Also:
    
    Constant Field Values
  - STATUS_TOO_MANY_DESTINATIONS
```
public static final int STATUS_TOO_MANY_DESTINATIONS
```
    There are more than the maximum allowed number of destinations in this request
    
    See Also:
    
    Constant Field Values
  - STATUS_FACILITY_NOT_ALLOWED
```
public static final int STATUS_FACILITY_NOT_ALLOWED
```
    Your request makes use of a facility that is not enabled on your account
    
    See Also:
    
    Constant Field Values
  - STATUS_INVALID_MESSAFE_CLASS
```
public static final int STATUS_INVALID_MESSAFE_CLASS
```
    The message class value supplied was out of range (0 - 3)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SmsSubmissionResult
```
protected SmsSubmissionResult(int status,
                              java.lang.String destination,
                              java.lang.String messageId,
                              java.lang.String errorText,
                              java.lang.String clientReference,
                              java.math.BigDecimal remainingBalance,
                              java.math.BigDecimal messagePrice,
                              boolean temporaryError,
                              SmsSubmissionReachabilityStatus smsSubmissionReachabilityStatus,
                              java.lang.String network)
```
- Method Detail
  - getStatus
```
public int getStatus()
```
    Returns:
    
    int status code representing either the success of the message submission or a reason for failure
  - getDestination
```
public java.lang.String getDestination()
```
    Returns:
    
    String the destination phone number that the message was submitted to
  - getMessageId
```
public java.lang.String getMessageId()
```
    Returns:
    
    String a unique identifier associated with the submitted message. This value will be returned in any subsequent delivery notifications in order that they may be correlated with the appropriate message submission request.
  - getErrorText
```
public java.lang.String getErrorText()
```
    Returns:
    
    String a human readable error message giving further description of the value of {see #getStatus()}
  - getClientReference
```
public java.lang.String getClientReference()
```
    Returns:
    
    String the client-reference that was supplied as part of the original message submission
  - getRemainingBalance
```
public java.math.BigDecimal getRemainingBalance()
```
    Returns:
    
    BigDecimal The account balance that remains after the submission of this message.
  - getMessagePrice
```
public java.math.BigDecimal getMessagePrice()
```
    Returns:
    
    BigDecimal The amount that was debited from your account balance upon submission of this message
  - getTemporaryError
```
public boolean getTemporaryError()
```
    Returns:
    
    boolean Indicates if the failure was due to a temporary condition. If so, then the message submission may be re-attempted after a short delay
  - getSmsSubmissionReachabilityStatus
```
public SmsSubmissionReachabilityStatus getSmsSubmissionReachabilityStatus()
```
    Returns:
    
    SmsSubmissionReachabilityStatus the result of any reachability check that was performed on this message if one was requested
  - getNetwork
```
public java.lang.String getNetwork()
```
    Returns:
    
    String the 'estimated' network that has been identified for this destination (Note, this can change during the processing of this message due to HLR lookups)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SmsSubmissionResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_OK

STATUS_THROTTLED

STATUS_MISSING_PARAMS

STATUS_INVALID_PARAMS

STATUS_INVALID_CREDENTIALS

STATUS_INTERNAL_ERROR

STATUS_INVALID_MESSAGE

STATUS_NUMBER_BARRED

STATUS_PARTNER_ACCOUNT_BARRED

STATUS_PARTNER_QUOTA_EXCEEDED

STATUS_TOO_MANY_BINDS

STATUS_ACCOUNT_NOT_HTTP

STATUS_MESSAGE_TOO_LONG

STATUS_COMMS_FAILURE

STATUS_INVALID_SIGNATURE

STATUS_INVALID_FROM_ADDRESS

STATUS_INVALID_TTL

STATUS_NUMBER_UNREACHABKE

STATUS_TOO_MANY_DESTINATIONS

STATUS_FACILITY_NOT_ALLOWED

STATUS_INVALID_MESSAFE_CLASS

Constructor Detail

SmsSubmissionResult

Method Detail

getStatus

getDestination

getMessageId

getErrorText

getClientReference

getRemainingBalance

getMessagePrice

getTemporaryError

getSmsSubmissionReachabilityStatus

getNetwork

toString