СМСБАТ РЕСТфул АПИ водич

Комплетан водич за СМСБАТ РЕСТфул АПИ – све што треба да знате.

_Последње ажурирање: 29. августа 2025.

СМСБАТ РЕСТфул АПИ вам омогућава да шаљете различите типове порука: Вибер-карусел, Вибер-анкета, Вибер-промо (слике, видео), Вибер пословна ћаскања, ОТП поруке (Вибер ОТП, Фласх Цалл) и њихове резервне варијанте.

Напомена: Ово је обједињени ХТТП АПИ за одлазне поруке. Ако су вам потребне интеграције са улазним ботовима (Вибер Бот / Телеграм Бот), погледајте Цасцаде АПИ.

1. Протокол

Протокол: ХТТПС
Тело захтева: ЈСОН објекат који садржи низ порука.
Методе:
ГЕТ за преузимање података (статус поруке, стање, итд.)
ПОСТ за креирање објеката (нпр. покретање емитовања/отпремања)
ПАТЦХ за измену објеката

2. Ауторизација

Нудимо неколико метода ауторизације за вашу удобност: - ХТТП Басиц Аутхентицатион (пријава и лозинка са ваше контролне табле). – Прилагођено ХТТП заглавље „Кс-Аутхоризатион-Кеи“ које садржи АПИ токен. – Поље лозинке за ХТТП Басиц Аутхентицатион садржи АПИ токен (проследите @ као пријаву).

АПИ токен може да се генерише на контролној табли под Кориснички профил.

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

Са основном ауторизацијом: ЦОДЕ_БЛОЦК_0

Са Кс-Аутхоризатион-Кеи: ЦОДЕ_БЛОЦК_1

3. Слање порука

У СМСБАТ платформи, свако слање поруке (чак и једна порука) сматра се „Емитовањем“ (листом порука).

Крајња тачка - Метод: ПОСТ - УРЛ: хттпс://апи.смсбат.цом/бат/мессагелист - Заглавља: Тип садржаја: апликација/јсон

Основна структура корисног оптерећења: ЦОДЕ_БЛОЦК_2

Обавезна поља за сваки објекат поруке:

од: Алфа-име верификованог пошиљаоца.
до: Број телефона примаоца (формат Е.164).
типе: енум типа поруке.
текст: Главни текст поруке (опционо ако тип не захтева текст).

Подржане вредности типе: - смс - вибер_сервице (или вибер_транс) - вибер_промо - вибер_цароусел - вибер_сурвеи - вибер_отп - вибер_сессион - фласхцалл_цаллбацк - фласхцалл

Опциона заједничка поља:

цустомерМессагеИд: ИД стринга унутар вашег система (користи се за праћење повратних позива). Мора бити јединствен по поруци.
дтСенд: ИСО8601 Датум/Време планираног будућег слања.
дтЕкпире: ИСО8601 Датум/Време рока испоруке.
ттл: Време за живот у секундама. (Ако дтЕкпире није обезбеђен, АПИ израчунава мапирање подразумеваних вредности из типе).

Подразумевани ТТЛ (секунде):

смс - 86400 (24х)
вибер_транс / вибер_сервице - 345600
вибер_промо - 604800
вибер_сессион - 604800

4. Резервно рутирање (каскадно)

Можете да наведете резервни ред да бисте обезбедили испоруку поруке ако примарни канал не успе или истекне.

ЦОДЕ_БЛОЦК_3 Замена се активира када добављач одбије главну поруку или када ТТЛ истекне.

5. Преглед типова порука и података о порукама

Сложени типови порука захтевају додатне конфигурације које се убацују у својство мессагеДата.

5.1 Вибер Промо (`вибер_промо`)

Само слика ЦОДЕ_БЛОЦК_4

Текст + дугме ЦОДЕ_БЛОЦК_5

Слика + Текст + Дугме Комбинује имг, буттонТект и буттонАцтион.

Појашњење видео записа: ЦОДЕ_БЛОЦК_6 (Можете и комбиновати својства видеа са буттонТект и буттонАцтион).

5.2 Вибер трансакција / услуга (`вибер_транс`, `вибер_сервице`)

Ако имате одобрен шаблон који садржи приложену датотеку: ЦОДЕ_БЛОЦК_7

5.3 Вибер вртешка (`вибер_цароусел`)

Захтева низ цароусел.итемс унутар мессагеДата.

Ограничења: - Дужина предмета: између 2 и 5 ставки - Наслов: 2 до 38 знакова - имагеУрл: ЈПЕГ/ПНГ препоручена величина 215к185

ЦОДЕ_БЛОЦК_8

5.4 Вибер анкета / листа (`вибер_сурвеи`)

Креира интерактивну анкету у оквиру приказа ћаскања. ЦОДЕ_БЛОЦК_9 Својство тект поруке служи као наслов анкете (максимално 85 знакова). Можете пренети између 2 и 5 опција, од којих свака има највише 50 знакова.

5.5 Вибер ОТП (`вибер_отп`)

Користи унапред регистроване локализоване Вибер шаблоне глобално. ЦОДЕ_БЛОЦК_10 Параметри шаблона (пин, бусинесс_платформ_наме) су стриктно осетљиви на велика и мала слова. АПИ подржава различите варијанте језика ИСО кода (ЕН, ЕС, РУ, ТР, УК, итд.).

5.6 Фласх позив (`фласхцалл`)

Последње цифре броја за бирање (генерисани код) морају бити прослеђене преко параметра тект. Ако је текст изостављен, код је насумичан и морате га издвојити из АПИ-јевог синхроног тела одговора 200 ОК (мессагес/тект).

ЦОДЕ_БЛОЦК_11