Omnicell приклад для відправки SMS повідомлення через JSON API

Примітка

Для стратегії SMS - повідомлення доставляється в період, визначений атрибутом „validity“, значення за замовчуванням - 3 години

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

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

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": "<alphaname>",
  "desc": "Simple bulk via json",
  "type": "SMS",
  "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", "source": "<alphaname>", "to": [{"msisdn": "380930000100"}], "type": "SMS", "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", "source": "<alphaname>", "to": [{"msisdn": "380930000100"}], "type": "SMS", "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',
    'source': '<alphaname>',
    'to': [{
        'msisdn': '380930000100',
    }],
    'type': 'SMS',
    '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"
}

Відправка масового 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": "TESTBMSAST",
  "desc": "test",
  "uniq_key": 12345,
  "type": "SMS",
  "to": [
    {"msisdn": "380950000502"},
    {"msisdn": "380950009003"},
    {"msisdn": "380950009002"},
    {"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 '{"body": {"value": "Have a nice day!"}, "desc": "test", "extended": "true", "id": "bulk", "source": "TESTBMSAST", "to": [{"msisdn": "380950000502"}, {"msisdn": "380950009003"}, {"msisdn": "380950009002"}, {"msisdn": "000000000000"}], "type": "SMS", "uniq_key": 12345}' --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!"}, "desc": "test", "extended": "true", "id": "bulk", "source": "TESTBMSAST", "to": [{"msisdn": "380950000502"}, {"msisdn": "380950009003"}, {"msisdn": "380950009002"}, {"msisdn": "000000000000"}], "type": "SMS", "uniq_key": 12345}' --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!',
    },
    'desc': 'test',
    'extended': 'true',
    'id': 'bulk',
    'source': 'TESTBMSAST',
    'to': [{
        'msisdn': '380950000502',
    }, {
        'msisdn': '380950009003',
    }, {
        'msisdn': '380950009002',
    }, {
        'msisdn': '000000000000',
    }],
    'type': 'SMS',
    'uniq_key': 12345,
}, 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.

Відправка індивідульного 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": "TESTBMSAST",
  "desc": "Individua bulk example",
  "type": "SMS",
  "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": "Individua bulk example", "id": "individual", "source": "TESTBMSAST", "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": "SMS", "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": "Individua bulk example", "id": "individual", "source": "TESTBMSAST", "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": "SMS", "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': 'Individua bulk example',
    'id': 'individual',
    'source': 'TESTBMSAST',
    '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': 'SMS',
    '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"
}

Примітка

SMS: Максимальна довжина одного повідомлення - 160 символів для GSM7 стандартні або 70 символів для закодованих кодом Unicode повідомлень. Якщо відправлено текст, що перевищує максимальну кількість символів, що підтримуються,то відправлене повідомлення буде сегментовано та оплачено відповідно. Одне довге SMS, що складається з двох повідомлень, рахується як дві SMS.