Web Service - Methods - GetSMSInbound

Developer Centre > Web Service > Methods > GetSMSInbound

GetSMSInbound

Please note that to use this method, you must have first set up your number to forward inbound messages to the Web Service.

This method is used to retrieve messages sent to a specified long inbound number. If keywords are used with the long number, then messages sent to a specific keyword on the long number can be retrieved.

If no keyword is given then all messages sent to the specified long inbound number are retrieved.

Please be aware that once you have requested and received your inbound text messages, those text messages will be deleted from the SMS Gateway and cannot be re-requested.

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.

» returnCSVString» Boolean
» externalLogin» String
» password» String
» number» String
» keyword» String

On successful completion of this method, any new text messages sent to the specified long inbound number are returned.

For each new message, the following fields are returned:

Originator the sender of the message
Destination long number to which the message was sent
Keyword keyword to which the message was sent
Date the date that the message was received, in yyyy-mm-dd format
Time the time that the message was received, in 24 hour format
Body the content of the message
Network the network that delivered the message (if known, otherwise empty)

Return Data

XML:


    <GetSMSInboundResponse> 
        <Transaction> 
            <Code>1</Code> 
            <Description>Transaction  OK</Description> 
        </Transaction> 
        <SMSInbounds> 
            <InboundSMS> 
                <ID>4</ID> 
                <Originator>+447980123456</Originator> 
                <Destination>+447781484145</Destination> 
                <Keyword  /> 
                <Date>2009-07-08</Date> 
                <Time>10:38:15</Time> 
                <Body>hello  "",""  world</Body> 
                <Network>Orange</Network> 
            </InboundSMS> 
            <InboundSMS> 
                <ID>5</ID> 
                <Originator>+447980123456</Originator> 
                <Destination>+447781484146</Destination> 
                <Keyword  /> 
                <Date>2009-07-08</Date> 
                <Time>10:38:55</Time> 
                <Body>hello world</Body> 
                <Network>Orange</Network> 
            </InboundSMS> 
        </SMSInbounds> 
    </GetSMSInboundResponse>

CSV:


    #1# "4","+447980123456","+447781484145","","2009-07-08","10:38:15","hello "","" world","Orange" 
    "5","+447980123456","+447781484146","","2009-07-08","10:38:55","hello world","Orange"