Address Book Feeds

Using a standard HTTP GET interface, Bulletin Messenger offers access to the online Address Books to allow you to request a list of your Address Books and the members of each of them so that they can be used in your application or software.

The details provided here are targeted at the application developer and it is assumes a knowledge of RSS and the HTTP web services.

Address Book Details

Feed URLs

Address Book Details can be retreived from the following URLs

Feed Parameters

Use HTTP GET to retrieve messages from http://www.bulletinmessenger.net/api/2/addressbook.
Recognised URL encoded parameters for retrieving messages are:

Name (case sensitive)	Valid Values	Description	Required?
userId	String	User name for authentication	YES
password	String	A SHA1 hash of your account and password details. Failure to provide this will result in an Authentication error even if you provide the password. See here for more information on generating the hash or login to http://bulletinmessenger.net and view your Messenger Settings for the correct string to use.	YES
format	atom rss	Default feed format is ATOM 1.0
id	Integer	Address Book ID for retreiving the members of a specified Address Book

Your application will parse the resulting XML feed and display your Address Books or the Members of an Address Book, if the id is defined.

Details of your account including account balance, type and currency is included in the feed results. This will allow you to monitor your account status and initiate a payment before your service is restricted.

Address Book Feed Examples

Bulletin Messenger allows you to get a list of your Address Books so that you can use them in your application and so you can drill down to extract contacts from each of them.
Since Bulletin Messenger only allows you to send to one contact/number/group with each transaction (for greater functionality, see Bulletin Connect) you can use your online address books to enable group messaging if required.

Example Results

If your HTTP request has the format=atom parameter, or if the format parameter is omitted then the results will be in ATOM format (). Also see

• RSS Format ()

Contacts Feed Examples

For each Address Book you can query the server to retreive the names of each of the entities to allow you to send messages to them.
These Address Books are maintained online and provide access to groups (Group names are always in UPPERCASE in the results, and contact names are always in lowercase) so you can send to multiple recipients with a single API call.
See the detailed API Feature Matrix for more information on the features that Bulletin Messenger and Bulletin Connect offer.

ATOM Example Results for the members of an Address Book

If your HTTP request has the format=atom parameter, or if the format parameter is omitted, and the id parameter specified then the results will be in ATOM format (). Other formats (RSS) are also available in the same manner as for the Address Book list request.