Omnicell приклад статусів

Отримати стан повідомлення за допомогою ідентифікатора повідомлення через XML

Приклад запиту(XML)

http

POST /ip2sms-request/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: text/xml
Authorization: Basic YWRtaW46YWRtaW4=

<request id="6614006811071">state</request>

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms-request/ -H 'Content-Type: text/xml' --data-raw '<request id="6614006811071">state</request>' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms-request/ --header='Content-Type: text/xml' --post-data='<request id="6614006811071">state</request>' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms-request/', headers={
    'Content-Type': 'text/xml',
}, data='<request id="6614006811071">state</request>', auth=('admin', 'admin'))

Приклад відповіді(XML)

HTTP/1.1 200 OK
Content-type: text/xml

<status id="6614006811071" date="Mon, 19 Nov 2018 16:13:00 +0200">
   <state>Delivered</state>
</status>

Отримати SMS + VIBER або SMS + BiP або SMS + VIBER + BiP стан повідомлення за допомогою ідентифікатора повідомлення через XML

Request example, EXTENDED(XML)

http

POST /ip2sms-request/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: text/xml
Authorization: Basic YWRtaW46YWRtaW4=

<request extended="true" id="6614007025373">state</request>

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms-request/ -H 'Content-Type: text/xml' --data-raw '<request extended="true" id="6614007025373">state</request>' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms-request/ --header='Content-Type: text/xml' --post-data='<request extended="true" id="6614007025373">state</request>' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms-request/', headers={
    'Content-Type': 'text/xml',
}, data='<request extended="true" id="6614007025373">state</request>', auth=('admin', 'admin'))

Response example, EXTENDED(XML)

HTTP/1.1 200 OK
Content-type: text/xml

<status id="6614007025373" date="Tue, 20 Nov 2018 11:18:27 +0200" execTime="13">
   <state>Undeliverable</state>
   <viberExtStatus>VIBER_USER_NOT_FOUND</viberExtStatus>
   <deliveryDate>Thu, 21 Mar 2019 01:41:16 +0200</deliveryDate>
   <deliveryChannel>VIBER</deliveryChannel>
</status>

Примітка

Запит статуса для Viber повідомлень підтримує `` extended`` атрибут, в результаті ви можете отримати розширений статус Viber

Отримати стан повідомлення за допомогою ідентифікатора повідомлення через JSON

Приклад запиту(JSON)

http

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

{
  "extended": true,
  "id": 6614012456419,
  "value": "state"
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms-request/ -H 'Content-Type: application/json;charset=UTF-8' --data-raw '{"extended": true, "id": 6614012456419, "value": "state"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms-request/ --header='Content-Type: application/json;charset=UTF-8' --post-data='{"extended": true, "id": 6614012456419, "value": "state"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms-request/', headers={
    'Content-Type': 'application/json;charset=UTF-8',
}, json={
    'extended': True,
    'id': 6614012456419,
    'value': 'state',
}, auth=('admin', 'admin'))

Приклад відповіді(JSON)

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

{
   "state": {"value": "Delivered"},
   "deliveryDate": "Tue, 20 Nov 2018 09:43:10 +0200",
   "id": "6614012456419",
   "date": "Tue, 20 Nov 2018 09:43:42 +0200",
   "execTime": "6"
}

Отримати масовий статус за допомогою ідентифікатора групи повідомлень

Приклад запиту(XML)

http

POST /ip2sms-request/ HTTP/1.1
Host: api.lifecell.com.ua
Content-type: text/xml
Authorization: Basic YWRtaW46YWRtaW4=

<request groupid="20623">details</request>

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms-request/ -H 'Content-Type: text/xml' --data-raw '<request groupid="20623">details</request>' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms-request/ --header='Content-Type: text/xml' --post-data='<request groupid="20623">details</request>' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms-request/', headers={
    'Content-Type': 'text/xml',
}, data='<request groupid="20623">details</request>', auth=('admin', 'admin'))

Приклад відповіді(XML)

HTTP/1.1 200 OK
Content-type: text/xml

<status groupid="20623" date="Tue, 20 Nov 2018 08:46:26 +0200" reports="waiting">
   <state>sending</state>
   <total>3</total>
   <queued>0</queued>
   <accepted>3</accepted>
   <enroute>3</enroute>
   <delivered>0</delivered>
   <expired>0</expired>
   <undeliverable>0</undeliverable>
   <unknown>0</unknown>
   <detail date="Tue, 20 Nov 2018 08:46:22 +0200">
      <id>6614007025353</id>
      <state>Accepted</state>
   </detail>
   <detail date="Tue, 20 Nov 2018 08:46:22 +0200">
      <id>6614007025354</id>
      <state>Accepted</state>
   </detail>
</status>

Отримати масовий статус за допомогою ідентифікатора групи повідомлень через JSON

Приклад запиту(JSON)

http

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

{
  "extended": true,
  "groupid": 12345,
  "value": "status"
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms-request/ -H 'Content-Type: application/json;charset=UTF-8' --data-raw '{"extended": true, "groupid": 12345, "value": "status"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms-request/ --header='Content-Type: application/json;charset=UTF-8' --post-data='{"extended": true, "groupid": 12345, "value": "status"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms-request/', headers={
    'Content-Type': 'application/json;charset=UTF-8',
}, json={
    'extended': True,
    'groupid': 12345,
    'value': 'status',
}, auth=('admin', 'admin'))

Приклад відповіді(JSON)

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

{
   "state": {"value": "sent"},
   "total": "11",
   "queued": "12",
   "accepted": "10",
   "enroute": "0",
   "delivered": "3",
   "expired": "6",
   "undeliverable": "8",
   "unknown": "0",
   "groupid": "12345",
   "date": "Tue, 20 Nov 2018 09:51:59 +0200",
   "reports": "completed",
   "execTime": "3787"
}

Отримати детальні статуси за допомогою ідентифікатора групи повідомлень через JSON

Приклад запиту(JSON)

http

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

{
  "extended": true,
  "groupid": 12345,
  "value": "details"
}

curl

curl -i -X POST https://api.lifecell.com.ua/ip2sms-request/ -H 'Content-Type: application/json;charset=UTF-8' --data-raw '{"extended": true, "groupid": 12345, "value": "details"}' --user admin:admin

wget

wget -S -O- https://api.lifecell.com.ua/ip2sms-request/ --header='Content-Type: application/json;charset=UTF-8' --post-data='{"extended": true, "groupid": 12345, "value": "details"}' --auth-no-challenge --user=admin --password=admin

python-requests

requests.post('https://api.lifecell.com.ua/ip2sms-request/', headers={
    'Content-Type': 'application/json;charset=UTF-8',
}, json={
    'extended': True,
    'groupid': 12345,
    'value': 'details',
}, auth=('admin', 'admin'))

Приклад відповіді(JSON)

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

{
   "state": {"value": "sending"},
   "total": "11",
   "queued": "12",
   "accepted": "10",
   "enroute": "6",
   "delivered": "3",
   "expired": "0",
   "undeliverable": "2",
   "unknown": "0",
   "groupid": "12345",
   "date": "Tue, 20 Nov 2018 09:48:58 +0200",
   "reports": "waiting",
   "detail":    [

            {
         "id": "6614012456460",
         "state": {"value": "Delivered"},
         "deliveryDate": "Tue, 20 Nov 2018 09:48:47 +0200",
         "date": "Tue, 20 Nov 2018 09:48:47 +0200"
      },
           {
         "id": "6614012456453",
         "state": {"value": "Delivered"},
         "deliveryDate": "Tue, 20 Nov 2018 09:48:36 +0200",
         "date": "Tue, 20 Nov 2018 09:48:36 +0200"
      },
            {
         "id": "6614012456455",
         "state": {"value": "Enroute"},
         "date": "Tue, 20 Nov 2018 09:48:36 +0200"
      }
   ],
   "execTime": "606"
}

Можливі статуси повідомлення

Статус Опис
Accepted Повідомлення прийнято IP2SMS-платформою, але спроба доставки ще не робилася
Enroute Робляться спроби доставити повідомлення, однак, воно ще не доставлено
Delivered Повідомлення доставлено одержувачу
Expired Вичерпано ліміт часу на спроби доставити повідомлення; наступні спроби робитися не будуть
Deleted Повідомлення примусово видалено з системи адміністратором
Undeliverable Повідомлення з тих чи інших причин не може бути доставлено одержувачу (наприклад, спроба доставити на неіснуючий телефонний номер)
Rejected Повідомлення відхилено через помилки в ньому (порушення формату, спроба відправити повідомлення за межі українських операторів і т.п.)
Unknown Стан повідомлення невідомо

Примітка

Поле «Стан розсилки» містить інформацію про поточний стан рассылки

Статус Опис
waiting Розсилка ще не почалася
sending Розсилка в процесі
sent Розсилка завершена
paused Розсилка призупинена
canceled Розсилка частково скасована

Примітка

Поле «стан прийому звітів» містить інформацію про поточний стан отримання звітів про доставку повідомлень від операторів. Воно з’являється тільки коли відправлення повідомлень завершено (state = «sent») і може приймати наступні значення:
  • період актуальності повідомлень ще не пройшов, система очікує звіти про доставку повідомлень
  • прийом звітів про доставку завершено