Skip to content

Mailbox API

Philipp Zeppezauer edited this page Nov 19, 2014 · 1 revision

Mailbox API /

REST API

GET `/{id}` Pull a message from the mailbox for a specific peer id (note that this call removes the message).
GET `/poll/{id}` Long polling version of the previous call. The call will be kept open for at maximum 30 seconds.
GET `/all/{id}` Get all message from the mailbox for a specific peer id

GET /{id}

Pull a message from the mailbox for a specific peer id (note that this call removes the message).

Parameter:
id required - defines the id of the peer

Respond:
200 message pulled (in body)
204 there is no message for this peer

GET /poll/{id}

Long polling version of the previous call. The call will be kept open for at maximum 30 seconds.

Parameter:
id required - defines the id of the peer

Respond:
200 message pulled (in body)
204 there is no message for this peer
408 request timed out

GET /all

Get all message from the mailbox for a specific peer id

Respond:
200 messages successfully pulled (in body)