HoloLibrary
HoloLibrary lets you save your favourite 2mee Holograms which can be used any number of times to send out messages.
HoloPush message from library
POST
https://exchange-prod-g.2mee.com/notification/fromStock
Create and schedule HoloPush messages from any library item. If the audience is not selected, the message is sent to All Users.
Path Parameters
Name | Type | Description |
---|---|---|
stockId | string | StockId represents the hologram to be sent with the created message. |
userList | string | Comma separated UserIDs to which the notification has to be delivered. |
Request Body
Name | Type | Description |
---|---|---|
type | string | Type of holopush notification HOLOPUSH/TEXT (HOLOPUSH in this case). |
appId | string | Application Id under which holopush message has to be created. |
title | string | Appears as the title on holopush notification. This explains the purpose of notification. |
subtitle | string | Appears as the subtitle on holopush notification. This explains additional information about the notification. |
text | string | The body that appears on the holopush notification. Content of the holopush notification. |
fbTitle | string | Fallback title for the holopush notification in case media file cannot be downloaded. |
fbSubtitle | string | Fallback subtitle for the holopush notification in case media file cannot be downloaded. |
fbText | string | Fallback text for the holopush notification in case media file is not downloaded. |
expiry | number | Duration from the playtime after which the holopush notification expires. A text with content Sorry! Opportunity missed! appears in case the user opens the holopush notification past expiry time. |
playTime | number | Time at which the holopush notification has to be delivered. Two options are provided. 1.Schedule Now(holopush notification will be delivered instantly) 2.Schedule Later(holopush notification will be delivered at the provided time) |
about | array | URL of the targeted page can be provided. It acts as a deep link. |
filterId | string | Filter id represents the audience segment and this can be found using audience listing API. |
priority | string | The priority of the holopush notification. HIGH/MEDIUM/LOW in string format. |
favourite | number | A holopush notification marked as a favourite will appear on the top of the message listing page of UI. |
channel | string | Channel PUSH for HOLOPUSH |
action | string | Action text is provided in the holopush notification. Upon clicking on the action text deep link is opened (if provided). |
HoloPush message from HoloLibrary with CSV user file
POST
https://exchange-prod-g.2mee.com/notification/fromStock/uploadUser
Create and schedule a HoloPush message from any library item. Upload a file with userIDs. Notification will be delivered to all the users present in the file.
Path Parameters
Name | Type | Description |
---|---|---|
stockId | string | StockId represents the hologram to be sent with the created message. |
Request Body
Name | Type | Description |
---|---|---|
file | object | File that contains userIDs |
notification | string | This contains the below-mentioned body parameters in json format. |
type | string | Type of HoloPush notification HOLOPUSH/TEXT (HOLOPUSH in this case). |
appId | string | Application Id under which HoloPush message has to be created. |
title | string | Appears as the title on HoloPush notification. This explains the purpose of notification. |
subtitle | string | Appears as the subtitle on HoloPush notification. This explains additional information about the notification. |
text | string | The body that appears on the HoloPush notification. Content of the HoloPush notification. |
fbTitle | string | Fallback title for the HoloPush notification in case media file cannot be downloaded. |
fbSubtitle | string | Fallback subtitle for the HoloPush notification in case media file cannot be downloaded. |
fbText | string | Fallback text for the HoloPush notification in case media file is not downloaded. |
expiry | number | Duration from the playtime after which the HoloPush notification expires. A text with content Sorry! Opportunity missed! appears in case the user opens the HoloPush notification past expiry time. |
playTime | number | Time at which the HoloPush notification has to be delivered. Two options are provided. 1.Schedule Now (HoloPush notification will be delivered instantly) 2.Schedule Later (HoloPush notification will be delivered at the provided time) |
about | array | URL of the targeted page can be provided. It acts as a deep link. |
favourite | number | A HoloPush notification marked as a favourite will appear on the top of the message listing page of UI. |
channel | string | Channel PUSH for HOLOPUSH |
action | string | Action text is provided in the HoloPush notification. Upon clicking on the action text deep link is opened (if provided). |
List the holograms present in HoloLibrary
GET
https://exchange-prod-g.2mee.com/holoPush/stock/list/onlyTitle
List the Id and title of holograms added to hololibrary.
Path Parameters
Name | Type | Description |
---|---|---|
appId | string | Application Id for which hololibrary item has to be listed. |
page | string | Provide information of page to be displayed. |
Last updated