get https://connect.routee.net/push-notifications/messages/
Retrieve the details of a Push Notification by trackingId.
RESPONSE PARAMETERS
| KEY | DESCRIPTION |
|---|---|
| trackingId | The tracking id of the Push Notification. |
| implementationId | There should be an implementation with the particular id that belongs to the accountId. Not Blank. |
| serviceMessageId | The message id that Firebase returns in the response of the Send Push Notification endpoint. |
| owner | Identifies the owner, i.e. account and application of the user who sent the Push Notification. |
| owner.accountId | Identifier of the account. |
| owner.applicationId | Identifier of the application. |
| statusInfo | Provides information about the final status of the Push Notification. |
| statusInfo.status | Available statuses are as follows: SENT: Push Notification was successfully sent; QUEUED: This is the initial status. This means that the process was started and this contains some extra operations like checking the balance, charging, and retrieving the credentials before sending the message to the Firebase; FAILED: Push Notification failed, i.e., the notification could not be accepted by Routee Platform or Firebase. If Firebase returns an error, the error message is reflected in the reason field. |
| statusInfo.date | Push Notification status date. |
| statusInfo.reason | Visible only for FAILED status. |
| price | The price that was set. |
| price.cost | The cost of the sent Push Notification. |
| price.currency | Currency name. |
| statuses | Array of all previous statuses that the Push Notification had before the final one. Note that the statusInfo object provides information about the final status. |
| statuses.status | Available statuses are as follows: SENT: Push Notification was successfully sent; QUEUED: This is the initial status. This means that the process was started and this contains some extra operations like checking the balance, charging, and retrieving the credentials before sending the message to the Firebase; FAILED: Push Notification failed, i.e., the notification could not be accepted by Routee Platform or Firebase. If Firebase returns an error, the error message is reflected in the reason field. |
| statuses.date | Push Notification status date. |
| deviceToken | Device token. It is used to identify a specific device. |
| deviceToken.type | Device token type: ANDROID, APPLE, WEB. |
| deviceToken.token | Not Blank. |
| body | The notification's body which contains the following fields: title, text, forceLocale. |
| body.title | The notification's title. Map: (Key) not blank, language - ISO 639-1; (Value) not blank. |
| body.text | The notification's text. Map: (Key) not blank, language - ISO 639-1; (Value) not blank. |
| body.forceLocale | Localization settings. Switches body.title and body.text to the selected language; body.title and body.text should contain an entry with forceLocale as their key. Not null, language - ISO 639-1. |
| imageUrl | URL that should begin with https:// |
| config | Device-specific parameters. |
| config.type | Device type: apn, android, web. |
| config.localizedTitle | The key to the title string in the app's string resources to use to localize the title text to the user's current localization. Example: NOTIFICATION_TITLE |
| config.localizedText | The key to the body string in the app's string resources to use to localize the body text to the user's current localization. Example: NOTIFICATION_MESSAGE |
| config.ttl | In seconds. Min: 0. Max: 2.419.200. Default: same as Firebase (current: 2.419.200). |
| callbackUrl | URL that should begin with https:// |
| data | This parameter specifies the custom key-value pairs of the message's payload. For example, with data:{"score":"3x1"}: On Apple platforms, if the message is sent via APNs, it represents the custom data fields. If it is sent via FCM, it would be represented as key value dictionary in AppDelegate application:didReceiveRemoteNotification:. On Android, this would result in an intent extra named score with the string value 3x1. The key should not be a reserved word ("from", "message_type", or any word starting with "google" or "gcm"). Values in string types are recommended. You have to convert values in objects or other non-string data types (e.g., integers or booleans) to string. |
| data.key | Not Blank. |
| data.value | Not Blank. |
| createdAt | Date of creation. Current server timestamp. |
ERROR CODES
Please note that the error codes section will be updated!
| STATUS | CODE | DESCRIPTION |
|---|---|---|
| 404 | 0100 | trackingId is invalid: "PushNotification not found". |
| 400 | - | trackingId is empty: "trackingId: must not be blank". |