Get Message Center Messages
Use this interface to retrieve message center messages for the specified app and user.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/v1.3/messageCenter/apps/{appId}/users/{userId}/messages?inboxName={exampleInbox}&modifiedSince={dateTime}
Required Path Parameters:
appId – The Responsys App ID for the app. Also known as “RI App ID”. You can locate your App ID in your Responsys account in two locations: by navigating to the Mobile App Console or navigating to Account > Manage Mobile App Configurations. Must be an integer.
userId – Unique identifier of the user for which you want to retrieve messages.
Optional Path Parameters:
inboxName – Name of the Message Center to retrieve messages from. If not provided, the Primary Message Center will be used.
modifiedSince – The date and time of the last successful message retrieval. Expressed as an ISO 8601 timestamp.
Request Method:
GET
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Example:
GET /rest/api/v1.3/messageCenter/apps/1/users/api.user@oracle.com/messages?inboxName=inbox1&modifiedSince=2019-01-08T10:07:29Z
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
{
"next_req_time": "2019-02-05T07:48:29Z",
"messages": [
{
"subject": "inbox- So",
"message": "Responsys universal link",
"id": "ABEoKJcNg50lQO2ofvaWHSCQ-B1n2s5hfBN_1olgKrbtoyKJp25Ybmm-kKdUo",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-02-04T10:06:00Z",
"message_center_name": "inbox1",
"form_link": "https://api.pushio.com/v2/null/cl/ABEmrRKC0JnnFqR7hQlS-wGuE?messageId=ABEoKJcNg50lQO2ofvaWHSCQ-B1n2s5hfBN_1olgKrbtoyKJp25Ybmm-kKdUo",
"expiry_datetime": "2019-02-11T10:06:00Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "2024-04-25T19:12:00Z",
"richmessage_html": ""
},
{
"subject": "inbox- So",
"message": "Responsys universal link",
"id": "ABEmfugnqh4x8KV0WBZoDaA0vcFYcZiMnH9GiX9Phm7_5Sf1pRqGcjefBjPOY",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-02-04T10:04:19Z",
"message_center_name": "Primary",
"form_link": "https://api.pushio.com/v2/null/cl/ABEmrRKC0JnnFqR7hQlS-wGuE?messageId=ABEmfugnqh4x8KV0WBZoDaA0vcFYcZiMnH9GiX9Phm7_5Sf1pRqGcjefBjPOY",
"expiry_datetime": "2019-02-11T10:04:19Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "2024-04-25T19:12:00Z",
"richmessage_html": ""
},
{
"subject": "inbox- So",
"message": "Responsys universal link",
"id": "ABEmk2NMpqU9s1wrITi579HsQAChmM6AoqxssSEE7RAE303LP6jALRolFN9xE",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-02-04T10:02:41Z",
"message_center_name": "inbox1",
"form_link": "https://api.pushio.com/v2/null/cl/ABEmrRKC0JnnFqR7hQlS-wGuE?messageId=ABEmk2NMpqU9s1wrITi579HsQAChmM6AoqxssSEE7RAE303LP6jALRolFN9xE",
"expiry_datetime": "2019-02-11T10:02:41Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "2024-04-25T19:12:00Z",
"richmessage_html": ""
},
{
"subject": "inbox- So",
"message": "Responsys universal link",
"id": "ABEjoVKAqz6_faSk8CBeCAJQ_lRk5RQQV02KZ5nvfp5oNc1cYRb4oq-wC61IM",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-02-04T10:01:29Z",
"message_center_name": "inbox1",
"form_link": "https://api.pushio.com/v2/null/cl/ABEmrRKC0JnnFqR7hQlS-wGuE?messageId=ABEjoVKAqz6_faSk8CBeCAJQ_lRk5RQQV02KZ5nvfp5oNc1cYRb4oq-wC61IM",
"expiry_datetime": "2019-02-11T10:01:29Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "2024-04-25T19:12:00Z",
"richmessage_html": ""
},
{
"subject": "this message is for deviceID 4",
"message": "testing device ID inbox messages",
"id": "ABEvNrlJZ6YnLSjvj2SZw6JvXo6We1qtDnINW65NAz5KtL0UpgiRxXliuugyI",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-02-01T06:13:57Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-08T06:13:57Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "Inbox",
"message": "test test",
"id": "ABEskoDz4To0NZGhphOTNQo8phJrYRPmFOgSZRdTWCtRNLUnt9jALlOHVpQchb",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-31T09:15:52Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-07T09:15:52Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "Inbox",
"message": "test test",
"id": "ABEt8wwuOM7MOcMtwlTvKopsNDlONBZJ_3nqMDi1VKBbm5KFZmectO7EEl0kqC",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-31T09:08:32Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-07T09:08:32Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "6.40 User Message 2",
"message": "Regression test : user messages",
"id": "ABEvOYnZRg8AvFsKGy-P2aiPFpkax6RXhFjy1HkOQ6yZ4db0B2p9yUD6neKQ4",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-30T02:14:00Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-06T02:14:00Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "6.40 User Message 2",
"message": "Regression test : user messages",
"id": "ABEtGIR7LpbRrU3deYJdcrEGZjeEx9Vy139BHdyXQZiz13cAbvLTc5Fp0zFTU",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-28T06:58:26Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-04T06:58:26Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "6.40 User Message 2",
"message": "Regression test : user messages",
"id": "ABEoK9xK5_Y6Em3PuGDBAFtN7g_4fTklJAwKmwLD41hWyr9EZM9Orob42GTpY",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-28T06:54:59Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-04T06:54:59Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "User ID Message",
"message": "User ID Messages",
"id": "ABEnJisXQ-Naj1Sr_DDzgNcOJya3tVQDOdP8bjmqcWQrW093vArOdJZUtIjiGP",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-28T06:42:16Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-04T06:42:16Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "User ID Message",
"message": "User ID Messages",
"id": "ABEq-4ltqz-CmNOw6uMd-3DNlwyA5brdu8p6ATAyGs-2ALVnZlIOXVwwpzdNE5",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-28T06:32:42Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-04T06:32:42Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "User ID Message",
"message": "User ID Messages",
"id": "ABEpB1CM0D5lmR2LWJ6miKoXPbRPaVS0HWxYm_KGWwD5oFq1Ohu3xN9GQZQ97S",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-28T06:30:10Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-04T06:30:10Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
},
{
"subject": "Device ID Message",
"message": "Device ID Messages",
"id": "ABEoZYHIKB6wf3qMi6Q8FrPkYwHq_OKAvd0hn8Zy1x9vKXXKNBojeLdGMpWDR8",
"icon_url": "",
"device_id": "D4EDFAFF-8DC4-4800-9BC8-3BFBB9696276",
"richmessage_url": "null",
"deeplink_url": "null",
"sent_ts": "2019-01-28T06:23:38Z",
"message_center_name": "inbox1",
"form_link": "",
"expiry_datetime": "2019-02-04T06:23:38Z",
"user_id": "api.user@oracle.com",
"expiry_ts": "",
"richmessage_html": ""
}
],
"links": [
{
"rel": "self",
"href": "/rest/api/v1.3/messageCenter/apps/1/users/api.user@oracle.com/messages ?inboxName=inbox1&modifiedSince=2019-01-08T10:07:29Z",
"method": "GET"
}
]
}
Sample Responses - Failure
400 Not Found
App ID is not a valid number: Requests fail if the App ID supplied is not a valid number. The error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "APP ID is not a valid number",
"errorDetails": []
}
Invalid modifiedSince date format: Requests fail if the modifiedSince date format is not an ISO 8601 timestamp:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "The modifiedSince Timestamp is invalid. Please provide the modifiedSince Timestamp as an ISO8601 Timestamp value. ",
"errorDetails": []
}
App ID does not exist: Requests fail if the App ID supplied in the request does not exist. The error resembles:
{
"type":"",
"title":"Message Center Exception",
"errorCode":"MESSAGE_CENTER_EXCEPTION",
"detail":"There is no such Application ID",
"errorDetails":[]
}
Inbox name does not exist: Requests will fail if the inboxName does not match a Message Center for the application provided. The error response will resemble the following:
{
"type":"",
"title":"Message Center Exception",
"errorCode":"MESSAGE_CENTER_EXCEPTION",
"detail":"There is no such named Message Center for this Application",
"errorDetails":[]
}
Error communicating with Push API: If there’s an error communicating with the Push API, the error response will resemble the following:
{
"type":"",
"title":"Message Center Exception",
"errorCode":"MESSAGE_CENTER_EXCEPTION",
"detail":"Could not fetch data",
"errorDetails":[]
}