Send push notifications

Overview

In order to optimize the delivery of push notifications and streamline operational processes, a new endpoint, https://connect.routee.net/push-notifications/messages, has been seamlessly integrated into the existing Push Notifications service.

Specifically designed for Routee API users, this endpoint facilitates the transmission of structured notifications via HTTP POST requests. The detailed JSON payloads mandated by this endpoint encompass crucial information like message content, recipient device tokens, and any other pertinent data essential for targeted and personalized notifications.

Moreover, stringent security measures, such as API keys or OAuth tokens, have been implemented for authentication purposes, ensuring that only authorized users can initiate notifications and guaranteeing the secure processing of each request. The system also offers immediate feedback on the status of sent notifications, ranging from successful queueing to detailed error reports in the event of any issues, thereby enhancing transparency and providing users with greater control over the notification process.

This enhancement not only simplifies the process of sending notifications for users but also ensures that the infrastructure can efficiently scale to meet escalating demands, thereby upholding the performance and reliability of communication services.

Resource

Method: POST

URL: https://connect.routee.net/push-notifications/messages

Request Headers

Request:

curl --location 'https://connect.routee.net/push-notifications/messages' \
--header 'Authorization: Bearer adf1a590-94ab-4754-884c-6a8e4d172ab8' \
--header 'Content-Type: application/json' \
--data '{
  "implementationId": "64be7af142fe590001a22923",
  "routeeContactId": “12345678”,
  "body": {
    "title": {
      "en": "This is the title of the  notification"
    },
    "text": {
      "en": "This is the message of the  notification"
    },
    "forceLocale": "en"
  },
  "imageUrl": "https://pics.freeicons.io/uploads/ic",
  "android": {
    "clickAction": "OPEN_ACTIVITY_1",
    "icon": "https://pics.freeicons.io/uploads/icons/png/15798659891536125452-512.png",
    "localizedTitle": "LOCALIZATION_TITLE_KEY",
    "localizedText": "LOCALIZATION_TEXT_KEY",
    "ttl": 3600
  },
  "web": {
    "iconUrl": "https://cdn-icons-png.flaticon.com/512/1006/1006771.png",
    "targetUrl": "https://target.url"
  },
  "apn": {
    "localizedTitle": "LOCALIZATION_TITLE_KEY",
    "localizedText": "LOCALIZATION_TEXT_KEY",
    "ttl": 8000
  },
  "data": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3",
    "key4": "value4"
  },
 "callback": {
    "url": "https://webhook.site/ccd40751-d757-440d-bcdf-549f87faec79"}
}'

Response:

200 OK
{
    "routeeContactId": "64be7af142fe590001a22923"
}

Request Params

Extra Validations
Only one should be filled from the below fields (however they can be all null at the same time):

• android
• apn
• web
• We cannot have mismatching deviceToken type and config (example : if type is ANDROID, we must not have json “web” or “apn” – we can have either “android” or null.
• The maps of both, title and text, should contain an entry with forceLocale as their key.

Expected Response

Here is the expected response for Web, android and IOS.

Example Android Response

200 OK
{
  "trackingDetails": {
    "android": ["6c531a0c-e921,6c531a0c-e921-4636-86b5-dd73f6e5d6c1",
                "6c531a0c-e921,6c531a0c-e921-4636-86b5-dd73f6e5d6c2"],
  }
}

Example Web Response

200 OK
{
  "trackingDetails": {
    "web":     ["6c531a0c-e921,6c531a0c-e921-4636-86b5-dd73f6e5d6c3"],
  }
}

Example IOS Response

200 OK
{
  "trackingDetails": {
    "ios":     ["6c531a0c-e921,6c531a0c-e921-4636-86b5-dd73f6e5d6c3"]
  }
}

Expected Errors