HTTP API v1.0 документация
Посредством API 1.0 "МС группы" возможно интегрирование SMS информирования с вашим сайтом или CRM системой. В автоматическом
режиме сообщайте вашим потребителям об изменении баланса, доставке заказа или других важных событиях. Все запросы доступны HTTP GET методом.
Отправка сообщения
Отправка SMS сообщениёsendsms.php
Параметр | Формат | Применение | Описание |
---|---|---|---|
username | string | Обязательное | Никнейм |
password | string | Обязательное | Пароль |
client_id | integer | Обязательное | Идентификатор пользователя |
service_id | integer | Обязательное | Идентификатор имени отправителя |
to | string | Обязательное | Номер телефона в международном формате |
text | string | Обязательное | Текст сообщения (латинских 160 символов, грузинских 70 символов) |
utf | integer | Необязательное | Отправка Юникод (грузинскими) символами |
Внимание! Если отправляете грузинский текст (Юникодный) и не укажете uft параметр, потребитель в сообщении вместо грузинских букв получит "?" символы
Пример отправки сообщения:
curl http://bi.msg.ge/sendsms.php?to=995599XXXXXX&text=your+text&service_id=1&client_id=1&password=your+password&username=your+nickname&utf=1
В ответ возвращается код статуса и идентификатор сообщения:
0000-000001
Значения кодов ответа:
Код | Описание |
---|---|
0000 | Сообщение отправлено успешно. Вторая цифра – уникальный идентификатор сообщения в системе |
0001 | Неправильный пароль или никнейм, или недопустимый IP адрес |
0003 | Необходимое поле пустое (username, password, client_id, service_id) |
0005 | Текст пустого сообщения |
0007 | Неправильный номер телефона |
0008 | Недостаточный баланс |
0009 | Не удалось найти имя отправителя |
0010 | Сообщение содержит запрещенное слово |
Отправка сообщений с хостинга и CLOUD серверов
Если ваш сервис размещен на таких серверах, которые имеют множество IP адресов, вы должны сообщить об этом вашему менеджеру и он передаст вам альтернативный пароль, который передадите в хедере запроса в виде MSG_HEADER параметра
Пример формирования запроса на РНР
$opts = array( 'http'=>array( 'method'=>"GET", 'header'=>"MSG_HEADER: Ваш альтернативный пароль" ... ) ); $context = stream_context_create($opts); $file = file_get_contents('http://bi.msg.ge/sendsms.php? to=995599000000& text=your+text& service_id=1& client_id=1& password=your+password& username=your+nickname', false, $context); // Замените параметры вашими реальными данными, которые вам предоставит менеджер по обслуживанию
Проверка статуса сообщения
Проверка статуса СМС сообщенияtrack.php
Параметр | Формат | Применение | Описание |
---|---|---|---|
message_id | integer | Обязательное | Идентификатор сообщения, полученный при отправке |
username | string | Обязательное | Никнейм |
password | string | Обязательное | Пароль |
client_id | integer | Обязательное | Идентификатор пользователя |
Пример проверки статуса сообщения GET методом:
curl http://bi.msg.ge/track.php?message_id=1&client_id=1&password=your+password&username=your+nickname
В ответ получаем код ответа:
1
Значение кодов ошибок:
Код | Описание |
---|---|
0 | В очереди отправления |
1 | Передано абоненту |
2 | Не удалось передать абоненту |
4 | В ожидании статуса |
8 | Получено SMS центром |
16 | Отказано SMS центром |
64 | Неправильный пароль или никнейм, или недопустимый IP адрес |