HTTP Service - Methods - GetPremiumSMSStatus

GetPremiumSMSStatus

This method is used to retrieve the delivery status of one or more messages previously sent using the SendPremiumSMS method.

The delivery status of the messages associated with the given clientMessageReference parameter will be returned.

You can choose to receive the return code data from this method as either a CSV string or XML through your setting of the returnCSVString parameter.

If a CSV string is requested, the first line will contain the Transaction code contained within the '#' characters.

The setting of the clientMessageReference parameter will have the same value as previously given when invoking the SendPremiumSMS method.

Each of the string parameters need to be URL Encoded.

» returnCSVString» Boolean
» externalLogin» String
» password» String
» clientMessageReference» String

On successful completion of this method, the destination number and an integer code (representing the number’s delivery status) are returned for each number submitted through the method.

Return Codes are grouped according to their status type, as follows:

400 - 499: Final delivery statuses, successful
500 - 599: Final delivery statuses, unsuccessful
600 - 699: Intermediate delivery statuses

Each Return Code is returned as an Integer.

  • » 400Delivered to handset
  • » 500Delivery failure - age verification
  • » 501Delivery failure - billing issue
  • » 502Delivery failure - error from operator
  • » 503Delivery failure - expiration time exceeded
  • » 504Delivery failure - invalid number
  • » 505Delivery failure - message content
  • » 506Delivery failure - message is spam
  • » 507Delivery failure - no credit on phone
  • » 508Delivery failure - parental content bar
  • » 509Delivery failure - problem with handset's operator
  • » 510Delivery failure - problem with phone
  • » 511Delivery failure - reason unknown
  • » 512Delivery failure - temporary problem locating handset
  • » 513Message rejected by network
  • » 514No delivery confirmation available
  • » 515Destination Opted-out
  • » 516Delivery failure - invalid originator
  • » 599Delivery failure - reason to be clarified
  • » 600Delivered to network
  • » 601Sending
  • » 602Sent to network
  • » 603Message in transit and being retried

Return Data

XML:

<GetPremiumSMSStatusResponse> 
    <Transaction> 
        <IP>127.0.0.1</IP> 
        <Code>1</Code> 
        <Description>Transaction  OK</Description> 
    </Transaction> 
    <Statuses> 
        <Status> 
            <CurrentPart>1</CurrentPart> 
            <TotalPart>1</TotalPart> 
            <Destination>+447980121234</Destination> 
            <StatusCode>400</StatusCode> 
            <StatusName>Delivered to handset</StatusName> 
            <StatusDescription  /> 
        </Status> 
        <Status> 
            <CurrentPart>1</CurrentPart> 
            <TotalPart>1</TotalPart> 
            <Destination>+4479801243216</Destination> 
            <StatusCode>603</StatusCode> 
            <StatusName>Message in transit and being retried</StatusName> 
            <StatusDescription  /> 
        </Status> 
    </Statuses> 
</GetPremiumSMSStatusResponse>        

CSV:

#1# +447980121234:400,+447980124321:603

Footer Bottom