...
Excerpt |
---|
Retrieves a specific push communication message for an account. |
Endpoint ID: | 7002 | |||||||
Method: |
| |||||||
URL: | /communication/push/ |
entity/id/{ |
entity- |
id}/{message-id}?markAsRead=false /communication/push/entity/ext-key/{ext-key}/{ext-type}/{message-id} |
?markAsRead=true | ||
entity-id | Rubiq entity ID that uniquely identifies the account to retrieve the message for |
ext-key | External key that uniquely identifies the account to retrieve the message for |
ext-type | Type of external key |
message-id | ID of the message to retrieve | |
markAsRead | Optional: boolean to set the read status of the message. Default is true. | |
Request body: | None |
style | white-space:pre |
---|
Response body: | JSON data containing the push communication details, and the base64 encoded message.
|
|
|
The possible response body fields are:
* Use of the "link" and "type" properties should be decided between the app developer and the content producer | ||||||||||||||||||
Status codes: | 200 | Message retrieved successfully |
404 |
Message was not found The following sub codes may be returned:
|