HoloPush

HoloPush requires a workflow for requesting, creating, reviewing and approving HoloPush messages.

Holopush message create

POST https://exchange-prod-g.2mee.com/notification/create

Create a message for sending out HoloPush notification.

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/PULL.
action	string	Action text is provided in the HoloPush notification. Upon clicking on the action text deep link is opened (if provided).

201

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "Title of the Message",
    "subtitle": "SubTitle of the Message",
    "text": "Body of the Message",
    "action": "Open",
    "fbTitle": "FallBack Title of the Message",
    "fbSubtitle": "Fallback SubTitle of the Message",
    "fbText": "FallBack Text of the Message",
    "expiry": 1440,
    "playTime": 1582614107682,
    "about": [],
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "priority": "LOW",
    "favourite": 0,
    "type": "TEXT",
    "channel": "PUSH",
    "segment": null,
    "subType": "T",
    "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "state": "NEW",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "messageTitle": null,
    "url": null,
    "id": "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
    "size": null,
    "tags": null,
    "parentMessageId": null,
    "holoPushAd": null,
    "jobId": null,
    "holoPushUrl": null
}

$ curl 'https://exchange-prod-g.2mee.com/notification/create' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA' -d '{
  "appId" : "bacb37d0-a51f-491b-bd68-489c245b8c16",
  "title" : "Title of the Message",
  "subtitle" : "SubTitle of the Message",
  "text" : "Body of the Message",
  "action" : "Open",
  "fbTitle" : "FallBack Title of the Message",
  "fbSubtitle" : "Fallback SubTitle of the Message",
  "fbText" : "FallBack Text of the Message",
  "expiry" : 1440,
  "playTime" : 1582614107682,
  "about" : [],
  "filterId" : "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
  "priority" : "LOW",
  "favourite" : 0,
  "type" : "HOLOPUSH",
  "channel" : "PUSH"
  }'

HoloPush recording create

POST https://exchange-prod-g.2mee.com/job/create

HoloPush message create starts the recording workflow by assigning a HoloPush message to one of your creators to record. Unlike a text message it requires a creator to record a hologram for HoloPush message.

Request Body

Name	Type	Description
notificationId	string	Message Id to which the recording will be added.
title	string	appears as the title for the HoloPush notification.
description	string	description for the HoloPush message
holopushLevel	string	recording mode. the value must be TORSO.
dueDate	string	Date by which HoloPush has to be accepted.
appId	string	Application Id for which HoloPush notification has to be created.
isStock	integer	Is the recording from holo library?.
favourite	integer	A HoloPush message marked as a favourite will appear on the top of the message listing page of UI.
script	string	Script providing a description for the actor for recording hologram.
artist	string	Email of an artist to whom the HoloPush message has to be assigned.
artistDueDate	number	Date by which artist has to record the hologram.

201

{
    "id": "ada70a04-ddec-4908-b15f-6dac85809bbb",
    "title": "Title for the Message",
    "description": "Message Description",
    "holoPushLevel": "TORSO",
    "dueDate": 1582613760565,
    "artist": "[e-mail]",
    "artistDueDate": 1582613760565,
    "script": "Message Script",
    "creator": "[e-mail]",
    "favourite": 0,
    "filterId": null,
    "isStock": 0,
    "state": "NEW",
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "appName": null,
    "campaignId": null,
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "artistName": "Dan Kersley",
    "history": null,
    "tags": null,
    "take": null,
    "creatorName": "Testi Team",
    "segment": null,
    "notificationId": "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
    "jobType": "HOLOPUSH",
    "lastNudgeTime": null
}job/create' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA' -d '{
  "title" : "Title for the Message",
  "description" : "Message Description",
  "holoPushLevel" : "TORSO",
  "dueDate" : 1582613760565,
  "artistDueDate" : 1582613760565,
  "artist" : "[e-mail]",
  "appId" : "bacb37d0-a51f-491b-bd68-489c245b8c16",
  "favourite" : 0,
  "script" : "Message Script",
  "isStock" : 0,
  "notificationId" : "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
  "jobType" :"HOLOPUSH"
}'

$ curl 'https://exchange-prod-g.2mee.com/job/create' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA' -d '{
  "title" : "Title for the Message",
  "description" : "Message Description",
  "holoPushLevel" : "TORSO",
  "dueDate" : 1582613760565,
  "artistDueDate" : 1582613760565,
  "artist" : "[e-mail]",
  "appId" : "bacb37d0-a51f-491b-bd68-489c245b8c16",
  "favourite" : 0,
  "script" : "Message Script",
  "notificationId" : "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
  "jobType" :"HOLOPUSH"
}'

HoloPush recording update

PUT https://exchange-prod-g.2mee.com/job/update

Updates the existing HoloPush Message. You cannot update the HoloPush Message after scheduling.

Request Body

Name	Type	Description
holopushLevel	string	Recording mode. This value must be TORSO.
dueDate	string	Date by which HoloPush has to be in ACCEPTED state.
title	string	Appears as the title on the HoloPush notification and explains the purpose of notification.
artist	string	Assigned HoloPush artist email.
creator	string	HoloPush creator email.
take	string	It represents the hologram recording file id.
description	string	It acts as a description for the hologram.
segment	string	Audience segment for the delivery of HoloPush notification.
artistName	string	Name of the artist who is recording the hologram.
artistDueDate	string	Due date by which artist has to record the hologram.
id	string	HoloPush Id.
filterId	string	The audience segment that has to be picked up for the delivery of HoloPush notification. Can be found from audience listing API.
script	string	Script provided as a description for the actor for the recording of the hologram.
favourite	integer	HoloPush message marked as a favourite will appear on the top of the message listing page in the UI.
isStock	integer	Is this recording from the holo library?

200

{
    "id": "ada70a04-ddec-4908-b15f-6dac85809bbb",
    "title": "updated Title for the Message",
    "description": "updated Message Description",
    "holoPushLevel": "TORSO",
    "dueDate": 1582613760565,
    "artist": "[e-mail]",
    "artistDueDate": 1582613760565,
    "script": "Message Script",
    "creator": "[e-mail]",
    "favourite": 0,
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "isStock": 0,
    "state": "NEW",
    "take": null,
    "hasPayload": false,
    "tags": [],
    "notificationId": "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
    "jobType": "HOLOPUSH"
}

$ curl 'https://exchange-prod-g.2mee.com/job/update' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA' -d '{
  "title" : "updated Title for the Message",
  "description" : "updated Message Description",
  "holoPushLevel" : "TORSO",
  "dueDate" : 1582613760565,
  "artistDueDate" : 1582613760565,
  "artist" : "[e-mail]",
  "appId" : "bacb37d0-a51f-491b-bd68-489c245b8c16",
  "favourite" : 0,
  "script" : "Message Script",
  "isStock" : 0,
  "jobType" :"HOLOPUSH",
  "id":"ada70a04-ddec-4908-b15f-6dac85809bbb",
  "filterId" : "9e862fc2-e3b6-4420-bf63-80ad4368ec88"
}'

HoloPush assign artist

POST https://exchange-prod-g.2mee.com/job/executeJob

Send a request to the artist to record a hologram. Make sure artist and artist due date are present and the HoloPush is not already present with the artist.

Request Body

Name	Type	Description
id	string	Holopush Id.

200

{
    "id": "ada70a04-ddec-4908-b15f-6dac85809bbb",
    "title": "updated Title for the Message",
    "description": "updated Message Description",
    "holoPushLevel": "TORSO",
    "dueDate": "2020-02-25",
    "artist": "[e-mail]",
    "artistDueDate": "2020-02-25",
    "script": "Message Script",
    "creator": "[e-mail]",
    "favourite": 0,
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "isStock": 0,
    "state": "EXECUTE",
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "appName": "Casino App",
    "campaignId": null,
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "artistName": "Ravuri Abhignya",
    "history": [{
        "created": 1590128723000,
        "updated": 1590128723000,
        "id": 46582,
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "comment": null,
        "defaultComment": " created this message.",
        "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "creatorName": "Testi Team"
    }, {
        "created": 1590129204000,
        "updated": 1590129204000,
        "id": 46593,
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "comment": null,
        "defaultComment": " took ownership from Dan Kersley",
        "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "creatorName": "Testi Team"
    }],
    "tags": [],
    "take": null,
    "creatorName": "Testi Team",
    "segment": null,
    "notificationId": "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
    "jobType": "HOLOPUSH",
    "lastNudgeTime": null

$ curl 'https://exchange-prod-g.2mee.com/job/executeJob?id=ada70a04-ddec-4908-b15f-6dac85809bbb' 
-i -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA' 

HoloPush recording select

POST https://exchange-prod-g.2mee.com/holoPush/select

Submissions can contain many holograms. Select the best hologram before accepting and scheduling It.

Path Parameters

Name	Type	Description
file_id	string	File Id for selecting recorded hologram.

200

[
    {
        "id": "344445d5-53fc-4ef9-9634-ffb55242e01b",
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "state": "REVIEW",
        "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
        "createdBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "comments": null,
        "fileCount": 0,
        "created": 1590129548000,
        "updated": 1590131254785,
        "takes": [
            {
                "created": 1590129688000,
                "updated": 1590131254735,
                "id": "052e5a4e-1271-4901-b0a1-10df8073277a",
                "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
                "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/ada70a04-ddec-4908-b15f-6dac85809bbb-344445d5-53fc-4ef9-9634-ffb55242e01b-take-1.mp4",
                "state": "SELECTED",
                "fileName": "ada70a04-ddec-4908-b15f-6dac85809bbb-344445d5-53fc-4ef9-9634-ffb55242e01b-take-1.mp4",
                "submission": "344445d5-53fc-4ef9-9634-ffb55242e01b",
                "actor": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
                "duration": 2000,
                "seekTime": 0.345,
                "pngUrl": null
            }
        ]
    }
]

$ curl 'https://exchange-prod-g.2mee.com/job/select?file_id=052e5a4e-1271-4901-b0a1-10df8073277a' 
-i -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA' 

HoloPush recording accept

POST https://exchange-prod-g.2mee.com/job/accept

Accepts the HoloPush with the selected submission and the recording from the submission. A HoloPush has to be accepted before the due date.

Path Parameters

Name	Type	Description
id	string	HoloPush Id to be accepted.

200

{
    "id": "ada70a04-ddec-4908-b15f-6dac85809bbb",
    "title": "updated Title for the Message",
    "description": "updated Message Description",
    "holoPushLevel": "TORSO",
    "dueDate": "2020-05-23",
    "artist": "[e-mail]",
    "artistDueDate": "2020-05-23",
    "script": "Message Script",
    "creator": "[e-mail]",
    "favourite": 0,
    "filterId": "9e862fc2-e3b6-4420-bf63-80ad4368ec88",
    "isStock": 0,
    "state": "ACCEPTED",
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "appName": "Casino App",
    "campaignId": null,
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "artistName": "Ravuri Abhignya",
    "history": [{
        "created": 1590128723000,
        "updated": 1590128723000,
        "id": 46582,
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "comment": null,
        "defaultComment": " created this message.",
        "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "creatorName": "Testi Team"
    }, {
        "created": 1590129204000,
        "updated": 1590129204000,
        "id": 46593,
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "comment": null,
        "defaultComment": " took ownership from Dan Kersley",
        "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "creatorName": "Testi Team"
    }, {
        "created": 1590129316000,
        "updated": 1590129316000,
        "id": 46600,
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "comment": null,
        "defaultComment": " assigned this message to Ravuri Abhignya ",
        "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "creatorName": "Testi Team"
    }, {
        "created": 1590129548000,
        "updated": 1590129548000,
        "id": 46611,
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "comment": null,
        "defaultComment": " created submission for this message.",
        "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "creatorName": "Testi Team"
    }],
    "tags": [],
    "take": {
        "created": 1590129688000,
        "updated": 1590131254000,
        "id": "052e5a4e-1271-4901-b0a1-10df8073277a",
        "jobId": "ada70a04-ddec-4908-b15f-6dac85809bbb",
        "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/ada70a04-ddec-4908-b15f-6dac85809bbb-344445d5-53fc-4ef9-9634-ffb55242e01b-take-1.mp4",
        "state": "SELECTED",
        "fileName": "ada70a04-ddec-4908-b15f-6dac85809bbb-344445d5-53fc-4ef9-9634-ffb55242e01b-take-1.mp4",
        "submission": "344445d5-53fc-4ef9-9634-ffb55242e01b",
        "actor": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
        "duration": 2000,
        "seekTime": 0.345,
        "pngUrl": null
    },
    "creatorName": "Testi Team",
    "segment": null,
    "notificationId": "2ab80602-1fc1-401e-9ee7-80a81f29f0a7",
    "jobType": "HOLOPUSH",
    "lastNudgeTime": 1590129457000
}

$ curl 'https://exchange-prod-g.2mee.com/job/accept?id=ada70a04-ddec-4908-b15f-6dac85809bbb'
 -i -X POST  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTU4OTQ1NTc0OSwiaWF0IjoxNTg5NDM3NzQ5fQ.U2VtugGzqD0s9p0rUXaTxk8F5tHeMf5SB4ZRnYM8TV4QQm6y2FvdFIfD6kjQOhcYuPglSusAjVegzHqDKGgCqA'

HoloPush message with stockId

POST https://exchange-prod-g.2mee.com/slot/create/fromStock

Create slot with selected stockId. If an audience is not selected, the filter used is: All Users i.e Default filter.

Path Parameters

Name	Type	Description
stockId	string	Stock Id represents the hologram to be sent with the created message.

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/PULL.
action	string	Action text is provided in the HoloPush notification. Upon clicking on the action text deep link is opened (if provided).

201

{
    "created": 1603962352866,
    "updated": 1603962352866,
    "id": "59d8f955-1aa7-4e79-8c3c-94e8414e1f71",
    "title": "slot created from stock for -216853855",
    "description": "Slot created from Stock",
    "appId": "55110763-13d5-4b79-af81-d4aae09fe325",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "notificationId": "5ec5d261-c2e1-409a-aef3-8b9b555466f2",
    "jobId": "ee647d4f-d97a-4c45-9a39-b9a7606cbd85",
    "addedBy": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "addedAt": 1603962349443,
    "creator": null,
    "job": null,
    "tags": null,
    "slotMap": null,
    "active": true
}

$ curl 'https://exchange-prod-g.2mee.com/slot/fromStock?stockId=90381a59-0042-4ac3-8e5b-5a17445f3855' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTYwMzQ1NDIzOSwiaWF0IjoxNjAzNDM2MjM5fQ.LDhQQj_Q9GjkFFnyzSQzwSLMArbrx58wChvXWZNPoIOhZU0ZthEB5dMQQcwfhb3mYhQxEp2DoDfliSLcCiAOxw' -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"}'