- Messenger

Receiving Status via Polling

Clients can GET incoming receipts (status updates) from https://www.bulletinmessenger.net/api/1/sms/status

Clients can be advised of incoming receipts (status updates) via HTTPS GET or POST (recommended) calls https://www.bulletinmessenger.net/api/1/sms/status

Simple API Example

Here’s a simple GET example:

https://www.bulletinmessenger.net/api/1/sms/status?userId=yourId&password=yourPassword

Don’t forget to use your login and password

There are just two URL encoded parameters for polling messages:

Name	Description	Required?
userId	User name for authentication (same as used for logging into the website). User name and password may be passed as form encoded parameters, or in the HTTP Authorization header in Basic format.	YES
password	Your account password	YES

Messenger will respond to each and every HTTP request with one of the following result codes:

Code	Meaning	Action Required
200	OK (normal result)	Parse the results for the incoming message details as described below.
204	No content (no messages)	No incoming messages. Pause processing and retry after 30 seconds.
401	Unauthorized	Check `userId` and `password`.
500	Internal Error	Contact Bulletin

Polling Delays

Please note that polling will wait for 30 seconds if there are no unread messages in the hope a new message arrives during that period. This is expected behaviour

Polling will only transmit unread messages within the Messenger platform and mark them as read once transmitted. Remember this when testing.

For 200 codes (success) Messenger will include a form encoded parameter list containing some or all of message information as described below.

Note: The order of the parameters may change so use value/pair matching rather than location mapping.

List Item	Description	Notes
messageId	A unique identifier for the message	Messenger Unique ID. Check this ID to ensure you have not already processed this status update.
to	A MSISDN or Short Code from our threading range
from	Destination MSISDN of message	The recipient number of an outbound message sent by you in International format.
statusCode	Message status	See Message Status Codes for simple descriptions of Codes used.
inReplyToId	Correlation ID of the message	Matches the `messageId` returned to you in the response to /api/3/sms/out. If no `messageId` was set when you submitted the original message then this will contain 'default'. Not valid with Virtual Numbers or Short Codes.
error	Descriptive text	More, readable information about the Message Status