Omnicell SMS + VIBER чи SMS + BiP чи SMS + VIBER + BiP повідомлення через JSON приклад запиту

Можливі опції для повідомленнь в альтернативні канали

Лише текст

Атрибути ottImageUri, ottActionTitle, ottActionUri не задані, тег з текстом має бути заповнений (ottBody or body).

Текст + кнопка

Потрібно задати атрибути ottActionTitle та ottActionUri,тег з текстом має бути заповнений (ottBody or body).

Текст + картинка + кнопка

Потрібно задати атрибути ottImageUri, ottActionTitle , ottActionUri, тег з текстом має бути заповнений (ottBody or body).

Лише картинка

Атрибути ottActionTitle, ottActionUri не задані, оскільки тег тексту НЕ повинен бути заповнений (ottBody or body), потрібно задати лише атрибут ottImageUri.

Примітка

Для стратегії OTT доставка повідомлень для канала VIBER, BiP із зазначеним атрибутом ottValidity період для канала VIBER - значення за замовчуванням для транзакційного трафіку - 1 хвилина, для промо - 3 години, для канала BiP - значення за замовчуванням - 1 година

Примітка

При відправці повідомлень можно зазначити альтернативний довгий текст повідомлення– цей текст буде використаний при відправці в альтернативний канал, замість звичайного текста,який буде використаний для відправки повідомлень в канал SMS. Якщо альтернативний текст не заданий– для відправки повідомлень в альтернативний канал використовується звичайний текст.Альтернативний текст при відправці повідомлень в канал SMS ігнорується.Для задання альтернативного тексту використовується тег ottBody (використання по аналогії з тегом body – див. вище).Максимальна довжина довгого тексту: VIBER – 1000 символів в любій розкладці,``BiP`` – 2000 символів в любій розкладці.

Примітка

To be able to use TwoWayViber service in request to need add additional attributes twoWayViber = true.

Відправка одиничного VIBER + SMS повідомлення через JSON

Приклад запиту VIBER + SMS

http

POST /ip2sms/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: application/json
Authorization: Basic YWRtaW46YWRtaW4=

{
  "id": "single",
  "validity": "+30 min",
  "extended": true,
  "source": "<SMS_ALPHA>",
  "ottSource": "<VIBER_ID>",
  "desc": "Simple bulk via json",
  "type": "OTTSMS",
  "ott": "VIBER",
  "to": [
    {"msisdn": "380930000100"}
  ],
  "body": {
    "value": "Have a nice day!"
  }
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms/ -H 'Content-Type: application/json' --data-raw '{"body": {"value": "Have a nice day!"}, "desc": "Simple bulk via json", "extended": true, "id": "single", "ott": "VIBER", "ottSource": "<VIBER_ID>", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380930000100"}], "type": "OTTSMS", "validity": "+30 min"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms/ --header='Content-Type: application/json' --post-data='{"body": {"value": "Have a nice day!"}, "desc": "Simple bulk via json", "extended": true, "id": "single", "ott": "VIBER", "ottSource": "<VIBER_ID>", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380930000100"}], "type": "OTTSMS", "validity": "+30 min"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms/', headers={
    'Content-Type': 'application/json',
}, json={
    'body': {
        'value': 'Have a nice day!',
    },
    'desc': 'Simple bulk via json',
    'extended': True,
    'id': 'single',
    'ott': 'VIBER',
    'ottSource': '<VIBER_ID>',
    'source': '<SMS_ALPHA>',
    'to': [{
        'msisdn': '380930000100',
    }],
    'type': 'OTTSMS',
    'validity': '+30 min',
}, auth=('admin', 'admin'))

Приклад запиту BiP + VIBER + SMS

http

POST /ip2sms/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: application/json
Authorization: Basic YWRtaW46YWRtaW4=

{
  "id": "single",
  "validity": "+30 min",
  "extended": true,
  "source": "<SMS_ALPHA>",
  "ottSource": "<VIBER_AND_BIP_ID>",
  "desc": "Simple bulk via json",
  "type": "OTTSMS",
  "ott": "BIP,VIBER",
  "to": [
    {"msisdn": "380930000100"}
  ],
  "body": {
    "value": "Have a nice day!"
  }
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms/ -H 'Content-Type: application/json' --data-raw '{"body": {"value": "Have a nice day!"}, "desc": "Simple bulk via json", "extended": true, "id": "single", "ott": "BIP,VIBER", "ottSource": "<VIBER_AND_BIP_ID>", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380930000100"}], "type": "OTTSMS", "validity": "+30 min"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms/ --header='Content-Type: application/json' --post-data='{"body": {"value": "Have a nice day!"}, "desc": "Simple bulk via json", "extended": true, "id": "single", "ott": "BIP,VIBER", "ottSource": "<VIBER_AND_BIP_ID>", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380930000100"}], "type": "OTTSMS", "validity": "+30 min"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms/', headers={
    'Content-Type': 'application/json',
}, json={
    'body': {
        'value': 'Have a nice day!',
    },
    'desc': 'Simple bulk via json',
    'extended': True,
    'id': 'single',
    'ott': 'BIP,VIBER',
    'ottSource': '<VIBER_AND_BIP_ID>',
    'source': '<SMS_ALPHA>',
    'to': [{
        'msisdn': '380930000100',
    }],
    'type': 'OTTSMS',
    'validity': '+30 min',
}, auth=('admin', 'admin'))

Приклад відповіді

HTTP/1.1 200 OK
Content-type: application/json

{
   "state": {"value": "Accepted"},
   "id": "6614012446421",
   "date": "Tue, 20 Nov 2018 08:55:46 +0200",
   "execTime": "40"
}

Відправка масового VIBER + SMS повідомлення декільком отримувачам через JSON

Приклад запиту

http

POST /ip2sms/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: application/json;charset=UTF-8
Authorization: Basic YWRtaW46YWRtaW4=

{
  "id": "bulk",
  "extended": "true",
  "source": "<SMS_ALPHA>",
  "ottSource": "<VIBER_ID>",
  "desc": "test sms viber",
  "uniq_key": 123457,
  "type": "OTTSMS",
  "ott": "VIBER",
  "validity": "+4 hours",
  "ottValidity": "+2 min",
  "to": [
    {"msisdn": "380950000502"},
    {"msisdn": "380950009003"},
    {"msisdn": "380950009002"},
    {"msisdn": "000000000000"}
  ],
  "body": {
    "value": "Have a nice day to SMS channel!"
  },
  "ottBody": {
    "value": "Have a nice day to VIBER!"
  }
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms/ -H 'Content-Type: application/json;charset=UTF-8' --data-raw '{"body": {"value": "Have a nice day to SMS channel!"}, "desc": "test sms viber", "extended": "true", "id": "bulk", "ott": "VIBER", "ottBody": {"value": "Have a nice day to VIBER!"}, "ottSource": "<VIBER_ID>", "ottValidity": "+2 min", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380950000502"}, {"msisdn": "380950009003"}, {"msisdn": "380950009002"}, {"msisdn": "000000000000"}], "type": "OTTSMS", "uniq_key": 123457, "validity": "+4 hours"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms/ --header='Content-Type: application/json;charset=UTF-8' --post-data='{"body": {"value": "Have a nice day to SMS channel!"}, "desc": "test sms viber", "extended": "true", "id": "bulk", "ott": "VIBER", "ottBody": {"value": "Have a nice day to VIBER!"}, "ottSource": "<VIBER_ID>", "ottValidity": "+2 min", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380950000502"}, {"msisdn": "380950009003"}, {"msisdn": "380950009002"}, {"msisdn": "000000000000"}], "type": "OTTSMS", "uniq_key": 123457, "validity": "+4 hours"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms/', headers={
    'Content-Type': 'application/json;charset=UTF-8',
}, json={
    'body': {
        'value': 'Have a nice day to SMS channel!',
    },
    'desc': 'test sms viber',
    'extended': 'true',
    'id': 'bulk',
    'ott': 'VIBER',
    'ottBody': {
        'value': 'Have a nice day to VIBER!',
    },
    'ottSource': '<VIBER_ID>',
    'ottValidity': '+2 min',
    'source': '<SMS_ALPHA>',
    'to': [{
        'msisdn': '380950000502',
    }, {
        'msisdn': '380950009003',
    }, {
        'msisdn': '380950009002',
    }, {
        'msisdn': '000000000000',
    }],
    'type': 'OTTSMS',
    'uniq_key': 123457,
    'validity': '+4 hours',
}, auth=('admin', 'admin'))

Приклад відповіді

HTTP/1.1 200 OK
Content-type: application/json

{
   "state": {"value": "sending"},
   "total": "4",
   "queued": "0",
   "accepted": "3",
   "enroute": "0",
   "delivered": "0",
   "expired": "0",
   "undeliverable": "1",
   "unknown": "0",
   "date": "Tue, 20 Nov 2018 09:03:59 +0200",
   "reports": "waiting",
   "detail":    [
         {
         "id": "6614008602434",
         "state": {"value": "Accepted"}
         },
         {
         "id": "6614008602435",
         "state": {"value": "Accepted"}
         },
         {
         "id": "6614008602436",
         "state": {"value": "Accepted"}
         },
         {
         "id": "6614008602437",
         "state": {"value": "Rejected"}
         }
   ],
   "execTime": "4449"
}

Відправка індивідульного повідомлення декільком отримувачам з альтернативним текстом

Примітка

При відправці індивідуального альтернативного текста повідомлення допускається на рівнітега ottBody зазначати також атрибути ottImageUri, ottActionUri, ottActionTitle з індивідуальними значеннями для кожного одержувача. Якщо який-небудь (з перерахованих) індивідуальний атрибут не буде зазначений в тезі альтернативного тексту – буде використано значення однойменного атрибутуз тега service.

Відправка індивідульного BiP + SMS повідомлення декільком отримувачам через JSON

Приклад запиту

http

POST /ip2sms/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: application/json;charset=UTF-8
Authorization: Basic YWRtaW46YWRtaW4=

{
  "uniq_key": "11223344",
  "id": "individual",
  "source": "<SMS_ALPHA>",
  "ottSource": "<VIBER_ID>",
  "desc": "Individual bulk example sms + BIP",
  "type": "OTTSMS",
  "ott": "BIP",
  "to": [
    {
      "msisdn": "380630010000",
      "body": {
        "value": "Hello, Jack! Have a nice day!"
      }
    },
    {
      "msisdn": "380670020000",
      "body": {
        "value": "Hello, Nancy! Have a nice day!"
      }
    },
    {
      "msisdn": "000000000000",
      "body": {
        "value": "Have a nice day!"
      }
    }
  ]
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms/ -H 'Content-Type: application/json;charset=UTF-8' --data-raw '{"desc": "Individual bulk example sms + BIP", "id": "individual", "ott": "BIP", "ottSource": "<VIBER_ID>", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380630010000", "body": {"value": "Hello, Jack! Have a nice day!"}}, {"msisdn": "380670020000", "body": {"value": "Hello, Nancy! Have a nice day!"}}, {"msisdn": "000000000000", "body": {"value": "Have a nice day!"}}], "type": "OTTSMS", "uniq_key": "11223344"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms/ --header='Content-Type: application/json;charset=UTF-8' --post-data='{"desc": "Individual bulk example sms + BIP", "id": "individual", "ott": "BIP", "ottSource": "<VIBER_ID>", "source": "<SMS_ALPHA>", "to": [{"msisdn": "380630010000", "body": {"value": "Hello, Jack! Have a nice day!"}}, {"msisdn": "380670020000", "body": {"value": "Hello, Nancy! Have a nice day!"}}, {"msisdn": "000000000000", "body": {"value": "Have a nice day!"}}], "type": "OTTSMS", "uniq_key": "11223344"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms/', headers={
    'Content-Type': 'application/json;charset=UTF-8',
}, json={
    'desc': 'Individual bulk example sms + BIP',
    'id': 'individual',
    'ott': 'BIP',
    'ottSource': '<VIBER_ID>',
    'source': '<SMS_ALPHA>',
    'to': [{
        'msisdn': '380630010000',
        'body': {
            'value': 'Hello, Jack! Have a nice day!',
        },
    }, {
        'msisdn': '380670020000',
        'body': {
            'value': 'Hello, Nancy! Have a nice day!',
        },
    }, {
        'msisdn': '000000000000',
        'body': {
            'value': 'Have a nice day!',
        },
    }],
    'type': 'OTTSMS',
    'uniq_key': '11223344',
}, auth=('admin', 'admin'))

Приклад відповіді

HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8

{
   "state": {"value": "sending"},
   "total": "3",
   "queued": "0",
   "accepted": "2",
   "enroute": "0",
   "delivered": "0",
   "expired": "0",
   "undeliverable": "1",
   "unknown": "0",
   "groupid": "11223344",
   "date": "Tue, 20 Nov 2018 09:30:17 +0200",
   "reports": "waiting",
   "detail":    [
            {
         "id": "6614008602438",
         "state": {"value": "Accepted"}
      },
            {
         "id": "6614008602439",
         "state": {"value": "Accepted"}
      },
            {
         "id": "6614008602440",
         "state": {"value": "Rejected"}
      }
   ],
   "execTime": "5377"
}