Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Retrieves a specific push communication message for an account.

 

 

Endpoint ID:7002
Method:GET
URL:

/communication/push/dp-key/{dp-key}/{message-id}

/communication/push/ext-key/{ext-key}/{ext-type}/{message-id}

 

 dp-key

dialogportal™ master key 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-idID of the message to retrieve
Request body:

None 

Response body:

JSON data containing the push communication details, and the base64 encoded message.

Example – Push communication message with title, link and type
{
    "messageID": 23930553,
    "creationDate": "2014-01-08T17:17:04",
    "title": "R3JlYXQgbmV3cyBEYXZlIQ==",
    "message": "DQo8aHRtbD48aGVhZD48L2hlYWQ+PGJvZHk+PC9ib2R5PjwvaHRtbD4=",
    "link": "http://www.google.com?id=123456789",
    "type": "BreakingNews"
}

The possible response body fields are:

messageIDID of the message that was retrieved
creationDateThe date and time that the message was created
titleA base64 encoded title for the message
messageThe base64 encoded message. The decoded message can be plain text or html, depending on the message design.
linkA URL. This may be an external internet address, or an internal link to be used within an app. *
typeThe message type - either "Standard" or "BreakingNews". *

* 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:

404.1User not found
404.2External user could not be found
404.4This message could not be found
  • No labels