Документация по API

Вызов методов осуществляется посредством GET или POST HTTP-запросов к серверу:

Адрес сервера: api.goip.holding.bz
Порт (протокол): 80 (HTTP)
Метод: GET или POST
Кодировка для запроса: UTF-8.

В GET- или POST-переменных запроса передаются аргументы с именами:

Аргументы:
  • method - вызываемый метод.
  • набор переменных, зависящий от конкретного метода.
  • format (необязательный) формат выходных данных (XML, JSON), без указания этого параметра, по умолчанию данные выдаются в формате XML.

Все методы возвращают массив аргументов в формате <format> с именами:

msg - сообщение о выполнении действия в виде массива с ключами:
<err_code> - числовой код ошибки (0 - нет ошибок),
<text> - текстовое сообщение,
<type> - тип сообщения (message – нет ошибок, notice и error – ошибки),

data - запрашиваемые данные в виде массива.

Ниже приведены коды ошибок <err_code> и соответствующие им ошибки из возвращаемого массива <msg>:

0 - Выполнено успешно.
2 - Неверный логин и(или) пароль.
3 - Превышен лимит сервера.
7 - Заданы не все необходимые параметры.
99 - Транзакция отправки SMS не прошла.
602 - Пользователя не существует.
605 - Пользователь заблокирован.
609 - Сотовый оператор не подключен.
617 - Неверный формат номера получателя SMS.
618 - Номер Абонента в Черном списке.
622 - Номер Абонента в глобальном Черном списке.
623 - Недостаточно средств. Пополните баланс.
624 - Обнаружены запрещенные слова в тексте сообщения. Обратитесь в поддержку.
699 - Не удалось установить соединение
700 - Дневной лимит СМС исчерпан.

Отправка SMS (Метод push_msg).

Пример HTTP запроса, который Вы можете выполнить в браузере:
http://api.goip.holding.bz/?method=push_msg&email=YOUR_LOGIN&password=YOUR_PASSWORD&text=SMS_TEXT&phone=SMS_PHONE_NUMBER_OF_THE_RECIPIENT
YOUR_LOGIN - Логин в системе
YOUR_PASSWORD - Ключ API
SMS_TEXT - Текст SMS сообщения
SMS_PHONE_NUMBER_OF_THE_RECIPIENT - Номер телефона получателя SMS в формате 79160000000

При успешной отправке SMS в ответ Вы получите массив данных data:

<id> - ID SMS сообщений на стороне нашего сервера.
<credits> - Стоимость одной части отправленной СМС
<n_raw_sms> - Количество частей SMS