SMS

SMS on 2mee Platform sends personalised Hologram messages as SMS to the phone numbers uploaded to the platform. Personalised Text messages can also be sent via 2mee.

Upload user Information

POST https://exchange-prod-g.2mee.com/sms/{appId}/csv

This endpoint uploads Audience CSV to 2mee and returns id to be used as filterId in the sms creation API.

Path Parameters

Name	Type	Description
appId	string	ID of application from which SMS is to be sent

Name

Type

Description

appId

string

ID of application from which SMS is to be sent

Request Body

Name	Type	Description
csv	object	CSV containing the phone number,userID, userName and custom fields.

Name

Type

Description

csv

object

CSV containing the phone number,userID, userName and custom fields.

{
    "id": "2ab2d10f-8c42-4fee-9be1-690e6d9ee74c",
    "name": "sms_2.csv_1629192391809_1629192391809",
    "query": "https://securefilter.s3.eu-geo.objectstorage.softlayer.net/a3f526c2-3d1d-40cc-9132-af283c9615c8",
    "creator": "479cec74-767e-4ecb-9e6d-ee508cadbd75",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "type": "SMSCSV",
    "isDefault": 0
}

curl -X POST 'https://exchange-prod-g.2mee.com/sms/bacb37d0-a51f-491b-bd68-489c245b8c16/csv' 
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTYwNDA3MzczOSwiaWF0IjoxNjA0MDU1NzM5fQ.ZS06eeAkGHqXVJN2WQndVsl6e1GWOPHKNnBKnzxyhwG-0HoPlzaKX06ENO2E5FQ4kAvfChmcU-iSYWQHBzEPig" 
-H "accept: */*" -H "Content-Type: multipart/form-data" 
-F "csv=@/Users/shrinidhidurairaj/Downloads/SMSCSV.csv"| jq '.'

Create SMS

POST http://server-v1.2mee.com/notification/create

Creates SMS when provided with filterID(Audience) and Holocapsule Id (Hologram in case of HOLOPUSH).

Request Body

Name	Type	Description
appId	string	ID of the app from which the SMS has to be sent
title	string	Title to identify the message in 2mee platform
type	string	Type of SMS - HOLOPUSH incase of attaching the capsule, TEXT incase of plain message
channel	string	SMS for SMS Messages
playTime	string	Time at which the message needs to be sent/scheduled
filterId	string	Audience to which the message has to be sent.
smsInfo	object	Should contain the below given parameters
message	string	The actual message that needs to be sent. Below are the placeholders for custom fields. {[name]} - for name {{[<wholelink>}}] - for tracked url
from	string	Sender ID to appear on the message received
trackedUrl	string	URL on which the holocapsule should appear. Mandatory incase of HOLOPUSH.
slotId	string	ID of the HOLOCAPSULE. This can be fetched from Holocapsule list scetion. Manadatory incase of HOLOPUSH.
position	string	Position of the Holocapsule on the URL page given. These are br(bottom-right),bl(bottom-left),tr(top-right) and tl(top-left). By default it is br.

Name

Type

Description

appId

string

ID of the app from which the SMS has to be sent

title

string

Title to identify the message in 2mee platform

type

string

Type of SMS - HOLOPUSH incase of attaching the capsule, TEXT incase of plain message

channel

string

SMS for SMS Messages

playTime

string

Time at which the message needs to be sent/scheduled

filterId

string

Audience to which the message has to be sent.

smsInfo

object

Should contain the below given parameters

message

string

The actual message that needs to be sent. Below are the placeholders for custom fields. {[name]} - for name {{[<wholelink>}}] - for tracked url

from

string

Sender ID to appear on the message received

trackedUrl

string

URL on which the holocapsule should appear. Mandatory incase of HOLOPUSH.

slotId

string

ID of the HOLOCAPSULE. This can be fetched from Holocapsule list scetion. Manadatory incase of HOLOPUSH.

position

string

Position of the Holocapsule on the URL page given. These are br(bottom-right),bl(bottom-left),tr(top-right) and tl(top-left). By default it is br.

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "2mee",
    "text": "Hi {[name]}, Click on {{[https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html]}} ",
    "playTime": "2021-08-17T10:49:34.897+0000",
    "filterId": "56a311ef-2079-40c7-878a-bf3d969e14e3",
    "type": "HOLOPUSH",
    "channel": "SMS",
    "smsInfo": {
        "notificationId": "3970f47e-c162-43c3-a2c8-46e964d3b8e8",
        "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
        "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
        "trackedUrl": "https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html",
        "slotId": "49fbfa2a-cad1-47f4-9140-be62a8518acf",
        "slotName": "Betzone Shop",
        "from": "2mee",
        "message": "Hi {[name]}, Click on {{[https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html]}} ",
        "position": "br"
    },
    "createdBy": "8b855c84-cc83-414b-b027-9fe0c8116dd7",
    "state": "NEW",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/fda6d888-052b-4204-9f9e-402dd0f4e942-a9188500-1974-46bf-8d20-c626c11726e3-take-1.mp4",
    "id": "3970f47e-c162-43c3-a2c8-46e964d3b8e8"
}

curl -X POST 'https://exchange-prod-g.2mee.com/notification/create' 
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTYwNDA3MzczOSwiaWF0IjoxNjA0MDU1NzM5fQ.ZS06eeAkGHqXVJN2WQndVsl6e1GWOPHKNnBKnzxyhwG-0HoPlzaKX06ENO2E5FQ4kAvfChmcU-iSYWQHBzEPig" 
-H "accept: */*" -H 'Content-Type: application/json' 
-d '{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "2mee",
    "type": "HOLOPUSH",
    "channel": "SMS",
    "smsInfo": {
        "position": "br",
        "message": "Hi {[name]}, Click on {{[https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html]}} ",
        "from": "2mee",
        "slotId": "49fbfa2a-cad1-47f4-9140-be62a8518acf",
        "trackedUrl": "https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html"
    },
    "playTime": 1629197374897,
    "filterId": "56a311ef-2079-40c7-878a-bf3d969e14e3"
}'

Schedule SMS

POST https://exchange-prod-g.2mee.com/sms/schedule

Sends SMS out of 2mee at the specified time

Query Parameters

Name	Type	Description
id	string	ID of the message created from SMS create API

Name

Type

Description

string

ID of the message created from SMS create API

{
    "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
    "title": "2mee",
    "text": "Hi {[name]}, Click on {{[https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html]}} ",
    "playTime": "2021-08-17T10:49:34.000+0000",
    "filterId": "56a311ef-2079-40c7-878a-bf3d969e14e3",
    "type": "HOLOPUSH",
    "channel": "SMS",
    "smsInfo": {
        "notificationId": "3970f47e-c162-43c3-a2c8-46e964d3b8e8",
        "appId": "bacb37d0-a51f-491b-bd68-489c245b8c16",
        "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
        "trackedUrl": "https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html",
        "slotId": "49fbfa2a-cad1-47f4-9140-be62a8518acf",
        "slotName": "Betzone Shop",
        "smsUserPayload": "https://securefilter.s3.eu-geo.objectstorage.softlayer.net/a2e3a94a-0eac-4dab-b4a8-8050616c9f0c",
        "from": "2mee",
        "message": "Hi {[name]}, Click on {{[https://exchange.cdnedge.bluemix.net/web/sms2meeMsg.html]}} ",
        "position": "br"
    },
    "createdBy": "8b855c84-cc83-414b-b027-9fe0c8116dd7",
    "state": "SCHEDULED",
    "companyId": "6c445333-bac9-4ab0-a0b6-cc6838902abb",
    "url": "https://secureexchange.s3.eu-geo.objectstorage.softlayer.net/fda6d888-052b-4204-9f9e-402dd0f4e942-a9188500-1974-46bf-8d20-c626c11726e3-take-1.mp4",
    "id": "3970f47e-c162-43c3-a2c8-46e964d3b8e8"
}

curl -X POST 'https://exchange-prod-g.2mee.com/sms/schedule?id=3970f47e-c162-43c3-a2c8-46e964d3b8e8' 
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0aW5ndGVhbUAybWVlLmNvbSIsImV4cCI6MTYwNDA3MzczOSwiaWF0IjoxNjA0MDU1NzM5fQ.ZS06eeAkGHqXVJN2WQndVsl6e1GWOPHKNnBKnzxyhwG-0HoPlzaKX06ENO2E5FQ4kAvfChmcU-iSYWQHBzEPig" 
-H "accept: */*"

PreviousA/B Test NextAudience

Last updated 1 year ago