Omnicell Docs Ua

Дерево сторінок

UA | EN

Властивість
Тип
Опис
Властивість
Тип
Опис
twoWayViberboolTwoWayViber service activation attribute, possible values – true, false.
hiddenTextboolАтрибут екранування тексту на стороні сервера, можливі значення – true, false
promoboolАтрибут рекламних повідомлень, можливі значення - true, false.
typeenumМоже бути одне з наступних значень: `` SMS``, `` OTT``, `` OTTSMS``, використовується стратегія надсилання повідомлень»
ottValiditytimeПеріод дії повідомлення в альтернативному каналі може бути не заданий.
ottImageUriuriПосилання для користувача на зображення може бути не задано, для BiP, VIBER. Необхідна схема запиту (http, https)
ottActionUriuriПосилання для користувача, для переходу при натисканні кнопки в повідомленні, може бути не задане, для BiP, VIBER. Необхідна схема запиту(http, https). Для здійснення дзвінка через Viber необхідно задати даний атрибут як viber://keypad?Number=380ХХХХХХХХХ, де 380ХХХХХХХХХ - номер, на який буде здійснено дзвінок.
ottenumПроцедура надсилання повідомлень в альтернативні канали, можливі значення – BiP, VIBER
ottSourcestringСписок ідентифікаторів послуг в альтернативних каналах, порядок має відповідати порядку каналів в атрибуті ott. Якщо клієнт має лише один активний ідентифікатор для конкретного каналу, він буде використовуватися автоматично без зазначення джерела в запиті. Якщо аліас вказано в запиті - він буде використаний, якщо явно вказаний ідентифікатор служби відсутній.
ottActionTitlestringТекст на кнопці в повідомленні може бути не заданий, для BiP, VIBER.
Властивість
Тип 
Опис
idenumМоже бути одним із таких значень: single, bulk, individual
sourcestringAlphaname клієнта використовується для надсилання текстового повідомлення
tonumericНомер мобільного телефону абонента для відправки SMS-повідомлення (msisdn)
validitytimeТермін дії повідомлення, після закінчення цього терміну, повідомлення буде в статусі „expired“ (напр.: +10 min, +1 hour)
starttimeПовідомлення буде відкладено на час в "start"(напр.: +10 min, Mon,  02  Apr  2007  11:58:24  +0300)

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

Figure: http

POST /ip2sms/ HTTP/1.1
Host: api.omnicell.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!"
  }
}

Приклад відповіді
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"
}



  • No labels