Мессагио АПИ компатибилност
СМСБАТ подржава слој компатибилности са Мессагио АПИ. Ово вам омогућава да мигрирате постојеће Вибер интеграције дизајниране за Мессагио директно у СМСБАТ без потребе да преписујете своју структуру корисног оптерећења или мењате логику интеграције.
Подешавања везе
Да бисте усмерили захтеве преко СМСБАТ-а, ажурирајте основни УРЛ и акредитиве за аутентификацију у својој интеграцији:
- Основни УРЛ:
хттпс://рестапи.смсбат.цом - Крајња тачка:
ПОСТ /апи/СендМессаге - Формат захтева:
апплицатион/к-ввв-форм-урленцодед(Подаци обрасца)
Аутентификација и акредитиви
Захтеви се потврђују коришћењем параметара који се шаљу директно унутар података обрасца тела захтева:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
корисник |
стринг | Да | Ваш СМСБАТ налог за пријаву или идентификатор корисника. |
знак |
стринг | Да | АПИ тајна или потпис регистрован за име пошиљаоца. |
од |
стринг | Да | Алфа име регистрованог пошиљаоца. |
метод_слања |
стринг | Да | Врста канала. Користите вибер за обичне Вибер пословне поруке или вибер_отп за Вибер ОТП шаблоне. |
телефон |
стринг | Да | Број телефона примаоца у међународном формату (нпр. 380501234567). |
Типови Вибер порука
Изаберите картицу у наставку да бисте видели специфичне параметре и затражили корисно оптерећење за различите структуре Вибер порука:
Шаље једноставну текстуалну поруку.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
ткт |
стринг | Да | Текст поруке. |
Затражите пример терета: ЦОДЕ_БЛОЦК_0
Шаље текстуалну поруку са интерактивним дугметом за позив на акцију.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
ткт |
стринг | Да | Текст поруке. |
буттон_тект |
стринг | Да | Текст приказан на дугмету. |
буттон_линк |
стринг | Да | Одредишна УРЛ адреса када се кликне на дугме. |
Затражите пример терета: ЦОДЕ_БЛОЦК_1
Шаље јавну датотеку слике.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
слика_линк |
стринг | Да | Јавни ХТТПС УРЛ слике. |
ткт |
стринг | Не | Опциони текст наслова за приказ испод слике. |
Затражите пример терета: ЦОДЕ_БЛОЦК_2
Шаље обогаћену картицу која садржи текст, слику и дугме.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
ткт |
стринг | Да | Текст натписа. |
слика_линк |
стринг | Да | Јавни ХТТПС УРЛ слике. |
буттон_тект |
стринг | Да | Текст приказан на дугмету. |
буттон_линк |
стринг | Да | Одредишна УРЛ адреса када се кликне на дугме. |
Затражите пример терета: ЦОДЕ_БЛОЦК_3
Шаље видео датотеку са опционалним текстуалним насловом и дугмадима за радњу.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
видео.урл |
стринг | Да | Јавни ХТТПС УРЛ видео датотеке. |
видео.тхумбнаил |
стринг | Да | Јавни ХТТПС УРЛ слике за преглед видеа. |
видео.сизе_мб |
цео број | Да | Приближна величина видео датотеке у мегабајтима. |
видео.дуратион_сец |
цео број | Да | Трајање видеа у секундама. |
ткт |
стринг | Не | Опциони текст описа. |
буттон_тект |
стринг | Не | Опциони текст дугмета (може да служи као наслов или веза). |
буттон_линк |
стринг | Не | УРЛ опционалне везе са дугметом. |
Затражите пример терета: ЦОДЕ_БЛОЦК_4
Шаље Вибер једнократне лозинке (ОТП) користећи унапред одобрени шаблон.
Напомена
Када шаљете ОТП поруке, морате да подесите сендинг_метход на вибер_отп.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
| :--- | :--- | :--- | :--- |
| `темплате.ид` | стринг | **Да** | Унапред одобрен ИД шаблона Вибер ОТП. |
| `темплате.ланг` | стринг | **Да** | Код језика шаблона (нпр. `ен`, `ук`). |
| `темплате.парамс.пин` | стринг | **Да** | ОТП вредност пина за убацивање у шаблон. |
| `темплате.парамс.бусинесс_платформ_наме` | стринг | **Да** | Чувар места за назив предузећа у шаблону. |
| `темплате.парамс.цоде_валидити_тиме` | стринг | **Да** | Период важења ПИН-а у минутима. |
**Затражите пример терета:**
__ЦОДЕ_БЛОЦК_5__
Шаље интерактивну картицу са поруком која садржи више слајдова (картица) кроз које корисник може да превуче.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
ткт |
стринг | Да | Текст наслова вртешке. |
вртуљак[Н].наслов |
стринг | Да | Наслов картице Н (почев од 0). |
вртешка[Н].урл_слике |
стринг | Да | УРЛ јавне ХТТПС слике картице „Н“. |
вртешка[Н].примарна_ознака |
стринг | Да | Наслов главног дугмета картице Н. |
вртуљак[Н].примари_урл |
стринг | Да | УРЛ линка главног дугмета картице Н. |
вртешка[Н].секундарна_ознака |
стринг | Не | Наслов секундарног дугмета картице „Н“. |
вртуљак[Н].секундарни_урл |
стринг | Не | УРЛ везе секундарног дугмета картице „Н“. |
Затражите пример терета: ЦОДЕ_БЛОЦК_6
Шаље поруку која садржи интерактивну анкету или анкетно питање.
Додатни параметри:
| Параметар | Тип | Обавезно | Опис |
|---|---|---|---|
ткт |
стринг | Да | Текст анкетног питања. |
опције_анкете[Н] |
стринг | Да | Текст опције анкете за ставку Н (индекс почиње од 0). Потребне су најмање 2 опције. |
тип_опције |
цео број | Да | Тип селектора: 1 (радио дугмад) или 2 (обична дугмад). |
Затражите пример терета: ЦОДЕ_БЛОЦК_7
Формат одговора
Крајња тачка компатибилности Мессагио АПИ-ја враћа одговоре у КСМЛ формату са статусним кодом „ХТТП 200 ОК“.
Прихваћен (успешан) одговор
ЦОДЕ_БЛОЦК_8
Одговори на грешке
Ако провера параметара захтева не успе или аутентификација не успе, одговор ће вратити код који није нула.
ЦОДЕ_БЛОЦК_9
ЦОДЕ_БЛОЦК_10
Повратни позиви
УРЛ-ови повратног позива морају бити имплементирани и хостовани на вашој платформи. СМСБАТ шаље ХТТП повратне позиве да ажурира ваш систем у вези са догађајима испоруке, одговорима на анкете и одговорима корисника.
1. Повратни позив статуса испоруке
Шаље се када порука промени статус (испоручена, прочитана, неуспела).
- Тип садржаја:
апплицатион/к-ввв-форм-урленцодед - Метод:
ПОСТ
Затражите формате терета:
- Достављено: ЦОДЕ_БЛОЦК_11
- Виђено/прочитано: ЦОДЕ_БЛОЦК_12
- Неиспоручено/неуспешно: ЦОДЕ_БЛОЦК_13
Опис поља:
мсг_ид: СМСБАТ јединствени ИД поруке (ГУИД) враћен у одговору СендМессаге. –статус: исход испоруке (испоручено,неиспорученоилинепознат статус).тип: Подесите навиђенкада је прималац прегледао поруку.статус_ектендед: Специфичан технички разлог за неиспоручено стање (нпр.ВИБЕР_ЕКСПИРЕД,ВИБЕР_БЛОЦКЕД_БИ_УСЕР,ВИБЕР_УСЕР_НОТ_ФОУНД,ВИБЕР_НО_ДЕВИЦЕ).
2. Анкета Одговори Повратни позив
Покреће се када корисник изабере опцију одговора у поруци Вибер анкете.
- Тип садржаја:
апплицатион/к-ввв-форм-урленцодед - Метод:
ПОСТ
Формат захтеваног терета: ЦОДЕ_БЛОЦК_14
3. Повратни позив долазне корисничке поруке
Покреће се када корисник пошаље текстуални или медијски одговор назад вашој Вибер Бусинесс услузи.
- Тип садржаја:
апплицатион/јсон - Метод:
ПОСТ
Формат захтеваног терета: ЦОДЕ_БЛОЦК_15
Опис поља:
мсг_ид: Јединствени ИД поруке генерисан за долазни одговор.текст: Текстуални садржај који је послао корисник (може битинуллако је послао само медије).медији: Директна УРЛ адреса за преузимање свих медијских прилога које је корисник послао (може битинуллако је само текст).телефон: телефонски број пошиљаоца у међународном формату.сендер_бм_ид: Вибер Бусинесс ИД пошиљаоца.