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).

200

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "holopush-test-SN",
    "subtitle": "holopush-test-1-ravuri",
    "text": "text-1-ravuri",
    "action": "click",
    "fbTitle": "text-sn-test-1-ravuri",
    "fbSubtitle": "text-sn-test-1",
    "fbText": "text-sn-test-1",
    "expiry": 1440,
    "playTime": 1603962906000,
    "about": [],
    "filterId": "1c7ed570-52c2-4588-9b58-4972be3203b7",
    "priority": "MEDIUM",
    "favourite": 0,
    "type": "HOLOPUSH",
    "channel": "PUSH",
    "template": 0,
    "feature": null,
    "webTopic": null,
    "segment": {
        "name": "All Users",
        "type": "DEFAULT",
        "count": null
    },
    "subType": null,
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "SCHEDULED",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/7eb3ac29-0cc4-460f-b03a-9ac3da45f11c-c716c836-0d9a-408d-88bf-f704121e2d48-take-1.mp4",
    "id": "7eb3ac29-0cc4-460f-b03a-9ac3da45f11c",
    "size": null,
    "tags": null,
    "parentMessageId": null,
    "holoPushAd": null,
    "jobId": "f363562a-3397-4bac-a4c4-b0ce05bfb897",
    "holoPushUrl": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/7eb3ac29-0cc4-460f-b03a-9ac3da45f11c-c716c836-0d9a-408d-88bf-f704121e2d48-take-1h265.mp4;https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/7eb3ac29-0cc4-460f-b03a-9ac3da45f11c-c716c836-0d9a-408d-88bf-f704121e2d48-take-1.webm",
    "created": 1603962960504,
    "webActive": null
}

curl 'https://exchange-prod-g.2mee.com/notification/fromStock?stockId=90381a59-0042-4ac3-8e5b-5a17445f3855' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Token>' -d '{  "appId" : "bacb37d0-a51f-491b-bd68-489c245b8c16", "title" : "HOLOPUSH Message from API",  "subtitle" : "HOLOPUSH Message from API",  "text" : "HOLOPUSH Message from API",  "action" : "Close",  "fbTitle" : "FallBack Title of the Message", "fbSubtitle" : "Fallback SubTitle of the Message","fbText" : "FallBack Text of the Message", "expiry" : 1440,"playTime" : 1603189284000, "about" : [], "type" : "HOLOPUSH"}'

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).

200

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "holopush-test-SN",
    "subtitle": "holopush-test-1-ravuri",
    "text": "text-1-ravuri",
    "action": "click",
    "fbTitle": "text-sn-test-1-ravuri",
    "fbSubtitle": "text-sn-test-1",
    "fbText": "text-sn-test-1",
    "expiry": 1440,
    "playTime": 1603962906000,
    "about": [],
    "filterId": "1c7ed570-52c2-4588-9b58-4972be3203b7",
    "priority": "MEDIUM",
    "favourite": 0,
    "type": "HOLOPUSH",
    "channel": "PUSH",
    "template": 0,
    "feature": null,
    "webTopic": null,
    "segment": {
        "name": "All Users",
        "type": "DEFAULT",
        "count": null
    },
    "subType": null,
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "SCHEDULED",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/7eb3ac29-0cc4-460f-b03a-9ac3da45f11c-c716c836-0d9a-408d-88bf-f704121e2d48-take-1.mp4",
    "id": "7eb3ac29-0cc4-460f-b03a-9ac3da45f11c",
    "size": null,
    "tags": null,
    "parentMessageId": null,
    "holoPushAd": null,
    "jobId": "f363562a-3397-4bac-a4c4-b0ce05bfb897",
    "holoPushUrl": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/7eb3ac29-0cc4-460f-b03a-9ac3da45f11c-c716c836-0d9a-408d-88bf-f704121e2d48-take-1h265.mp4;https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/7eb3ac29-0cc4-460f-b03a-9ac3da45f11c-c716c836-0d9a-408d-88bf-f704121e2d48-take-1.webm",
    "created": 1603962960504,
    "webActive": null
}

curl -X POST "https://exchange-prod-g.2mee.com/notification/fromStock/uploadUser?stockId=29391ea7-4201-47fa-a76b-428fb26b162c" -H "Content-Type: multipart/form-data" -H "Authorization: Bearer <Token>" "accept: */*" -F "file=@/Users/shrinidhidurairaj/Downloads/userid.csv" -F "notification={\"appId\" : \"bacb37d0-a51f-491b-bd68-489c245b8c16\", \"title\" : \"HOLOPUSH Message from API\", \"subtitle\" : \"HOLOPUSH Message from API\", \"text\" : \"HOLOPUSH Message from API\",\"action\" : \"Close\", \"fbTitle\" : \"FallBack Title of the Message\", \"fbSubtitle\" : \"Fallback SubTitle of the Message\",\"fbText\" : \"FallBack Text of the Message\", \"expiry\" : 1440,\"playTime\" : 1603868228000, \"about\" : [], \"priority\" : \"LOW\",\"favourite\" : 0,\"type\" : \"HOLOPUSH\", \"channel\" : \"PUSH\"};type=application/json"  | jq '.'

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.

200

{
    "content": [
        {
            "id": "03318b03-986c-4896-b927-3ca9e4f3dc39",
            "title": "ravuri take"
        },
        {
            "id": "05aab3b2-faef-4d8f-a913-c8389d12af81",
            "title": "Breaking News"
        },
        {
            "id": "205dd89f-1956-4ac9-b5e2-6d843951162e",
            "title": "final test for saving holo"
        },
        {
            "id": "24d6fa16-0676-4de9-bec4-636d61471fd9",
            "title": "Happy Birthday"
        },
        {
            "id": "27674ea6-db8c-422a-bd97-3852d0f2dde2",
            "title": "For stock Library"
        },
        {
            "id": "29391ea7-4201-47fa-a76b-428fb26b162c",
            "title": "Aanvi hologram"
        },
        {
            "id": "2f2af074-00dd-4f29-9d26-6c1a6ea79a0c",
            "title": "Hologram Dev Dan"
        },
        {
            "id": "31d9e935-7e63-464b-8d37-dd06ae7613a2",
            "title": "Stock for dev"
        },
        {
            "id": "371c6a63-9da4-4241-b80c-7f13fcb0dcef",
            "title": "this is first one"
        },
        {
            "id": "3e853b9a-10b2-4beb-a0a0-d3417c9a0412",
            "title": "Special Offer"
        }
    ],
    "totalElements": 26,
    "totalPages": 3,
    "last": false,
    "size": 10,
    "number": 0,
    "sort": null,
    "numberOfElements": 10,
    "first": true
}

curl 'https://exchange-prod-g.2mee.com/holoPush/stock/list/onlyTitle?appId=bacb37d0-a51f-491b-bd68-489c245b8c16&page=0' -i -X GET  -H 'Authorization: Bearer <Token>'