Send a Multicast Push Notification

To effectively send multicast push notifications, a system must be in place to manage and map device tokens to unique identifiers such as Routee IDs, Email IDs, or Phone Numbers. Initially, each device token—a unique identifier for a device assigned by the push notification service—is added to a centralized database. These tokens are then mapped to unique IDs, organizing them in a way that they can be efficiently retrieved based on user identity. When a multicast notification is to be sent, the unique ID is specified in the request body, enabling the system to fetch all corresponding device tokens from the database. This process ensures that the notification reaches all devices associated with that ID. Additionally, the request must include device-specific configurations for Web, Android, and iOS platforms, accommodating the different technical requirements and enhancing the delivery effectiveness across varied device types. This approach ensures that notifications are not only targeted and well-managed but also tailored to meet the specific display and interaction standards of each device platform, thus maximizing reach and user engagement.

To address the need for enhanced functionality in our Push Notifications service, we have identified the necessity to introduce a new endpoint. This addition aims to streamline the process of setting up and sending push notifications efficiently. The proposed solution involves the integration of a new endpoint, https://connect.routee.net/push-notifications/messages/multicast, into our existing Push Notifications service. This endpoint is specifically designed to cater to Routee API users, providing them a direct and efficient method to send notifications. By utilizing this endpoint, users will be able to submit their notification requests through a standardized interface, which simplifies the way notifications are managed and dispatched. This enhancement not only improves the service's usability for developers but also enhances the overall performance by providing a specific pathway for handling push notification requests, thereby optimizing the communication workflow within the Routee platform.

Resource

Method: POST

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

Request Headers

Request:

curl --location 'https://connect.routee.net/push-notifications/messages/multicast' \
--header 'Authorization: Bearer 96ccc93f-667a-41bd-a461-4b6530cea529' \
--header 'Content-Type: application/json' \
--header 'Principal: XXX' \
--header 'Originating-Client-Id: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
  "routeeContactId": "XXXXXXXXXX",
  "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-dd73f6e5d6c4"]  
  }
}

Expected Errors