Help Center Компатибилност ГМС АПИ-ја

Компатибилност ГМС АПИ-ја

СМСБАТ подржава слој компатибилности са ГМС АПИ. Ово вам омогућава да мигрирате своје постојеће интеграције дизајниране за ГМС директно у СМСБАТ без потребе да мењате своје шеме рутирања порука, структуре корисног оптерећења или слушаоце повратног позива.

Подешавања везе

Да бисте усмерили захтеве преко СМСБАТ-а, ажурирајте основни УРЛ и акредитиве за аутентификацију у својој интеграцији:

Основни УРЛ: хттпс://рестапи.смсбат.цом
Крајња тачка: ПОСТ /апи/ГМСМессаге/сенд_мессаге
Формат захтева: апплицатион/јсон
Аутентификација: ХТТП основна аутентификација (користи ваше СМСБАТ АПИ акредитиве)

Параметри захтева

ГМС компатибилни АПИ прихвата ЈСОН објекат са следећим параметрима највишег нивоа:

Параметар	Тип	Обавезно	Опис
`телефонски број`	стринг	Да	Број телефона примаоца у међународном формату (нпр. `380501234567`).
`ознака`	стринг	Да	Регистровано име пошиљаоца / алфа име.
`канали`	низ	Да	Листа канала које треба испробати, по приоритету. Подржане вредности: `вибер`, `смс`, `пусх`. Нпр., `["вибер", "смс"]`.
`цханнел_оптионс`	објекат	Да	Мапа која садржи опције за сваки активни канал (погледајте доле).
`ектра_ид`	стринг	Не	Ваш интерни ИД поруке на страни клијента.
`цаллбацк_урл`	стринг	Не	УРЛ крајње тачке на вашем систему за примање повратних позива статуса испоруке.
`код_поделе`	стринг	Не	Опциони идентификатор кода поделе (подразумевано је `главни`).

Подешавања опција канала

Објекат цханнел_оптионс садржи конфигурације специфичне за канал.

Користи се када је вибер наведен у низу цханнелс.

Параметар	Тип	Обавезно	Опис
`текст`	стринг	Да	Текст тела поруке.
`ттл`	цео број	Да	Време за живот у секундама.
`имг`	стринг	Не	Јавни ХТТПС УРЛ слике за приказ.
`цаптион`	стринг	Не	Ознака текста дугмета.
`акција`	стринг	Не	Одредишна УРЛ адреса када се кликне на дугме.
`опције_анкете`	низ	Не	Низ низова (2 до 5 ставки) за приказ као опције анкете.
`цароусел_итемс`	низ	Не	Низ објеката слајда за приказ као Вибер вртешка (погледајте структуру на картици).

Пример Вибер захтева:

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Hello from SMSBAT!",
      "ttl": 60,
      "img": "https://www.example.com/image.png",
      "caption": "Open",
      "action": "https://www.example.com"
    }
  }
}

Омогућава Вибер размену порука са аутоматским резервним СМС-ом ако Вибер испорука не успе у оквиру ТТЛ-а.

Пример резервног захтева:

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber", "sms"],
  "channel_options": {
    "viber": {
      "text": "Your order is ready!",
      "ttl": 60,
      "caption": "Details",
      "action": "https://www.example.com/order"
    },
    "sms": {
      "text": "Your order is ready: https://www.example.com/order",
      "alpha_name": "MySender",
      "ttl": 60,
      "ctr": false
    }
  }
}

Користи се када је смс наведен у низу канала.

Параметар	Тип	Обавезно	Опис
`текст`	стринг	Да	Текст тела поруке.
`алпха_наме`	стринг	Да	Алфа име пошиљаоца.
`ттл`	цео број	Да	Време за живот у секундама.
`цтр`	боолеан	Не	Омогућите праћење кликова на стопи учесталости кликова на линковима у тексту (`тачно`/`нетачно`).

Пример СМС захтева:

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["sms"],
  "channel_options": {
    "sms": {
      "text": "Your verification code is 1234",
      "alpha_name": "MySender",
      "ttl": 60,
      "ctr": false
    }
  }
}

Користи се за прављење Вибер анкета и анкета.

Warning

Конфигурација Вибер анкете мора да има између 2 и 5 опција унутар сурвеи_оптионс.

Пример захтева за анкетирање:

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Please rate our service:",
      "ttl": 60,
      "survey_options": [
        "Excellent",
        "Good",
        "Bad"
      ]
    }
  }
}

Користи се за слање слајд картица са сликама које се могу превући. Сваки слајд подржава слику, наслов и дугмад.

Пример захтева за вртешку:

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["viber"],
  "channel_options": {
    "viber": {
      "text": "Choose an offer",
      "ttl": 60,
      "carousel_items": [
        {
          "title": "Offer 1",
          "image_url": "https://www.example.com/offer-1.png",
          "primary_label": "Open",
          "primary_url": "https://www.example.com/offer-1",
          "secondary_label": "More",
          "secondary_url": "https://www.example.com/offers"
        },
        {
          "title": "Offer 2",
          "image_url": "https://www.example.com/offer-2.png",
          "primary_label": "Open",
          "primary_url": "https://www.example.com/offer-2"
        }
      ]
    }
  }
}

Користи се када је пусх наведен у низу цханнелс.

Параметар	Тип	Обавезно	Опис
`титле`	стринг	Да	Текст наслова пусх обавештења.
`текст`	стринг	Да	Текст тела поруке.
`ттл`	цео број	Да	Време за живот у секундама.
`имг`	стринг	Не	Јавни ХТТПС УРЛ слике за приказ.
`цаптион`	стринг	Не	Ознака текста дугмета.
`акција`	стринг	Не	Одредишна УРЛ адреса када се кликне на дугме.
`цтр`	боолеан	Не	Омогућите праћење кликова.

Пример пусх захтева:

{
  "phone_number": "380501234567",
  "tag": "MySender",
  "channels": ["push"],
  "channel_options": {
    "push": {
      "title": "Order update",
      "text": "Your order is ready for pickup!",
      "ttl": 60,
      "img": "https://www.example.com/push.png",
      "caption": "Open",
      "action": "https://www.example.com/order",
      "ctr": false
    }
  }
}

Формат одговора

Крајња тачка враћа одговоре у ЈСОН формату са статусним кодом „ХТТП 200 ОК“.

Успешан одговор

{
  "MessageId": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
  "ErrorCode": null,
  "ErrorText": null
}

Одговори на грешке

Ако валидација или обрада не успе, биће враћен одговор на грешку са ЕррорЦоде који није нулти и детаљним ЕррорТект.

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 10221,
  "ErrorText": "This type of Message is not supported by the system"
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 10221,
  "ErrorText": "There can be from 2 to 5 survey options."
}

{
  "MessageId": "00000000-0000-0000-0000-000000000000",
  "ErrorCode": 400,
  "ErrorText": "Cannot send to international number: alpha name 'ALPHA' is not registered."
}

=== „Интерна грешка у обради“ json { "MessageId": "00000000-0000-0000-0000-000000000000", "ErrorCode": 500, "ErrorText": "Internal server error." }

Формат за испоруку повратног позива

Ако је цаллбацк_урл наведен у захтеву, СМСБАТ шаље ажурирања статуса испоруке као ЈСОН ПОСТ корисни терет вашој крајњој тачки.

Пример захтева за повратни позив

POST /your-callback-endpoint HTTP/1.1
Host: yoursystem.com
Content-Type: application/json

{
  "number": "380501234567",
  "time": 1719237600000,
  "status": 2,
  "substatus": 23,
  "hyber_status": 23033,
  "message_id": "6f0d5e28-7f3a-4df3-91a2-3d58d9e09b9a",
  "extra_id": "ORDER-12345",
  "sent_via": "viber",
  "matching_template_id": 0
}

Опис поља повратног позива

Поље	Тип	Опис
`број`	стринг	Број телефона примаоца.
`време`	број	Временска ознака догађаја у Уник милисекундама.
`статус`	број	Поједностављени идентификатор статуса (погледајте табелу статусних кодова).
`подстатус`	број	Детаљан идентификатор статуса (погледајте табелу кодова подстатуса).
`хибер_статус`	број	Детаљан СМСБАТ интерни статусни код (погледајте табелу Хибер статуса).
`мессаге_ид`	стринг	ИД СМСБАТ поруке (ГУИД) генерисан при слању.
`ектра_ид`	стринг	ИД на страни клијента наведен у оригиналном захтеву.
`сент_виа`	стринг	Канал који је обрадио поруку: `вибер`, `смс` или `рцс`.
`матцхинг_темплате_ид`	број	Статус подударања Вибер шаблона (где је применљиво).

Мапирања статуса

1. Поједностављени статус (`статус`)

Код	Значење
`1`	Порука је прихваћена или се испоручује.
`2`	Порука испоручена.
`3`	Грешка у обради или испоруци.

2. Детаљан статус (`подстатус`)

Код	Значење
`12`	Прихваћено на обраду.
`23`	Испоручено.
`24`	Видели/прочитали.
`35`	Није испоручено унутар ТТЛ-а (истекао).
`36`	Грешка у испоруци.

3. Тип канала (`сент_виа`)

Канал	Опис
`вибер`	Статус произведен од Вибер канала.
`смс`	Статус произведен путем СМС канала.
`рцс`	Статус произведен од стране РЦС канала.

4. Детаљан СМСБАТ статус (`хибер_статус`)

Код	Канал	Статус	Субстатус	Значење
23033	`вибер`	`2`	`23`	Вибер порука је испоручена.
24013	`вибер`	`2`	`24`	Вибер порука коју је прочитао прималац (Виђено).
36013	`вибер`	`3`	`36`	Интерна грешка Вибера.
36023	`вибер`	`3`	`36`	Неважећи или недоступни ИД услуге Вибер.
36033	`вибер`	`3`	`36`	Неважећи подаци о корисном учитавању Вибера.
36037	`вибер`	`3`	`36`	УРЛ Вибер слике је предугачак.
36038	`вибер`	`3`	`36`	Неважећи УРЛ Вибер слике.
36039	`вибер`	`3`	`36`	Вибер текст је предугачак.
36044	`вибер`	`3`	`36`	Празан Вибер текст.
36053	`вибер`	`3`	`36`	Неподржани тип Вибер поруке.
36063	`вибер`	`3`	`36`	Неважећи Вибер параметри.
36073	`вибер`	`3`	`36`	Временско ограничење Вибер провајдера.
36083	`вибер`	`3`	`36`	Вибер пошиљалац је блокирао прималац.
36093	`вибер`	`3`	`36`	Прималац није регистрован као Вибер корисник.
36103	`вибер`	`3`	`36`	Није пронађен ниједан Андроид/иОС уређај са подршком за Вибер.
36113	`вибер`	`3`	`36`	Неовлашћена ИП адреса за слање путем Вибера.
36123	`вибер`	`3`	`36`	Откривена је дуплирана Вибер порука.
36143	`вибер`	`3`	`36`	Вибер грешка у наплати.
36153	`вибер`	`3`	`36`	Порука блокирана црном листом платформе.
36163	`вибер`	`3`	`36`	Грешка интерне обраде Вибер платформе.
36173	`вибер`	`3`	`36`	Вибер ознака је погрешна или недостаје.
36183	`вибер`	`3`	`36`	Неважећа Вибер ТТЛ вредност.
12011	`смс` / `рцс`	`1`	`12`	СМС/РЦС прихваћен.
36011	`смс` / `рцс`	`1`	`12`	СМС/РЦС на путу.
23011	`смс` / `рцс`	`2`	`23`	СМС/РЦС испоручен.
35015	`смс` / `рцс`	`3`	`35`	СМС/РЦС је истекао (није испоручен унутар ТТЛ).
36021	`смс` / `рцс`	`3`	`36`	СМС/РЦС порука је избрисана.
36031	`смс` / `рцс`	`3`	`36`	СМС/РЦС се не може испоручити.
36041	`смс` / `рцс`	`3`	`36`	Непознат статус испоруке СМС/РЦС.
36051	`смс` / `рцс`	`3`	`36`	СМС/РЦС порука је одбијена.

Search Results

Компатибилност ГМС АПИ-ја

Подешавања везе

Параметри захтева

Подешавања опција канала

Формат одговора

Успешан одговор

Одговори на грешке

Формат за испоруку повратног позива

Пример захтева за повратни позив

Опис поља повратног позива

Мапирања статуса

1. Поједностављени статус (статус)

2. Детаљан статус (подстатус)

3. Тип канала (сент_виа)

4. Детаљан СМСБАТ статус (хибер_статус)

1. Поједностављени статус (`статус`)

2. Детаљан статус (`подстатус`)

3. Тип канала (`сент_виа`)

4. Детаљан СМСБАТ статус (`хибер_статус`)