Resource Status Codes

API Version: v4

Locate a Mobile User

Upon a successful request, i.e. HTTP Status Code 200 or 202, the following “one plus six digit” API specific status codes will be presented within the response schema. (example: E000000)

Response Example

JSON Response

{
    "aerialink":{
        "errorCode":"E200002",
        "detail":"Invalid Source Address Specified."
    }
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<aerialink>
<errorCode>EXXXXXX</errorCode>
<detail>Description of the error.</detail>
</aerialink>

Error Codes

Error CodeError NameError Description
E200001ForbiddenRequired parameters were not provided in the request
E200002Bad RequestInvalid source address specified
E300001Bad RequestParameters format is invalid
E400001Bad RequestThe value of one or more parameters exceeds the maximum allowed content length or type

Message Status

Status Codes

Status CodeStatus NameStatus DescriptionRequirements
10000PendingThe message has not yet been processed
20000Queued/ProcessingThe message has been queued and is in process
30000Sent/En-RouteThe message has been processed and has completed
40000AcceptedThe message was confirmed as accepted by the destination operatorRegistered Delivery Requested
40001DeliveredThe message was confirmed as delivered by the destination operatorRegistered Delivery Requested

Error Codes

Submit - Synchronous

The following error codes are provided for message status when Registered Delivery (Delivery Receipt) is “not” requested at the time of the submit or the delivery receipt has not yet been received or processed.

  • 50000 - Failed; the message has completed with a default error
  • 5XXXX - Failed; the message has completed with a specific error (see table below)

The following list includes both HTTP and SMPP protocol API specific errors, however some may or may not apply to your specific implementation.

Error CodeError NameError Description
50001ESME_RINVMSGLENMessage too long
50002ESME_RINVCMDLENCommand length is invalid
50003ESME_RINVCMDIDCommand ID is invalid or not supported
50004ESME_RINVBNDSTSIncorrect bind status for given command
50005ESME_RALYBNDAlready bound
50006ESME_RINVPRTFLGInvalid Priority Flag
50007ESME_RINVREGDLVFLGInvalid registered delivery flag
50008ESME_RSYSERRSystem error
50009Reserved
50010ESME_RINVSRCADRInvalid source address
50011ESME_RINVDSTADRInvalid destination address
50012ESME_RINVMSGIDMessage ID is invalid
50013ESME_RBINDFAILBind failed
50014ESME_RINVPASWDInvalid password
50015ESME_RINVSYSIDInvalid System ID
50016Reserved
50017ESME_RCANCELFAILCanceling message failed
50018Reserved
50019ESME_RREPLACEFAILMessage replacement failed
50020ESME_RMSSQFULMessage queue full
50021ESME_RINVSERTYPInvalid service type
50051ESME_RINVNUMDESTSInvalid number of destinations
50052ESME_RINVDLNAMEInvalid distribution list name
50064ESME_RINVDESTFLAGInvalid destination flag
50065Reserved
50066ESME_RINVSUBREPInvalid submit with replace request
50067ESME_RINVESMCLASSInvalid esm class set
50068ESME_RCNTSUBDLInvalid submit to distribution list
50069ESME_RSUBMITFAILSubmitting message has failed
50070Reserved
50071Reserved
50072ESME_RINVSRCTONInvalid source address type of number ( TON )
50073ESME_RINVSRCNPIInvalid source address numbering plan ( NPI )
50080ESME_RINVDSTTONInvalid destination address type of number ( TON )
50081ESME_RINVDSTNPIInvalid destination address numbering plan ( NPI )
50082Reserved
50083ESME_RINVSYSTYPInvalid system type
50084ESME_RINVREPFLAGInvalid replace_if_present flag
50085ESME_RINVNUMMSGSInvalid number of messages
50086Reserved
50087Reserved
50088ESME_RTHROTTLEDThrottling error
50089Reserved
50096Reserved
50097ESME_RINVSCHEDInvalid scheduled delivery time
50098ESME_RINVEXPIRYInvalid Validity Period value
50099ESME_RINVDFTMSGIDPredefined message not found
50100ESME_RX_T_APPNESME Receiver temporary error
50101ESME_RX_P_APPNESME Receiver permanent error
50102ESME_RX_R_APPNESME Receiver reject message error
50103ESME_RQUERYFAILMessage query request failed
50104 -50191Reserved
50192ESME_RINVTLVSTREAMError in the optional part of the PDU body
50193ESME_RTLVNOTALLWDTLV not allowed
50194ESME_RINVTLVLENInvalid parameter length
50195ESME_RMISSINGTLVExpected TLV missing
50196ESME_RINVTLVVALInvalid TLV value
50197 -50253Reserved
50254ESME_RDELIVERYFAILURETransaction delivery failure
50255ESME_RUNKNOWNERRUnknown error
50256ESME_RSERTYPUNAUTHESME not authorised to use specified servicetype
50257ESME_RPROHIBITEDESME prohibited from using specified operation
50258ESME_RSERTYPUNAVAILSpecified servicetype is unavailable
50259ESME_RSERTYPDENIEDSpecified servicetype is denied
50260ESME_RINVDCSInvalid data coding scheme
50261ESME_RINVSRCADDRSUBUNITInvalid source address subunit
50262ESME_RINVSTDADDRSUBUNIRInvalid destination address subunit
51024Operator-specific reserved

Delivery Receipt - Asyncronous

The following error codes are available when Registered Delivery (Delivery Receipt) is requested at the time of the submit and the delivery receipt has been received and processed.

  • 60000 - Failed; the message has completed with a default error
  • 6XXXX - Failed; the message has completed with a specific error (see table below)
Error CodeError NameError Description
60011UNDELIV/REJECTDMessage was marked as Undelivered or Rejected

Message State

The message state value represents the current state of a message. The values may include any of the following.

State NameState Description
ENROUTEMessage is in an enroute state
DELIVRDMessage is delivered to destination
EXPIREDMessage validity period has expired
DELETEDMessage has been deleted
ACCEPTDMessage is in accepted state
UNDELIVMessage is undeliverable
UNKNOWNMessage is in invalid state
REJECTDMessage is in a rejected state

Numbers Lookup

Upon a successful request, i.e. HTTP Status Code 200 or 202, the following “one plus six digit” API specific status codes will be presented within the response schema. (example: E000000)

Response Example

JSON Response

aerialink : {
errorCode: "EXXXXXX",
detail: "Invald Source Address Specified."
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<aerialink>
<errorCode>EXXXXXX</errorCode>
<detail>Description of the error.</detail>
</aerialink>

Error Codes

Error CodeError DepartmentError NameError Description
E200001Parameter ValidationForbiddenRequired parameters were not provided in the request
E300001Data FormatBad RequestNumbers parameter value format is invalid
E300002Data FormatBad RequestCache parameter value format is invalid
E300003Data FormatBad RequestCallbackURL is not a valid HTTP url
E400001ContentBad RequestThe value of one or more parameters exceeds the maximum allowed content length or type

Send and Receive SMS

Upon a successful request, i.e. HTTP Status Code 200 or 202, the following “one plus six digit” API specific status codes will be presented within the response schema. (example: E000000)

Response Example

JSON Response

aerialink : {
errorCode: "EXXXXXX",
detail: "Invald Source Address Specified."
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<aerialink>
<errorCode>EXXXXXX</errorCode>
<detail>Description of the error.</detail>
</aerialink>

Error Codes

Error CodeError DepartmentError NameError Description
E200001Parameter ValidationForbiddenRequired parameters were not provided in the request
E300001Data FormatBad RequestParameter value format is invalid
E400001ContentBad RequestThe value of one or more parameters exceeds the maximum allowed content length or type

This page was last updated 1515185923000