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 |
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.