Web Service - Methods - GetSubscribers

GetSubscribers

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

This method is used to retrieve the phone numbers of subscribers to your specified long inbound number or short code number service.

The number parameter should be set to either a long inbound number (formatted in full international format) or a short code number (configured in local format).

If the service is hosted on a number (long or short) without the use of a keyword, then the keyword parameter should be left blank.

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, the phone numbers of the subscribers to the specified service are returned.

Return Data

Shortcode

XML:

<GetSubscribersResponse> 
    <Transaction> 
        <Code>1</Code> 
        <Description>Transaction  OK</Description> 
    </Transaction> 
    <Subscribers> 
        <Subscriber> 
            <Originator>+447980123456</Originator> 
            <Destination>+447980123456</Destination> 
            <Keyword  /> 
            <Date>2009-06-03</Date> 
            <Time>13:15:17</Time> 
            <Body>hello  world  </Body> 
            <Network>Orange</Network> 
            <RBID>843822651</RBID> 
        </Subscriber> 
        <Subscriber> 
            <Originator>+447980123456</Originator> 
            <Destination>+447980123456</Destination> 
            <Keyword  /> 
            <Date>2009-06-03</Date> 
            <Time>15:17:13</Time> 
            <Body>helloworld</Body> 
            <Network>Orange</Network> 
            <RBID>843822652</RBID> 
        </Subscriber> 
        <Subscriber> 
            <Originator>+447980123456</Originator> 
            <Destination>+447980123456</Destination> 
            <Keyword  /> 
            <Date>2009-06-03</Date> 
            <Time>17:13:15</Time> 
            <Body>hello,world</Body> 
            <Network>Orange</Network> 
            <RBID>843822653</RBID> 
        </Subscriber> 
    </Subscribers> 
</GetSubscribersResponse>
        

CSV:

"+447980123456","+447980123456","","2009-06-03","13:15:17","hello world","Orange","843822651" "+447980123456","+447980123456","","2009-06-03","15:17:13","helloworld","Orange","843822652" "+447980123456","+447980123456","","2009-06-03","17:13:15","hello,world","Orange","843822653"

Long Number

XML:

<GetSubscribersResponse> 
    <Transaction> 
        <Code>1</Code> 
        <Description>Transaction  OK</Description> 
    </Transaction> 
    <Subscribers> 
        <Subscriber> 
            <Originator>+447980123456</Originator> 
            <Destination>+447980123456</Destination> 
            <Keyword  /> 
            <Date>2009-06-03</Date> 
            <Time>13:15:17</Time> 
            <Body>hello  world  </Body> 
            <Network>Orange</Network> 
        </Subscriber> 
        <Subscriber> 
            <Originator>+447980123456</Originator> 
            <Destination>+447980123456</Destination> 
            <Keyword  /> 
            <Date>2009-06-03</Date> 
            <Time>15:17:13</Time> 
            <Body>helloworld</Body> 
            <Network>Orange</Network> 
        </Subscriber> 
        <Subscriber> 
            <Originator>+447980123456</Originator> 
            <Destination>+447980123456</Destination> 
            <Keyword  /> 
            <Date>2009-06-03</Date> 
            <Time>17:13:15</Time> 
            <Body>hello,world</Body> 
            <Network>Orange</Network> 
        </Subscriber> 
    </Subscribers> 
</GetSubscribersResponse>
        

CSV:

#1# "+447980123456","+447980123456","","2009-06-03","13:15:17","hello world","Orange" "+447980123456","+447980123456","","2009-06-03","15:17:13","helloworld","Orange" "+447980123456","+447980123456","","2009-06-03","17:13:15","hello,world","Orange"

Footer Bottom