Описание API-интерфейса
С помощью API-интерфейса можно отправлять сообщения с Вашего сайта или программы автоматически. Он прост в использовании и понимании. Наш сервер принимает запросы в кодировке windows-1251.Ответ от сервера. Коды ошибок.
Ответ от сервера API-сервера содержит код ошибки. Ниже приведен их список.| Код ошибки | Расшифровка |
|---|---|
| 1 | Нет ошибок. |
| -1 | Неправильно указан отправитель. |
| -2 | Неправильно указан получатель. |
| -3 | Сообщение пустое, либо длиннее 6 СМС. |
| -4 | Серверная ошибка. |
| -5 | Недопустимый отправитель. Имена операторов и прочие запрещены. |
| -6 | Неверный ключ API. |
| -7 | Баланса ключа недостаточно для отправка данного сообщения. |
| -8 | Неверная контрольная сумма. |
| -9 | За 1 раз можно указывать не более 10 получателей. |
| -10 | Ваш IP-адрес забанен за спам. |
| -11 | Сообщение является спамом. |
| -12 | Сообщение содержит оскорбления или маты. |
| -13 | Операторы данной страны запретили указывать в качестве отправителя реальный номер. |
| -14 | Отправитель не должен совпадать с получателем. |
Контрольная сумма
Контрольная сумма представляет собой md5-хэш склейки некоторых параметров запроса.Сразу рассмотрим пример. В качестве ключа будем использовать XXXXX. Отправителем и получателем будут SMSAnon и 79221234567 соответственно.
При формировании контрольной суммы для проверки баланса сервис SMSAnon "склеивает" API-ключ и слово balance в одну строку:
XXXXXbalanceВ результате получаем md5-хэш:
00a9669fbdc1f4753a3df293c883f340
А для отправки СМС сервис SMSAnon "склеивает" API-ключ, отправителя и получателя:
XXXXXSMSAnon79221234567В результате получаем md5-хэш:
5c46818bbac5001debb6b2ce35bf4771
Описание параметров
Все запросы принимает наш API-сервер:http://smsanon.ru/api.php
Параметры для проверки баланса:
| Параметр | Описание |
|---|---|
| api_key | API-ключ |
| balance | - |
| check | контрольная сумма |
Пример составления URL для GET-запроса:
http://smsanon.ru/api.php?balance&api_key=XXXXX&check=00a9669fbdc1f4753a3df293c883f340
Параметры для отправки СМС:
| Параметр | Описание |
|---|---|
| api_key | API-ключ |
| from | отправитель сообщения |
| to | получатель (можно указывать до 10 через запятую) |
| msg | текст сообщения |
| check | контрольная сумма |
Пример составления URL для GET-запроса:
http://smsanon.ru/api.php?api_key=XXXXX&from=SMSAnon&to=79221234567&msg=Message&check=5c46818bbac5001debb6b2ce35bf4771
Для отправки СМС на несколько номеров одновременно укажите в качестве получателя все номера через запятую. При повторе одного номера в запросе СМС отправится только 1 раз.
Пример:
79221234567,79221234568При таком варианте будет отправлено одно сообщение, т.к. указаны одинаковые получатели:
79221234567,79221234567В таком случае ответ от сервера будет содержать коды ошибок через запятую или один код.
Примеры ответов:
1,-7
-4
Пример отправки СМС на PHP
<?php
$api_key = "XXXXX"; //Ваш API-ключ
$to = "79221234567"; //Номер получателя, 11 знаков
$from = "SMSAnon"; //Отправитель
$msg = "Текст сообщения";
include("smsanon.class.php");
$smsanon = new SMSAnon($api_key);
$res = $smsanon->sendSMS($from, $to, $msg);
if(is_numeric($res)){
switch ($res){
case 1: echo "сообщение успешно отправлено";
break;
case -1: echo "неправильно указан отправитель";
break;
case -2: echo "неправильно указан получатель";
break;
case -3: echo "сообщение пустое, либо длиннее 6 смс";
break;
case -4: echo "произошла серверная ошибка";
break;
case -5: echo "недопустимый отправитель";
break;
case -6: echo "неверный ключ api";
break;
case -7: echo "баланса ключа недостаточно для отправки данного сообщения";
break;
case -10: echo "ваш ip-адес забанен за спам";
break;
case -11: echo "сообщение является спамом и было отклонено";
break;
case -12: echo "не используйте матов и ругательных слов в сообщении";
break;
case -13: echo "операторы данной страны запретили указывать в качестве отправителя реальный номер";
break;
case -14: echo "отправитель не должен совпадать с получателем";
break;
}
}
else{
// ошибка сервера
echo "произошла серверная ошибка";
}
?>Проверка баланса API-ключа на PHP
<?php
$api_key = "XXXXX"; //Ваш API-ключ
include("smsanon.class.php"); // подключаем класс SMSAnon
$smsanon = new SMSAnon($api_key);
$res = $smsanon->getBalance();
if(is_numeric($res)){
switch ($res){
case -6: echo "неверный ключ api";
break;
case -4: echo "произошла серверная ошибка";
break;
default: echo $res;
break;
}
}
else{
// ошибка сервера
echo "произошла серверная ошибка";
}
?>
Скачать вышеизложенные примеры на PHP и класс можно по ссылке.
Покупка нового API-ключа
| Направление | Тариф | Кол-во СМС | Сумма, руб. |
|---|
** Укажите существующий ключ, чтобы пополнить его баланс. Если вы укажете пустое значение, то будет сгенерирован новый ключ.
Напоминание ключа
| Укажите ваш email |
|---|
