API
Сервис Мир СМС предоставляет возможность подключения интернет-магазина, CRM и CMS систем к нашему SMS шлюзу.
Назначение API: интеграция рассылки СМС сообщений в Ваше програмное обеспечение. При помощи нашего API вы можете подключить свой сайт или программу для автоматической отправки СМС сообщений.
SMS-HTTP: Описание протокола
Данный документ является описанием протокола взаимодействия программного обеспечения компаний-партнеров с SMS-HTTP платформой в рамках проекта SMS-HTTP. Протокол обеспечивает программному обеспечению партнеров следующие возможности:
- отправку коротких сообщений (SMS) мобильным абонентам:
- отправка сообщения одному абоненту;
- отправка сообщения группе абонентов одним запросом;
- отправка индивидуального текста группе абонентов одним запросом;
- автоматическое и ручное получение информации о статусе отосланных сообщений:
- запрос общей статистической информации по рассылке;
- запрос детальной информации по рассылке;
- запрос статуса отдельного сообщения;
- автоматическое уведомление об изменении статуса сообщения на платформу клиента;
- получение текущего баланса;
- управление Альфанумерическими именами (альфаименами):
- запрос всего списка альфаимен;
- запрос статуса конкретного альфаимени;
- добавление нового альфаимени;
Существенными целями при разработке данного протокола являлись:
- гибкость и расширяемость;
- простота реализации;
- отсутствие необходимости в сложном программном обеспечении со стороны партнеров.
Исходя из указанных целей, в качестве основы для протокола был выбран обмен XML-сообщениями через протокол HTTP. Наличие большого количества готовых средств генерации и обработки XML, а также простая структура протокола делают реализацию клиентской части не очень сложной.
Протокол опирается на стандартную модель "клиент-сервер", причем в качестве клиента выступает программное обеспечение партнера, а в качестве сервера - SMS-HTTP-платформа. В последующих разделах мы будем для краткости использовать термины "клиент" и "сервер" именно в этом смысле.
В случае отсылки сообщений, клиент посылает серверу запрос, содержащий как собственно сообщение, так и сопутствующую информацию. В ответ, сервер инициирует отсылку сообщения и возвращает статус завершения операции. Также сервер возвращает уникальный идентификатор сообщения для последующих ссылок со стороны клиента. В случае выяснения статуса отосланного сообщения, клиент посылает серверу запрос, содержащий полученный ранее уникальный идентификатор сообщения. В ответ, сервер возвращает клиенту текущий статус сообщения.
Следующий раздел данного документа содержит описание взаимодействия клиента и сервера на нижнем уровне (уровне HTTP). Последующие два раздела подробно описывают два основных типа запросов.
Обмен между сервером и клиентом производится с использованием протокола HTTP. Данные передаются в виде XML документов. От клиента к серверу передаются XML-документы, которые содержат SMS-сообщения. От сервера к клиенту передаются XML-документы, которые содержат информацию о состоянии сообщений.
Аутентификация производится с использованием HTTP Basic Authentication.
Для передачи сообщений используется метод POST протокола HTTP.
Отправка SMS-сообщения.
Для отправки SMS-сообщения, клиент присылает запрос на операцию SENDSMS следующего формата:
Одному абоненту:
Группе абонентов:
Более детально ознакомиться с API, а так же посмотреть пример реализации отправки СМС сообщеняи на языке PHP, Вы можете в документации.
Скачать документацию:
Внешние интеграции:
Онлайн коннектор сервисов и приложений
Скачать в формате [PDF]
Скачать в формате [RTF]