API Отправки СМС сообщений
Отправка запросов к шлюзу осуществляется методом GET или POST.
Рекомендуется использовать POST запрос.
Для аутентификации запросов к шлюзу используется уникальный API-ключ. Получить API-ключ.
Для использования защищенного SSL соединения, запросы необходимо отправлять по протоколу HTTPS методом POST.
Все запросы производятся на следующий адрес:
По умолчанию ответ сервера происходит в формате JSON. Для выбора другого вида формата ответа используется параметр format
Отправка SMS
Для отправки SMS необходимо передать следующие параметры по адресу шлюза:
Параметр=Значение | Описание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
action=sendsms | Обязательный параметр, указывающий действие по отправке SMS-сообщения. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apikey= | Обязательный параметр. API-ключ в системе. Используется для аутентификации запроса к системе. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
phones= | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message= | Текс SMS сообщения. Максимальный размер – 800 символов. Сообщение при необходимости будет разбито на несколько SMS, отправленных абоненту и оплаченных по отдельности. Размер одного SMS – 160 символов в латинице или 70 символов в кириллице. При разбивке сообщения на несколько SMS в каждую часть добавляется заголовок для объединения частей в одно сообщение на телефоне получателя, и максимальная длина становится 67 для кириллицы и 153 для латинских букв. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sender= | Имя отправителя, отображаемое в телефоне получателя. Разрешены английские буквы, цифры, пробел и некоторые символы. Длина – 11 символов или 15 цифр. Все имена регистрируются в личном кабинете. Динамическое имя включается по запросу. Для отключения Sender ID по умолчанию необходимо в качестве имени передать пустую строку. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> | Идентификатор сообщения. Назначается Клиентом. Служит для дальнейшей идентификации сообщения. Если не указывать, то будет назначен автоматически. Не обязательно уникален. В случае 2-х одинаковых идентификаторов по запросу статуса будет возвращен статус последнего сообщения. Идентификатор представляет собой 32-битное число в диапазоне от 1 до 2147483647. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
translit= |
Параметр | Значение | По умолчанию |
user | Логин для входа в систему на сайте http://web.mirsms.ru |
— |
pass | Пароль для входа в систему на сайте http://web.mirsms.ru |
— |
gzip | none — не использовать Content-encoding: gzip | none |
HTTP_ACCEPT_LANGUAGE | Переменная клиента, предпочтение относительно языка (необязательный параметр). |
— |
CLIENTADR | IP адрес клиента (необязательный параметр) | IP сервера |
comment | Описание подключения (необязательный параметр; до 512 символов) |
— |
2. Отправка сообщения
SMS сообщение
Параметр | Значение | По умолчанию |
action | post_sms | — |
message | текст сообщения | — |
target | Список адресатов через запятую. (Н-р: «+70010001212, 80009990000»). (Разрешается использование только или «target», или «phl_codename») |
— |
phl_codename | Кодовое имя контакт-листа в системе //web.mirsms.ru. (Разрешается использование только или «target» или «phl_codename») |
— |
sender Имя отправителя, зарегистрированного для Вас в системе //web.mirsms.ru. |
Имя отправителя по умолчанию |
|
post_id | пользовательский ID рассылки, необязательный параметр, возвращается обратно в неизменном виде. |
— |
period | Время жизни сообщения в секундах. Необязательный параметр. Максимальное время, в течение которого сообщение должно быть доставлено на телефон. Если в течение этого времени доставка не возможна (например, абонент не в зоне действия сети), сообщение не будет доставлено вовсе. Внимание, данная функция может не работает для некоторых направлений, например для CDMA телефонов. |
— |
sms_type | Тип SMS:
|
Пустое значение |
wap_url | HTTP ссылка с текста сообщения (//. ). Используется только для sms_type = W, то есть Wap push сообщения. |
— |
wap_expires | Дата и время, когда истекает срок доставки Wap push сообщения. (Формат: dd.mm.yyyy hh:ii:ss (дд.мм.гггг чч:ми:сс)) |
— |
3. Получение статусов сообщений асинхронно
Данный вариант позволяет получать статусы сообщений в реальном времени. Для настройки укажите в Личном кабинете > Услуги «URL скрипта для приёма статуса отправленных SMS».Как
только система получает статус сообщения, она немедленно пересылает вам его по HTTP протоколу с помощью POST запроса.
Формат данных:
Параметр | Значение |
ORDID | Номер сообщения (соответствует значению атрибута ID тэга SMS, возвращаемого при отправке сообщения) |
CNRID | ID контрагента |
RESCOUNT | Количество сообщений для тарификации. |
STATUS | Код статуса:
существует и т.д.) |
FINALTIME | время получения финального статуса в UTC |
4. Получение данных и статусов сообщений
Три варианта получения статусов для сообщений:
Параметр | Значение |
sms_id | Номер сообщения (соответствует значению атрибута ID тэга SMS, возращаемого при отправке сообщения) |
sms_group_id | Номер рассылки (соответствует значению атрибута sms_group_id тэга result, возращаемого при отправке сообщений) |
date_from, date_to |
Данные по всем сообщениям за период времени от date_from до date_to. (Формат date_from, date_to: dd.mm.yyyy hh:ii:ss (дд.мм.гггг чч:ми:сс)) |
5. Получение текущего баланса
Параметр | Значение |
action | balance |
6. Получение входящих сообщений
Параметр | Значение | По умолчанию |
action | inbox | — |
sib_num | Номер входящего ящика (Обязательный параметр, соответствует значению «ID ящика» в закладке «Настройки») |
— |
new_only | Статус сообщений:
|
0 |
date_from, date_to |
Данные по всем сообщениям за период времени от date_from до date_to. (Формат date_from, date_to: dd.mm.yyyy hh:ii:ss (дд.мм.гггг чч:ми:сс)) |
Примеры использования протокола
Пример 1. Отправка одного сообщения по адресатам.
Запрос
POST= (
[user] => userX
[pass] => ***
[action] => post_sms
[message] => Привет
[target] => +79999999991, +79999999992, +7999999999999
[post_id] => x124127456
[period] => 600
[CLIENTADR] => 127.0.0.1
[HTTP_ACCEPT_LANGUAGE] => ru-ru,ru;q=0.8,en-us;q=0.5,en;q=0.3
)
Результат XML
Использование PHP-класса
post_message($sms_text, $target, $sender, ‘x124127456’,
$period);
// результат XML
echo $result;
// Отправка SMS по кодовому имени контакт листа
$sms_text=’Привет’;
$phl_codename=’druzya’;
$result=$sms->post_message_phl($sms_text, $phl_codename, $sender,
‘x124127456’, $period);
header(«Content-Type: text/xml; charset=UTF-8»);
// результат XML
echo $result;
?>
Пример 2. Получение данных сообщения >
Запрос
Использование PHP-класса
$r_xml1=$sms->status_sms_id(6666);
// данные о сообщениях отправки SMS_GROUP_ > $r_xml2=$sms->status_sms_group_id(110);
// Получить данные сообщений отправленных с 18.12.2007 00:00:00 по
23.12.2007 23:00:00
$r_xml3=$sms->status_sms_date(‘18.12.2007 00:00:00′,’23.12.2007 23:00:00’);
header(«Content-Type: text/xml; charset=UTF-8»);
echo $r_xml1; // результат XML
//echo $r_xml2;
//echo $r_xml3;
?>
Пример 3. Отправка сообщений и получение статусов
Запрос
POST= (
[data] => Array (
[0] => Array (
[action] => post_sms
[message] => Привет!
[sender] =>
[target] => +79999999999, +79999999992
)
[1] => Array (
[action] => post_sms
[message] => С днём рождения!
[sender] =>
[target] => +79999999991
)
[2] => Array (
[action] => status
[sms_id] => 6666
)
)
[user] => userX
[pass] => ***
[CLIENTADR] => 127.0.0.1
[HTTP_ACCEPT_LANGUAGE] => ru-ru,ru;q=0.8,en-us;q=0.5,en;q=0.3
)
Результат XML
Данные по сообщению:
- SMS_ID — ID сообщения
- SMS_GROUP_ID — ID рассылки сообщений
- SMSTYPE — тип сообщения
- CREATED — дата и время создания сообщения
- AUL_USERNAME — Имя пользователя, создавшего сообщение
- AUL_CLIENT_ADR — IP адрес пользователя, создавшего сообщение
- SMS_SENDER — Имя отправителя сообщения
- SMS_TARGET — Телефон адресата
- SMS_RES_COUNT — Кол-во единиц ресурсов на данное сообщение
- SMS_TEXT — Текст сообщения
- SMSSTC_CODE — Код статуса доставки сообщения
- SMS_STATUS — Текстовое описание статуса доставки сообщения
- SMS_CLOSED — [0,1] 0 — сообщения находится в процессинге, 1 = работа по отправке
сообщения завершена - SMS_SENT — [0,1] 0 — сообщение не отослано, 1 = сообщение отослано успешно
- SMS_CALL_DURATION — Время, в течение которого было установлено соединение для отправки сообщения.
- SMS_DTMF_DIGITS — Что пользователь нажимал в сеансе разговора (для SENDVOICE (в разработке))
- SMS_CLOSE_TIME — Время завершения работы по сообщению.
Использование PHP-класса
start_multipost();
// Отправка смс
$sms->post_message(‘Привет’, ‘+79999999991,+79999999992’, ‘Vasya’);
// Отправка смс
$sms->post_message_phl(‘С днём рождения!’, ‘druzya’, ‘Petya’, ‘x425256’);
// данные о сообщении SMS_ > $sms->status_sms_id(6666);
// данные о сообщениях с SMS_GROUP_ > $sms->status_sms_group_id(110) ;
// . отправить всё одним запросом и получить результат в XML
$r_xml=$sms->process();
header(«Content-Type: text/xml; charset=UTF-8»);
echo $r_xml; // результат XML
?>
Пример 4. Получение баланса.
Запрос
Использование PHP-класса
get_balance();
// результат в XML
header(«Content-Type: text/xml; charset=UTF-8»);
echo $r_xml; // результат XML
?>
Пример 5. Получение входящих сообщений.
Запрос
POST= (
[user] => userX
[pass] => ***
[action] => inbox
[sib_num] => 123
[date_from] => 12.01.2010 00:00:00
[date_to] => 15.01.2010 12:00:00
)
Результат XML
13.01.2010 18:08:29
79670413211
79037672810
1
test 1111
N
14.01.2010 18:03:03
79670413211
79037672810
1
qwerty 22
N
Использование PHP-класса
inbox_sms(1, 134);
// получение только новых входящих смс
// для ящика 134 c 10.01.2010 00:00:00 до 15.01.2010 00:00:00
// $r_xml=$sms->inbox_sms(0,134,’10.01.2010 00:00:00′,’15.01.2010
00:00:00′);
// результат в XML
header(«Content-Type: text/xml; charset=UTF-8»);
echo $r_xml; // результат XML
?>
Обработка ошибок
Метки: http смс, http sms, протокол http отправка sms сообщений;
Получить Индивидуальное предложение
Мы предлагаем клиентам лучшие цены. Заполните заявку и наш менеджер предложит вам лучшую цену на рассылки, исходя из ваших требований. Всем клиентам, заключившим договор, мы дарим подарки!
API для отправки СМС рассылок
Существуют разные способы для подключения нашего SMS сервиса к вашим сайтам или программам. Мы предоставляем доступ к различным функциям через API , которые вы можете использовать для ваших проектов. Этот вид интеграции работает путем простого вызова скрипта с нашего сервера при помощи GET или POST запроса. Взаимодействие для отправки СМС осуществляется по различным протоколам SMPP, XML, JSON . Также имеется PHP класс и модуль для рассылки смс из 1С.
Для чего это ?
- Подключение SMS сервиса в ваше программное обеспечение для отправки смс через API
- Отправка SMS с вашего сайта, например кода для завершения регистрации
- Рассылка SMS клиентам из CRM или ERP системы
- Отправка SMS уведомления о получении заказа в интернет магазине
Какие функции доступны ?
- Отправка смс абоненту
- Смс рассылка группе абонентов (в том числе отложенная)
- Проверка состояния баланса личного кабинета
- Получение информации о номере абонента
- Получение отчета о произведенной рассылке
- Отмена отложенных рассылок
- Получение отчета об всех смс отправленных на номер абонента
- Отправка запроса на имя отправителя
- Добавление контакта в базу
- Создание и редактирование групп контактов
Пример запроса информации о номере абонента
JSON-протокол
Введение
API личного кабинета предоставляет доступ к некоторым функциям личного кабинета, таким как работа с телефонной книгой.
Этот вид интеграции работает посредством простого вызова скрипта с нашего сервера при помощи GET-запроса илиPOST-запроса.
Например, в PHP, это можно сделать так:
Ответ от сервера приходит в виде json-строки
Рассылка СМС
Текст смс должен быть в кодировке utf-8.
К примеру, если у вас скрипты в кодировке windows-1251:
Услуги компании по рассылке СМС API
Отправка СМС API – самый легкий и доступный способ заявить о себе, уведомить своих потенциальных покупателей о скидках и акциях, предупредить о любых изменениях в работе вашего сервиса и многое другое.
Услуги компании по рассылке СМС API
Приоритетным направлением для компании «Prostor Mobile Marketing Agency» является мобильный маркетинг, в том числе и СМС API. Разработчики программного обеспечения давно оценили возможности, которые дает СМС рассылка API. Это максимальный охват целевой потребительской аудитории, экономия времени и минимальные тарифы на рекламу. API СМС дает возможность подключения любых интернет проектов к системе, с которой осуществляется массовая или единичная рассылка сообщений. АPI отправка SMS при помощи нашего сервиса дает неограниченные возможности для привлечения новых потребителей на свой ресурс. Благодаря SMS API ваши клиенты будут своевременно уведомлены о всех нововведениях и акционных предложениях, предлагаемых вашей компанией.
Как отправлять СМС сообщения через API шлюз
Для API отправки СМС необходимо без каких-либо усилий и сложностей интегрировать модули и протоколы в свою программную среду, и можно приступать к рассылке сообщений, которые наверняка будут прочитаны адресатами. АPI для отправки SMS – это возможность контролировать весь процесс с помощью интуитивного интерфейса, изучать статистические данные, создавать расписание рассылок с корректировкой даты и времени отправки сообщений. Простота и доступность сервиса – это успех любого проекта!
Автоматическая рассылка СМС по API
Автоматизируйте отправку СМС сообщений, интегрировав сервис Stream Telecom в вашу ERP/CRM-систему или сайт по API.
API Stream Telecom позволяет автоматизировать процесс СМС рассылок и отправлять СМС сообщения по вашей базе клиентов, используя информацию из ERP- и CRM-систем, данные с сайта и со сторонних сервисов для автоматизации маркетинга.
Возможности автоматических СМС рассылок. Помимо значительного сокращения времени на планирование и запуск рассылок, интеграция СМС шлюза по API позволяет персонализировать сообщения и более качественно информировать клиентов об услугах, статусах заказов, специальных предложениях,акциях и др.
Возможности автоматических СМС рассылок по API.
▶ Регистрация и авторизация на сайте.
▶ Информирование о статусах заказов и напоминания о бронировании и записи на приём.
▶ Автоматическая рассылка поздравлений с днём рождения, национальными праздниками, особыми датами.
▶ Информирование о скидках, акциях бонусах и потенциально интересных предложениях для допродажи.
▶ Опросы об удовлетворенности качеством обслуживания.
Как автоматически запустить СМС рассылку. Для автоматизации запуска СМС рассылок необходимо настроить интеграцию по API по одному из поддерживаемых нашей платформой протоколов.
HTTP/HTTPs протокол
Протокол применяемый в web-разработках.Наша платформа и платформа заказчика обмениваются HTTPS URL- encoded запросами, используя форматы передач данных JSON в соответствии с принципами REST. Действие над данными задается с помощью методов GET или POSTв кодировке UTF-8.
XML
Данный протокол позволяет осуществлять отправку СМС сообщений за счёт обмена HTTP запросами (описанными выше), используя язык разметки XML. Подключение происходит на основании инкапсуляции передаваемых данных в XML конверты поверх протокола HTTP 1.1. Обмен данными построен по схеме запрос/ответ с использованием метода POST и не требует постоянного TCP/IP соединения.
SMPP v3.4
Стандартный протокол интеграции SMPP v3.4 используется для подключения к операторам сотовой связи и СМС агрегаторам. SMPP v3.4 является наиболее высокопроизводительным и универсальным протоколом. Для реализации требуется больший опыт разработки по сравнению с прочими протоколами.
Готовые решения
Мы также предлагаем ряд готовых решений, библиотек и модулей для подключения как к «самописным» системам заказчика, так и к популярным системам, применяемых в компаниях.
▶ Примеры интеграции для программ и сайтов на PHP. PHP — язык программирования, применяемый для web-разработки (создание сайтов, приложений, программ и т.д.). Позволяет не только отправлять СМС, но и принимать ответы от клиентов, запрашивать баланс, получать статистику и др.
▶ Модули для 1С. Позволяют рассылать СМС и Viber сообщения, а также осуществлять проверку номеров по HLR прямо из конфигурации 1С с использованием существующей базы контрагентов/контактных лиц. Доступны модули для интеграции с 1С 7.7, 8.2, 8.3.
▶ Модуль Yclients.Y-CLIENTS — лучшая CRM система по версии премии «Цифровые вершины» в 2020 году, позволяет автоматизировать бизнес-процессы в сфере обслуживания.
▶ Решения для CRM. Полноценное решение для интеграции сервиса рассылок Stream Telecom в CRM «Клиентская база».
Мы постоянно пополняем список партнёрских интеграций с CRM и сторонними сервисами. С полным списком партнёров и вариантами сотрудничества можно ознакомиться на странице партнёрской программы.
API для sms рассылок
Добавить телефоны в адресную книгу
Для добавления телефона в адресную книгу отправляется POST запрос по ссылке
https://api.sendpulse.com/sms/numbers |
addressBookId | идентификатор адресной книги (int) |
phones | массив телефонов в json формате |
Пример ответа для информации по книге:
Обновить список переменных по телефонному номеру
Для обновления списка переменных по телефонному номеру отправляется PUT запрос по ссылке
https://api.sendpulse.com/sms/numbers |
addressBookId | идентификатор адресной книги (int) |
phones | массив телефонов в json формате |
variables | массив переменных в json формате |
Пример параметра Phones:
Пример параметра Variables:
Удалить телефоны из адресной книги
Для удаления телефона из адресной книги отправляется DELETE запрос по ссылке
https://api.sendpulse.com/sms/numbers |
phones | список телефонов в json |
addressBookId | id адресной книги |
Получить информацию о телефонном номере
Для получения информации о телефонном номере отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/numbers/info/ |
phoneNumber | номер телефона |
addressBookId | id адресной книги |
Добавить номер в черный список
Чтобы добавить телефон в черный список, отправляется POST запрос по ссылке
https://api.sendpulse.com/sms/black_list |
phones | список телефонов в json |
description | описание |
Удалить номер из черного списка
Для удаления телефона из черного списка отправляется DELETE запрос по ссылке
https://api.sendpulse.com/sms/black_list |
phones | список телефонов в json |
Получить информацию по черному списку
Чтобы получить инфомрацию по черному листу, отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/black_list |
Получить информацию о телефонах в черном списке
Чтобы получить информацию о телефонах в черном списке, отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/black_list/by_numbers |
phones | список телефонов в json |
Создать кампанию по адресной книге
Чтобы создать кампанию, отправляется POST запрос по ссылке
https://api.sendpulse.com/sms/campaigns |
sender | имя отправителя SMS (до 11 символов латиницей, можно с цифрами) |
addressBookId | адресная книга |
body | текст рассылки |
transliterate | 1 или 0 , транслитерация тела |
route* | cписок каналов для отправки по странамв json (опционально), пример |
date | дата рассылки в формате Y-m-d H:i:s (опционально) |
emulate | опциональный параметр запускает тестовый режим: если emulate=1 , рассылка формируется, но не будет отправлена; в панели пользователя рассылка не отобразится. В ответе API, > |
Примечание: Для отправки смс на некоторые операторы нужно указывать, по какому каналу будет отправлена смс: международному или национальному, например так для операторов всех операторов Украины. Для отправки по национальному каналу в Украину и Беларусь необходимо одобренное имя отправителя. Если нет одобренного имени отправителя в Украину и Беларусь, для доставки смс в эти страны нужно указывать международный канал.
*Все сообщения подлежат модерации, поэтому доставка SMS может занять несколько минут.
Создать кампанию по телефонному списку
Чтобы создать кампанию по телефонному списку (или на один номер), отправляется POST запрос по ссылке
https://api.sendpulse.com/sms/send |
sender | имя отправителя SMS (до 11 символов латиницей, можно с цифрами) |
phones | список телефонов в json |
body | текст рассылки |
transliterate | 1 или 0 , транслитерация тела |
route* | список каналов для отправки по странамв json (опционально) , пример |
emulate | опциональный параметр запускает тестовый режим: если emulate=1, рассылка формируется, но не будет отправлена; в панели пользователя рассылка не отобразится. В ответе API, > |
date | дата рассылки в формате Y-m-d H:i:s (опционально) |
Получить список рассылок по датам
Чтобы получить список рассылок по датам, отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/campaigns/list |
dateFrom | дата от в формате Y-m-d H:i:s |
dateTo | дата до в формате Y-m-d H:i:s |
Получить информацию по рассылке
Чтобы получить информацию по рассылке, отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/campaigns/info/ |
id рассылки |
Расшифровка статуса отправки на номер:
код статуса | статус | описание статуса |
ready to send | готово к отправке | |
1 | sent | отправлено |
2 | delivered | доставлено |
12 | not delivered | не доставлено |
Отменить кампанию
Используется для компаний, которые еще не стартовали, запланированные компании
Чтобы отменить кампанию, отправляется PUT запрос по ссылке
https://api.sendpulse.com/sms/campaigns/cancel/ |
id рассылки |
В случае успеха сервер возвращает ответ со значением result = true
Получить стоимость кампании
Чтобы получить стоимость кампании, отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/campaigns/cost |
addressBookId | id адресной книги (опционально) |
phones | список телефонов в json (опционально) |
body | тело сообщения |
sender | отправитель |
route* | cписок каналов для отправки по странам в json (опционально) , пример |
Обратите внимание, что данные необходимо кодировать в URL формат.
Если не указана адресная книга, то обязательно должен быть указан список телефонов и наоборот.
Если выбран маршрут «international», сендер можно не указывать для некоторых стран.
Получить списка имен отправителей
Для получения списка всех зарегестрированных/отправленных на регистрацию/отклоненных имен отправителя для смс отправляется GET запрос по ссылке
https://api.sendpulse.com/sms/senders |
на модерации | |
1 | активный |
2 | отклонен |
Удалить кампанию
Чтобы удалить кампанию, отправляется DELETE запрос по ссылке
https://api.sendpulse.com/sms/campaigns |
id | id кампании |
Добавить телефоны к адресной книге с переменными
Чтобы добавить телефоны к адресной книге c переменными, отправляется POST запрос по ссылке
https://api.sendpulse.com/sms/numbers/variables |
addressBookId | айди адресной книги (int) |
phones | массив телефонов в формате json (см пример ниже) |
Пример параметра Phones:
* Дата при этом не должна содержать времени, например: «2020-10-10 23:00:00» — НЕверный формат значения переменной, а «2020-10-10» — верный.
Изменить значение переменной для контакта
Для того чтобы изменить переменную для телефонного номера, необходимо отправить post запрос на:
https://api.sendpulse.com/addressbooks/addressBookId/phones/variable |
phone | телефонный контакт, для которого будет заменена переменная с именем name на значение John |
addressBookId | ID адресной книги в которой находится нужный телефон и переменная с именем name |
*Примечание: в переменную типа строка возможно установить как числовое значение, так и значение типа число или дата(YYYY-MM-DD); в переменную типа номер возможно установить только число. В переменную типа дата возможно установить только дату, которая передана в формате YYYY-MM-DD. Другие форматы не поддерживаются: к примеру, валидный формат даты : 2020-01-01, а не валидный: 2020-1-1.
© 2015 — 2020. SendPulse Inc. Все права защищены
СМС-шлюз как важный инструмент взаимодействия с клиентами
СМС-шлюз API — автоматизирует SMS-рассылку по вашей клиентской базе, обеспечивает отправку и прием сообщений без использования мобильного телефона.
Делайте массовую рассылку или отправляйте одиночные сообщения Вашим клиентам!
Для чего нужен СМС-шлюз
Чтобы взаимодействовать с клиентами — проводить рекламные кампании, сообщать о новинках, уведомлять о готовности заказа в автоматическом режиме.
Поздравляйте покупателей с праздниками, напоминайте о необходимости внесения платежа по кредиту, информируйте об изменениях баланса карты.
Также с помощью СМС-шлюза можно подтверждать заказ в интернет-магазине, уведомлять о доставке товаров, времени подачи такси и записи к врачу, отправляя необходимую информацию на телефон клиента.
Что мы предлагаем
Интегрируйте СМС-сервис с помощью нашего API-шлюза в любые системы. Наша компания предлагает:
- файлы PHP-скрипта для отправки СМС;
- модуль для Drupal;
- модуль с кодом из 1C (Предприятия 7 и 8);
- пакет отправки СМС под Ruby;
- скрипт для отправки смс под Perl;
- плагин под JavaScript;
- библиотеку на Phyton.
СМС-шлюз API упрощает работу с клиентами, повышает скорость доставки SMS, позволяет отправлять неограниченное количество сообщений.
Наш СМС-шлюз интегрируется с API-шлюзами мобильных операторов МТС, Мегафон, Билайн, Теле2.
Проверяйте статус СМС, настраивайте отправку сообщений в заданное время!
Автоматизируйте регулярные процессы отправки большого количества сообщений с помощью наших скриптов с возможностью динамической смены имен отправителей. Благодаря данной возможности
Вам больше не придется утверждать новые параметры перед каждой рассылкой.
Оплатить услуги Вы можете любым удобным способом: с помощью безналичного платежа или мгновенных платежей (банковская карта, электронная коммерция).
Если у Вас остались вопросы, воспользуйтесь опцией «Заказать обратный звонок» или напишите нам.
Отправка смс сообщений
http://api.fastsms.pro/send.php
http://api.fastsms.pro/send.php?key=123&numbers=79998887754&message=Привет&sender=OnlineSmsRf
sender | имя отправителя SMS. Максимальная длина значения – 16 символов для цифровых значений и 11, если Вы используете символы. Диапазон возможных значений a-z, A-Z, 0-9. |
numbers | номера абонентов, разделенные запятой. Максимальное количество номеров в одном обращении — 15000. |
message | Ваше сообщение в кодировке UTF-8, максимальная длина — 10 смс частей (660 символов на кириллице, 1520 латинскими буквами). Кодировка будет распознана автоматически. Размер одного сообщения составляет: Транслит: — 160 символов — 152 символа, если длина сообщения превышает 160 символов Другие языки: — 70 символов в кириллице или включающем символы не из ASCII — 66 символов, если длина сообщения превышает 70 символов |
testing | если вы хотите протестировать работу api, но не хотите совершать реальную отправку смс (и тратить свои средства), то поставьте значение этого параметра в 1, сообщение будет точно так же отображено в личном кабинете, но средства списаны не будут, хотя и будет указана стоимость сообщения по Вашему тарифу. Через некоторое время статус сообщения поменяется с «отправлено» на «не доставлено». При этом Вы сможете так же протестировать запрос статусов СМС (включая получение статусов на собственный URL) |
ch_typ | тип канала. 1 — прямой канал, 2 — непрямой канал |
toWorld | телефонный код страны, пример для России: 7. Этот параметр используется для преобразования номеров в формат данной страны |
translit | 1 — транслитерация русскоязычного сообщения латинскими буквами |
unsubscribe | 1, если нужно вставить сообщение со ссылкой «отписаться от рассылки» |
smoothSend | 1 — «плавная» отправка |
sm_col | при плавной отправке — количество смс сообщений за раз, например 10 |
sm_int | при плавной отправке — интервал времени между отправками, в минутах, пример: 5 |
lateSend | 1 — «запланированная» отправка |
date | при запланированной отправке — дата отправки в формате пользователя (формат определяется в настройках сайта, пример: если формат определен как дд.мм.гггг, тогда дата будет выглядеть как 24.03.2015); при регулярной отправке — дата начиная с которой включается регулярная отправка; |
time | при запланированной отправке — время дня когда будет отправлено сообщение; при регулярной отправки — время дня в которое сообщение будет регулярно отправляться; параметр может быть в формате целого числа — количество секунд от начала суток или в формате чч:мм (пр. 13:30). Альтернативно время может быть указано через параметры hour и mins |
hour | часы — альтернативный параметр для указания времени, пример — 13 |
mins | минуты — альтернативный параметр для указания времени, пример — 30 |
local | 1 — отправлять по времени контакта-получателя. 0 или отсутствие параметра — отправлять по вашему времени, учитывая часовой пояс указанный в настройках сайта. |
dlr | 1 — запрос отчета о доставке на ваш указанный в настройках сайта URL. Т.е. любые изменения статуса будут приходить на ваш URL (который вы можете указывать в разделе «Настройки API») |
DUP_CONT | 1 — исключение номеров-дубликатов, которые уже содержатся в ваших контактах, из рассылки |
dupsent | 1 — исключение из рассылки номеров, которые уже были отправлены ранее, интервал этого фильтра задается параметром dupsent_radio |
dupsent_radio | фильтр для определения интервала времени, в пределах которого будут исключены номера-дубликаты; 8 — всё время, 16 — отправленные сегодня, 32 — доставленные сегодня |
Ответ от сервера
В результате сервер возвратит число — идентификатор рассылки, который вы можете использовать в дальнейшем для проверки статуса сообщений. В случае плавной отправки рассылка разбивается на несколько рассылок, поэтому возвращается несколько идентификаторов через запятую — на каждую рассылку по одному.