API для отправки sms

Материал из Planfix
Версия от 14:11, 3 февраля 2022; Blin (обсуждение | вклад)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
Перейти к: навигация, поиск

Общие сведения об API

Данное API предназначено для владельцев сервисов рассылки SMS и позволяет подключить ваш сервис отправки SMS, если он отсутствует в списке доступных для интеграции и отправлять SMS-сообщения из ПланФикса через него.

После реализации интеграции вы можете обратиться в нашу Службу поддержки по вопросу добавления вашего сервиса в список интеграций, доступных пользователям в интерфейсе ПланФикса.

Взаимодействие производится по протоколу HTTPS. ПланФикс посылает запросы на указанный в настройках интеграции адрес сервиса.


Подключение в интерфейсе ПланФикса

Для подключения и настройки интеграции перейдите в раздел Управление аккаунтом / Интеграции / Интеграция с сервисами отправки SMS.


zKxQeK.png


В открывшемся разделе выберите находящиеся в конце списка API ПланФикса (по логину и паролю) или API ПланФикса (по ключу доступа) - в зависимости от способа, каким будет производится авторизация запроса клиента в вашем сервисе.


Aha5Jt.png


Откроется окно настроек интеграции.


Xi0SvG.png


В нём надо будет указать адрес, куда ПланФикс будет слать запросы, логин и пароль клиента и имя отправителя SMS (для случая авторизации по ключу доступа - API Key вместо логина и пароля)


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

Запрос передаётся методом POST в application/x-www-form-urlencoded формате на адрес указанный в параметрах интеграции.

Параметры запроса:

Имя Описание Тип/формат данных Примечание
login логин, указанный в параметрах интеграции string
password пароль, указанный в параметрах интеграции string
from имя отправителя string
to номер телефона, на который отправляется sms string
text текст сообщения string


Формат запроса на отправку смс при авторизации по ключу доступа

Запрос передаётся методом POST в application/x-www-form-urlencoded формате на адрес указанный в параметрах интеграции.

Параметры запроса:

Имя Описание Тип/формат данных Примечание
key API Key, указанный в параметрах интеграции string
from имя отправителя string
to номер телефона, на который отправляется sms string
text текст сообщения string


Тестирование интеграции

Для теста работы интеграции зайдите в настройки интеграции, заполните все данные и нажмите на иконку колбы:


bYlzjT.png


В открывшемся блоке введите номер телефона и текст сообщения и нажмите Протестировать


DbJpnE.png


ПланФикс при этом сделает вызов отправки смс. Полученный ответ или ошибка будут выведены на экран.


RhVqTg.png


Перейти