Просмотр исходного текста страницы API для отправки sms

{{#seo:
|title=API для отправки sms
|titlemode=append
|keywords=планфикс, смс, sms, апи, api
|description=API для отправки sms
}}

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

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

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


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

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


https://pic.planfix.ru/pf/tC/lJTfYi.jpg


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


https://pic.planfix.ru/pf/UJ/9BuerN.jpg


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


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

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

'''Параметры запроса:'''
{| class="wikitable" style="margin-top: 1em; width:100% "
!width="150"|Имя !!width="50%"| Описание !!width="150"| Тип/формат данных !! Примечание 
|-
|login || логин, указанный в параметрах интеграции || string || 
|-
|password || пароль, указанный в параметрах интеграции || string || 
|-
|from || имя отправителя || string || 
|-
|to || номер телефона, на который отправляется sms || string || 
|-
|text || текст сообщения || string || 
|-
|}


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

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

'''Параметры запроса:'''
{| class="wikitable" style="margin-top: 1em; width:100% "
!width="150"|Имя !!width="50%"| Описание !!width="150"| Тип/формат данных !! Примечание 
|-
|key || API Key, указанный в параметрах интеграции || string || 
|-
|from || имя отправителя || string || 
|-
|to || номер телефона, на который отправляется sms || string || 
|-
|text || текст сообщения || string || 
|-
|}


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

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


https://pic.planfix.ru/pf/iz/ZX8fI4.jpg


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


https://pic.planfix.ru/pf/wN/HfOTCB.jpg


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


https://pic.planfix.ru/pf/SK/QjHbjO.jpg


== Перейти ==
*[[Разработчикам: API]]