Входящий веб‑хук
Веб-хуком (webhook) называется функционал для оповещения одной системы о событиях в другой системе. Самый простой пример: уведомление вашего сайта (или CRM) от платежной системы о полученной оплате.
Примеры использования
- Клиент регистрируется на сайте, делает заказ, оплачивает — на каждое действие можно настроить веб-хук, отправляющий SMS клиенту с данными регистрации, заказа или оплаты.
- Изменился статус заказа на сайте — клиенту отправляется SMS с актуальной информацией по заказу.
Настройка веб-хука
Технически это реализуется с помощью «HTTP-запроса» (аналог перехода по ссылке или заполнения формы, только выполненный программно).
URL для запроса — https://api.sms4b.ru/webHooks/SendSms.php
Тип запроса — POST
Заголовок запроса — Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Параметр
ТИП, значение
login
Строка, логин ЛК на сайте
password
Строка, пароль ЛК на сайте
name
Строка, символьное или цифровое имя отправителя
phone
Строка, номер телефона
text
Строка, текст SMS
Ответ (формат JSON)
Код ответа
Тело ответа
Значение
200
[]
Сообщение отправлено
400
'errors' => [
['title' => 'Не указана переменная name'],
['title' => 'Не указана переменная password’]
]
['title' => 'Не указана переменная name'],
['title' => 'Не указана переменная password’]
]
Сообщение не отправлено, ошибки в передаваемых параметрах
409
'errors' => [
['title' => ‘Неверно указан номер телефона'],
['title' => 'Символьное имя не принадлежит аккаунту’]
]
['title' => ‘Неверно указан номер телефона'],
['title' => 'Символьное имя не принадлежит аккаунту’]
]
Сообщение не отправлено, есть конфликты
500
'errors' => [
'title' => 'Не удалось обработать запрос',
'detail' => 'Сервер не смог обработать запрос. Обратитесь в техподдержку на сайте https://www.sms4b.ru/office/support/'
]
'title' => 'Не удалось обработать запрос',
'detail' => 'Сервер не смог обработать запрос. Обратитесь в техподдержку на сайте https://www.sms4b.ru/office/support/'
]
Сообщение не отправлено, сервер не смог обработать запрос