Help Center Мессагио АПИ компатибилност

Мессагио АПИ компатибилност

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

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

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

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

Аутентификација и акредитиви

Захтеви се потврђују коришћењем параметара који се шаљу директно унутар података обрасца тела захтева:

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

Типови Вибер порука

Изаберите картицу у наставку да бисте видели специфичне параметре и затражили корисно оптерећење за различите структуре Вибер порука:

Шаље једноставну текстуалну поруку.

Додатни параметри:

Параметар	Тип	Обавезно	Опис
`ткт`	стринг	Да	Текст поруке.

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hello+from+SMSBAT%21

Шаље текстуалну поруку са интерактивним дугметом за позив на акцију.

Додатни параметри:

Параметар	Тип	Обавезно	Опис
`ткт`	стринг	Да	Текст поруке.
`буттон_тект`	стринг	Да	Текст приказан на дугмету.
`буттон_линк`	стринг	Да	Одредишна УРЛ адреса када се кликне на дугме.

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Check+our+latest+offers%21&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

Шаље јавну датотеку слике.

Додатни параметри:

Параметар	Тип	Обавезно	Опис
`слика_линк`	стринг	Да	Јавни ХТТПС УРЛ слике.
`ткт`	стринг	Не	Опциони текст наслова за приказ испод слике.

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png

Шаље обогаћену картицу која садржи текст, слику и дугме.

Додатни параметри:

Параметар	Тип	Обавезно	Опис
`ткт`	стринг	Да	Текст натписа.
`слика_линк`	стринг	Да	Јавни ХТТПС УРЛ слике.
`буттон_тект`	стринг	Да	Текст приказан на дугмету.
`буттон_линк`	стринг	Да	Одредишна УРЛ адреса када се кликне на дугме.

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hot+deals+inside%21&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

Шаље видео датотеку са опционалним текстуалним насловом и дугмадима за радњу.

Додатни параметри:

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

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Watch+this+tutorial%21&video.url=https%3A%2F%2Fwww.example.com%2Fvideo.mp4&video.thumbnail=https%3A%2F%2Fwww.example.com%2Fvideo-thumbnail.png&video.size_mb=1&video.duration_sec=3&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

Додатни параметри:

| Параметар | Тип | Обавезно | Опис |
| :--- | :--- | :--- | :--- |
| `темплате.ид` | стринг | **Да** | Унапред одобрен ИД шаблона Вибер ОТП. |
| `темплате.ланг` | стринг | **Да** | Код језика шаблона (нпр. `ен`, `ук`). |
| `темплате.парамс.пин` | стринг | **Да** | ОТП вредност пина за убацивање у шаблон. |
| `темплате.парамс.бусинесс_платформ_наме` | стринг | **Да** | Чувар места за назив предузећа у шаблону. |
| `темплате.парамс.цоде_валидити_тиме` | стринг | **Да** | Период важења ПИН-а у минутима. |

**Затражите пример терета:**
```http
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber_otp&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&template.id=otp_template_123&template.lang=en&template.params.pin=123456&template.params.business_platform_name=SMSBAT&template.params.code_validity_time=7
```

Шаље интерактивну картицу са поруком која садржи више слајдова (картица) кроз које корисник може да превуче.

Додатни параметри:

Параметар	Тип	Обавезно	Опис
`ткт`	стринг	Да	Текст наслова вртешке.
`вртуљак[Н].наслов`	стринг	Да	Наслов картице `Н` (почев од 0).
`вртешка[Н].урл_слике`	стринг	Да	УРЛ јавне ХТТПС слике картице „Н“.
`вртешка[Н].примарна_ознака`	стринг	Да	Наслов главног дугмета картице `Н`.
`вртуљак[Н].примари_урл`	стринг	Да	УРЛ линка главног дугмета картице `Н`.
`вртешка[Н].секундарна_ознака`	стринг	Не	Наслов секундарног дугмета картице „Н“.
`вртуљак[Н].секундарни_урл`	стринг	Не	УРЛ везе секундарног дугмета картице „Н“.

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Top+picks+for+you&carousel%5B0%5D.title=First+Offer&carousel%5B0%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-1.png&carousel%5B0%5D.primary_label=Open&carousel%5B0%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-1&carousel%5B0%5D.secondary_label=Details&carousel%5B0%5D.secondary_url=https%3A%2F%2Fwww.example.com%2Fitem-1%2Fdetails&carousel%5B1%5D.title=Second+Offer&carousel%5B1%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-2.png&carousel%5B1%5D.primary_label=Open&carousel%5B1%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-2

Шаље поруку која садржи интерактивну анкету или анкетно питање.

Додатни параметри:

Параметар	Тип	Обавезно	Опис
`ткт`	стринг	Да	Текст анкетног питања.
`опције_анкете[Н]`	стринг	Да	Текст опције анкете за ставку `Н` (индекс почиње од 0). Потребне су најмање 2 опције.
`тип_опције`	цео број	Да	Тип селектора: `1` (радио дугмад) или `2` (обична дугмад).

Затражите пример терета:

POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded

sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Please+rate+our+service&survey_options%5B0%5D=Excellent&survey_options%5B1%5D=Good&survey_options%5B2%5D=Average&option_type=1

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

Крајња тачка компатибилности Мессагио АПИ-ја враћа одговоре у КСМЛ формату са статусним кодом „ХТТП 200 ОК“.

Прихваћен (успешан) одговор

<response>
  <code>0</code>
  <tech_message>OK</tech_message>
  <msg_id phone="380501234567">MESSAGE_GUID</msg_id>
</response>

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

Ако провера параметара захтева не успе или аутентификација не успе, одговор ће вратити код који није нула.

<response>
  <code>-1</code>
  <tech_message>PARAM ERROR (sign)</tech_message>
</response>

<response>
  <code>-2</code>
  <tech_message>ERROR(unauthorized)</tech_message>
</response>

Повратни позиви

УРЛ-ови повратног позива морају бити имплементирани и хостовани на вашој платформи. СМСБАТ шаље ХТТП повратне позиве да ажурира ваш систем у вези са догађајима испоруке, одговорима на анкете и одговорима корисника.

1. Повратни позив статуса испоруке

Шаље се када порука промени статус (испоручена, прочитана, неуспела).

Тип садржаја: апплицатион/к-ввв-форм-урленцодед
Метод: ПОСТ

Затражите формате терета:

Достављено:
```
msg_id=MESSAGE_GUID&status=delivered
```

Виђено/прочитано:

msg_id=MESSAGE_GUID&status=delivered&type=seen

Неиспоручено/неуспешно:

msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

Опис поља:

мсг_ид: СМСБАТ јединствени ИД поруке (ГУИД) враћен у одговору СендМессаге. – статус: исход испоруке (испоручено, неиспоручено или непознат статус).
тип: Подесите на виђен када је прималац прегледао поруку.
статус_ектендед: Специфичан технички разлог за неиспоручено стање (нпр. ВИБЕР_ЕКСПИРЕД, ВИБЕР_БЛОЦКЕД_БИ_УСЕР, ВИБЕР_УСЕР_НОТ_ФОУНД, ВИБЕР_НО_ДЕВИЦЕ).

2. Анкета Одговори Повратни позив

Покреће се када корисник изабере опцију одговора у поруци Вибер анкете.

Тип садржаја: апплицатион/к-ввв-форм-урленцодед
Метод: ПОСТ

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

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Повратни позив долазне корисничке поруке

Покреће се када корисник пошаље текстуални или медијски одговор назад вашој Вибер Бусинесс услузи.

Тип садржаја: апплицатион/јсон
Метод: ПОСТ

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

{
  "msg_id": "INBOUND_MESSAGE_GUID",
  "text": "Hello, I have a question",
  "media": "https://example.com/user-attachment.png",
  "phone": "380501234567",
  "sender_bm_id": "12345"
}

Опис поља:

мсг_ид: Јединствени ИД поруке генерисан за долазни одговор.
текст: Текстуални садржај који је послао корисник (може бити нулл ако је послао само медије).
медији: Директна УРЛ адреса за преузимање свих медијских прилога које је корисник послао (може бити нулл ако је само текст).
телефон: телефонски број пошиљаоца у међународном формату.
сендер_бм_ид: Вибер Бусинесс ИД пошиљаоца.

Search Results

Мессагио АПИ компатибилност

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

Аутентификација и акредитиви

Типови Вибер порука

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

Прихваћен (успешан) одговор

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

Повратни позиви

1. Повратни позив статуса испоруке

2. Анкета Одговори Повратни позив

3. Повратни позив долазне корисничке поруке