API

Подключите свой сервис для отправки sms сообщений

Для того, чтобы настроить взамойдествие вашего сервиса с API SMS - сервиса, необходимо:

  • Выбрать какую-либо возможность предоставляемую API сервиса. Список возможностей представлен ниже;
  • Сформировать GET запрос. Пример представлен ниже;
  • Обработать ответ API сервиса.

Правила формирования секретного ключа key для аутентификации запросов к API сервиса:

  • Необходимо объявить пустой массив;
  • Далее массив необходимо заполнить значениями передваемых параметров, например id, to, body;
  • После этого массив необходимо отсортировать по алфавиту, и записать его в строку;
  • К получившейся строке необходимо дописать секретный key пользователя он генерируется автоматически и доступен в личном кабинете в разделе "Профиль";
  • Следующим шагом необходимо применить алгоритм хеширования MD5 к получившейся строке, результатом получится ключ вида 299a2vbv2de3e0fc66c8g77ba8a3e92b;
  • Получившийся ключ необходимо передавать вместе с запросами к API сервиса параметром key.

При помощи API вы имеете возможность:

Подключить свой сервис для отправки SMS на произвольный номер, например для подтверждения регистрации на сайте и т.д.

Для того, чтобы использовать данную возможность необходимо отправить GET запрос вида:

          http://sms-fast.net/tools/api_sendsms.rb?id=VALUE1&to=VALUE2&body=VALUE3&key=VALUE4
        
где:
  • id - является идентификатором вашего сервиса, присваивается автоматически каждому аккаунту сервиса. Найти его можно в личном кабинете в разделе "Профиль", например id=2;
  • to - номер телефона получателя, например to=79009009090;
  • body - текст сообщения, которое необходимо отправить, например это может быть код подтверждения body=code123;
  • key - уникальный ключ для аутентификации вашего запроса, правила формирования данного ключа прописаны в разделе "Правила формирования секретного ключа key для аутентификации запросов к API сервиса" выше.

В конечном итоге ваш GET запрос будет выглядить следующим образом, например:

          http://sms-fast.net/tools/api_sendsms.rb?id=2&to=79009009090&body=code123&key=299a2vbv2de3e0fc66c8g77ba8a3e92b
        

После того, как вы отправите запрос на отправку SMS, ожидаются несколько возможных ответов от API сервиса, такие как:

Код 100, BALANCE_FAIL Говорит о том, что запрос не выполнен по причине нехватки денежных средств и SMS не отправлена.

          {"code":"100","state":"BALANCE_FAIL"}
        

Код 200, SUCCESS Говорит о том, что запрос выполнен успешно, и SMS доставлена. Деньги со счета списываются согласно выбранному тарифу. Цена за одну SMS по умолчанию равняется 2.2 руб. для российских операторов связи, 5 руб. для операторов стран СНГ, 30 руб. для операторов дальнего зарубежья.

          {"code":"200","state":"SUCCESS"}
        

Код 300, KEY_FAIL Говорит о том, что запрос не выполнен по причине не соответствия ключа аутентификации, SMS не отправлена.

          {"code":"300","state":"KEY_FAIL"}
        

Код 0, FAIL Говорит о том, что запрос выполнен, но произошла непредвиденная ошибка и SMS не отпралена либо не доставлена. В этом случае денежные средства со счета списаны не будут.

          {"code":"0","state":"FAIL"}
        
Запросить список отправленных SMS, с помощью данной возможности вы можете вести какую-либо статистику внутри вашего сервиса.

Для того, чтобы использовать данную возможность необходимо отправить GET запрос вида:

          http://sms-fast.net/tools/api_getlist.rb?id=VALUE1&key=VALUE2
        
где:
  • id - является идентификатором вашего сервиса, присваивается автоматически каждому аккаунту сервиса. Найти его можно в личном кабинете в разделе "Профиль", например id=2;
  • key - уникальный ключ для аутентификации вашего запроса, правила формирования данного ключа прописаны в разделе "Правила формирования секретного ключа key для аутентификации запросов к API сервиса" выше.

В конечном итоге ваш GET запрос будет выглядить следующим образом, например:

          http://sms-fast.net/tools/api_getlist.rb?id=2&key=299a2vbv2de3e0fc66c8g77ba8a3e92b
        

После того, как вы отправите запрос на отправку SMS, ожидаются несколько возможных ответов от API сервиса, такие как:

Код 200, SUCCESS Говорит о том, что запрос выполнен успешно. Ответ от API сервиса будет содержать JSON массив в котором ключ list соответвтвует массиву все отправленных SMS сообщених с вашего сервиса.

          {"code":"200","state":"SUCCESS",
            "list":[{"id":"16","to":"79009009090","body":"code123","date":"2017-01-31 14:35:35"},
            {"id":"15","to":"79009009090","body":"code123","date":"2017-01-31 13:37:32"},
            {"id":"14","to":"79009009090","body":"test send","date":"2017-01-27 16:37:50"},
            {"id":"13","to":"79009009090","body":"test sms","date":"2017-01-25 17:09:04"},
            {"id":"12","to":"79009009090","body":"sasasas","date":"2017-01-25 17:08:15"},
            {"id":"11","to":"79009009090","body":"sd","date":"2017-01-25 17:07:00"},
            {"id":"10","to":"79009009090","body":"QQQ 1234","date":"2017-01-25 17:06:02"},
            {"id":"9","to":"79009009090","body":"еще тест","date":"2017-01-25 17:01:57"},
            {"id":"8","to":"79009009090","body":"тест2","date":"2017-01-25 13:14:24"},
            {"id":"7","to":"79009009090","body":"тест","date":"2017-01-25 13:12:53"},
            {"id":"6","to":"79009009090","body":"test 4 25-01","date":"2017-01-25 11:55:51"},
            {"id":"5","to":"79009009090","body":"test 3 25-01","date":"2017-01-25 11:54:03"},
            {"id":"4","to":"79009009090","body":"test","date":"2017-01-24 15:56:02"},
            {"id":"3","to":"79009009090","body":"test price","date":"2017-01-24 15:52:49"},
            {"id":"2","to":"79009009090","body":"test from webinterface","date":"2017-01-24 15:40:42"},
            {"id":"1","to":"79009009090","body":"sad","date":"2017-01-24 15:32:40"}]}
        

Код 300, KEY_FAIL Говорит о том, что запрос не выполнен по причине не соответствия ключа аутентификации.

          {"code":"300","state":"KEY_FAIL"}
        

Код 0, FAIL Говорит о том, что запрос выполнен, но произошла непредвиденная ошибка. Следует повторить запрос еще раз.

          {"code":"0","state":"FAIL"}
        
Запросить баланс вашего аккаунта.

Для того, чтобы использовать данную возможность необходимо отправить GET запрос вида:

          http://sms-fast.net/tools/api_getlist.rb?id=VALUE1&key=VALUE2
        
где:
  • id - является идентификатором вашего сервиса, присваивается автоматически каждому аккаунту сервиса. Найти его можно в личном кабинете в разделе "Профиль", например id=2;
  • key - уникальный ключ для аутентификации вашего запроса, правила формирования данного ключа прописаны в разделе "Правила формирования секретного ключа key для аутентификации запросов к API сервиса" выше.

В конечном итоге ваш GET запрос будет выглядить следующим образом, например:

          http://sms-fast.net/tools/api_getlist.rb?id=2?key=299a2vbv2de3e0fc66c8g77ba8a3e92b
        

После того, как вы отправите запрос на отправку SMS, ожидаются несколько возможных ответов от API сервиса, такие как:

Код 200, SUCCESS Говорит о том, что запрос выполнен успешно. Ответ от API сервиса будет содержать JSON массив в котором ключ balance соответствует текущему балансу вашего аккаунта.

          {"code":"200","state":"SUCCESS","balance":"48.50"}
        

Код 300, KEY_FAIL Говорит о том, что запрос не выполнен по причине не соответствия ключа аутентификации.

          {"code":"300","state":"KEY_FAIL"}
        

Код 0, FAIL Говорит о том, что запрос выполнен, но произошла непредвиденная ошибка. Следует повторить запрос еще раз.

          {"code":"0","state":"FAIL"}