СМС шлюз smsClub, подключение SMS через API

Вы можете бесплатно подключиться к нашему смс-шлюзу, активация услуги не требуется. СМС-шлюз позволяет автоматизировать рассылку sms сообщений и встроить сервис в любой проект

JSON API (рекомендуемый метод)

Общение с сервисом осуществляется при помощи отправки HTTP-запросов на заданный адрес используя текстовый формат обмена данными «JSON».

Для аутентификации запроса используется «OAuth 2». При данном виде аутентификации необходимо использовать token, который можно получить в личном кабинете в разделе «Профиль». После чего соответственно включить данный токен в заголовок запроса, например как : 'Authorization: Bearer your_token'.

Внимание!

Ограничении частоты запросов к сервису должно быть не более 9 запросов в секунду от одного клиента.

Отправка сообщений

Адрес службы:

https://im.smsclub.mobi/sms/send

Отправка сообщений осуществляется посредством задания нижеописанных параметров.

src_addr – Альфа-имя, от которого идет отправка;
phone – Массив номеров, можно отправлять до 100 номеров за запрос;
message – Текст сообщения;
integration_id – Не обязательное поле. Заполнять при использовании реферальной системы;

Пример отправки сообщения в «JSON» формате:

{
    "phone" : ["380989361131"],
    "message" : "test text",
    "src_addr" : "VashZakaz"
}

После успешной отправки сообщения системе партнера вернется массив, «info» в котором ключ это id сообщение в нашей системе, по котором далее можно получить статус, а значением будет номер телефона на который было отправлено сообщение. В примере ниже «106» - id sms, 380989361131 — номер получателя.

Пример ответа в «JSON» формате:

{
 "success_request": {
    "info": {
        "106": "380989361131"
    }
 }
}

Получение статуса сообщений

Адрес службы:

https://im.smsclub.mobi/sms/status

Для получения статусов сообщений необходимо передать единственный параметр:

id_sms – Массив из ID сообщений по которым нужно получить статус, лимит не более 100.;

Пример в «JSON» формате:

{
    "id_sms": ["106"]
}

После успешного запроса системе вернет массив «info», в котором ключ будет id сообщения, а значением его статус.

{
 "success_request": {
    "info": {
        "106": "ENROUTE"
        }
    }
}

Статусы:

200 – Запрос успешно обработан.

Возможные статусы сообщений:

ENROUTE – сообщение отправлено;
DELIVRD – сообщение доставлено;
EXPIRED – истек срок жизни, сообщение не доставлено;
UNDELIV – невозможно доставить сообщение;
REJECTD – сообщение отклонено системой (черный список или же другие фильтры).

400 – Ошибка валидации входных параметров.
401 – Ошибка аутентификации пользователя.
429 – Слишком много запросов на единицу времени. По-умолчанию необходимо выполнять не более чем 9 запросов в 1 секунду.
500х – Сервис временно недоступен.

Получение списка альфа-имен пользователя

Адрес службы:

https://im.smsclub.mobi/sms/originator

Для получения списка доступных альфа имен, необходимо произвести запрос на выше указанный URL без тела запроса используя лишь авторизованную информацию пользователя.

После успешного запроса система вернет список активных альфа-имен:

Пример ответа:

{
 "success_request": {
    "info": [
        "test1",
        "test2"
        ]
    }
}

Получение баланса пользователя

Адрес службы:

https://im.smsclub.mobi/sms/balance

Для получения баланса, необходимо произвести запрос на выше указанный URL без тела запроса используя лишь авторизованную информацию пользователя.

После успешного запроса система вернет баланс пользователя, массив «info» где:

money - баланс
currency - валюта аккаунта

Пример ответа:

{
 "success_request": {
    "info": {
        "money": "8111.1700",
        "currency": "UAH"
        }
    }
}

SMPP-шлюз

Данный шлюз отвечает всем параметрам протокола SMPP v3.4. Для тестирования нашего шлюза необходимо связаться с менеджером.

HTTP-шлюз

Общение с сервисом осуществляется при помощи отправки HTTP-запросов на заданный адрес сервиса по протоколу HTTP методами GET/POST, проверка типа контента и валидность кодировки не осуществляется.

Каждый запрос может состоять из отправляемых сообщений и (или) запросов для получения статусов.

Отправка сообщений

Адрес службы:

https://gate.smsclub.mobi/token/

Отправка сообщений осуществляется посредством задания нижеописанных параметров. Параметры для обоих методов одинаковые:

username – логин учетной записи пользователя;
token – токен учетной записи пользователя (его можно найти в профиле);
from – альфа-имя, от которого идет отправка (11 английских символов, цифры, пробел);
to – список адресатов, разделяемые «;», после последнего адресата символ «;» не ставится;
text – сообщение в кодировке Windows-1251;
lifetime – установка срока жизни СМС, который указывается в минутах.

Важно! Ограничения:

для печатных символов (ASCII 0x01-0x7E) максимальная длина сообщения 1071 символ;
для символов, выходящих за рамки данного диапазона, максимальная длина сообщения: 469.

Получение ответа

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

=IDS START=
000002
000003
=IDS END=

=IDS START=, =IDS END= - - между данными константами заключен список ID сообщений/частей сообщений, каждый ID с новой строки (разделяется тэгом <br/>).

Список формируется в порядке, соответственно списку адресатов. Для сообщения, состоящего из нескольких частей, список ID формируется в порядке отправки частей сообщения одномуадресату, далее – список ID в порядке отправки частей сообщения второму адресату и т.д.

Запрос статусов сообщений

Метод GET, POST: https://gate.smsclub.mobi/token/state.php

Статусы сообщений содержат информацию о текущем состоянии сообщения, регулярно обновляются и могут быть запрошены пользователем в любое время. Запрос статусов осуществляется посредством нижеописанных параметров. Параметры для обоих методов одинаковые:

username – логин учетной записи пользователя;
token – токен учетной записи пользователя;
smscid – список ID, разделяемые «;», после последнего ID символ «;» не ставится.

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

=IDS START=
ID_1: STATE
ID_2: STATE
…
ID_N: STATE
=IDS END=

=IDS START=, =IDS END= - между данными константами заключен список запрашиваемых ID сообщений/частей сообщений, и соответствующий им статус (после символа «:»), каждый ID с новой строки (разделяется тэгом <br/>).

Коды статусов сообщений

Данные коды используются при возврате статусов сообщений:

ENROUTE – сообщение принято;
DELIVRD – сообщение доставлено;
EXPIRED – истек срок хранения сообщения;
UNDELIV – недоставляемое сообщение;
REJECTD - отклонено.

Пример GET-запроса отправки сообщения.

https://gate.smsclub.mobi/token/?username=user&token=user_token&from=SMS CLUB&to=0675126767&text=Hello from SMS CLUB

Пример GET-запроса на получение отчета о доставке.

https://gate.smsclub.mobi/token/state.php?username=user&token=user_token&smscid=000000

Проверка баланса онлайн

Данный метод позволяет проверить текущий баланс и величину кредита пользователя.

Пример GET-запроса проверки баланса.

https://gate.smsclub.mobi/token/getbalance.php?username=user&token=user_token

Пример кода проверки баланса.

<?php
    $ch = curl_init();
    $login = '380501234567';
    $token = '123456';
    $url = "https://gate.smsclub.mobi/token/getbalance.php?username=$login&token=$token";
    //можно и через POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_URL,$url);
    $result = curl_exec($ch);
    echo $result;
?>

XML-шлюз

Общение с сервисом осуществляется при помощи отправки XML запросов в кодировке UTF-8 на заданный адрес сервиса по протоколу HTTP методом POST, в переменной xmlrequest, проверка типа контента и валидность кодировки не осуществляется.

Каждый запрос может состоять из отправляемых сообщений и (или) запросов для получения статусов.

Отправка сообщений (одиночных и массово)

Адрес службы:
https://gate.smsclub.mobi/xml/

Отправка сообщений осуществляется посредством нижеописанной XML-структуры. Все данные, находящиеся в тегах, обрамляются в тег <![CDATA[]]>:

<?xml version='1.0' encoding='utf-8'?>
<request_sendsms>
      <username><![CDATA[username]]></username>
      <password><![CDATA[password]]></password>
      <from><![CDATA[XML]]></from>
      <to><![CDATA[380501111111;380502222222]]></to>
      <text><![CDATA[Пример русского ЮТФ-8 текста]]></text>
</request_sendsms>

username – логин учетной записи пользователя;
password – пароль учетной записи пользователя;
from – альфа-имя, от которого идет отправка (11 английских символов, цифры, пробел);
to – список адресатов, разделяемые «;», после последнего адресата символ «;» не ставится;
text – тег сообщения в кодировке UTF-8.

Важно! Ограничения:

для печатных символов (ASCII 0x01-0x7E) максимальная длина сообщения: 1071 символ;
для символов, выходящих за рамки данного диапазона максимальная длина сообщения: 469;
в XML структуре, которая отправляется на сервер www.gate.smsclub.mobi должны отсутствовать пробелы и энтеры между тегами!!!

На полученный запрос сервис возвращает XML-структуру следующего вида:

<?xml version="1.0" encoding="utf-8"?>
<response>
       <status>STATUS</status>
       <text>RESULT_TEXT</text>
       <ids>
       <mess>ID_1</mess>
       <mess>ID_2</mess>
         …
       <mess>ID_N</mess>
       </ids>
</response>

status – OK (Операция завершена успешно) / ERROR (Произошла ошибка);
text – текстовое сообщение о результате операции;
В случае удачной операции, сообщение типа: Сообщений: N (M частей).
В случае ошибки – суть ошибки. Пример: Не найдено соответствие пары логин\пароль.
ids – секция, содержащая список ID сообщений, присвоенных SMSC;
Список формируется в порядке, соответственно списку адресатов. Для сообщения, состоящего из нескольких частей, список ID формируется в порядке отправки частей сообщения одному адресату, далее – список ID в порядке отправки частей сообщения второму адресату итд.
mess – содержит ID сообщения/части сообщения.

Отправка персонализированных сообщений (одиночных и массово)

Адрес службы:
https://gate.smsclub.mobi/xml/individual.php

Отправка персонализированных сообщений подразумевает отправку СМС с индивидуальным текстом на каждый номер абонента и осуществляется посредством нижеописанной XML-структуры. Все данные, находящиеся в тегах, обрамляются в тег <![CDATA[]]>. Каждая отдельная СМС - это кортеж с данным в тегах <to> и <text>:

<?xml version='1.0' encoding='utf-8'?>
<request_sendsms>
      <username><![CDATA[username]]></username>
      <password><![CDATA[password]]></password>
      <from><![CDATA[XML]]></from>
      <to><![CDATA[380675126767]]></to>
      <text><![CDATA[Пример русского текста ЮТФ-8]]></text>
      ...
      <to><![CDATA[380997777662]]></to>
      <text><![CDATA[Example of text in UTF-8]]></text>
</request_sendsms>

username – логин учетной записи пользователя;
password – пароль учетной записи пользователя;
from – альфа-имя, от которого идет отправка (11 английских символов, цифры, пробел);
to – номер адресата;
text – тег сообщения в кодировке UTF-8.

Важно! Ограничения:

для печатных символов (ASCII 0x01-0x7E) максимальная длина сообщения 1071 символ;
для символов, выходящих за рамки данного диапазона максимальная длина сообщения: 469;
в XML структуре, которая отправляется на сервер www.gate.smsclub.mobi должны отсутствовать пробелы и энтеры между тегами!!!

На полученный запрос сервис возвращает XML-структуру следующего вида:

<?xml version="1.0" encoding="utf-8"?>
<response>
       <status>STATUS</status>
       <text>RESULT_TEXT</text>
       <ids>
       <mess>ID_1</mess>
       <mess>ID_2</mess>
         …
       <mess>ID_N</mess>
       </ids>
</response>

status – OK (Операция завершена успешно) / ERROR (Произошла ошибка);
text – текстовое сообщение о результате операции;
В случае удачной операции, сообщение типа: Сообщений: N (M частей).
В случае ошибки – суть ошибки. Пример: Не найдено соответствие пары логин\пароль.
ids – секция, содержащая список ID сообщений, присвоенных SMSC;
Список формируется в порядке, соответственно списку адресатов. Для сообщения, состоящего из нескольких частей, список ID формируется в порядке отправки частей сообщения одному адресату, далее – список ID в порядке отправки частей сообщения второму адресату итд.
mess – содержит ID сообщения/части сообщения.

Запрос статусов сообщений

Адрес службы:
https://gate.smsclub.mobi/xml/state.php

Статусы сообщений содержат информацию о текущем состоянии сообщения, регулярно обновляются и могут быть запрошены пользователем в любое время. Запрос статусов осуществляется посредством нижеописанной XML-структуры. Все данные, находящиеся в тегах, обрамляются в тег <![CDATA[]]>:

<?xml version="1.0" encoding="utf-8"?>
<request_getstate>
            <username><![CDATA[user]]></username>
            <password><![CDATA[pass]]></password>
            <smscid><![CDATA[000000;000001;000002;000003]]></smscid>
</request_getstate>

username – логин учетной записи пользователя;
password – пароль учетной записи пользователя;
smscid – список ID, разделяемые «;», после последнего ID символ «;» не ставится.

В ответ на запрос сервис возвращает XML-структуру, содержащую статусы для запрошенных сообщений, либо соответствующие коды ошибок, следующего вида:

    <?xml version="1.0" encoding="utf-8"?>
        <response>
        <status>OK</status>
        <text></text>
        <entries>
                 <entry>
                         <smscid>ID_1</smscid>
                         <state>STATE</state>
                 </entry>
                 <entry>
                         <smscid>ID_2</smscid>
                         <state>STATE</state>
                 </entry>
                 …
                <entry>
                        <smscid>ID_N</smscid>
                        <state>неверно указан id</state>
                </entry>
         </entries>
</response>

status – OK (Операция завершена успешно) / ERROR (Произошла ошибка);
text – текстовое сообщение о результате операции;
В случае удачной операции, тег не содержит никакой информации
В случае ошибки – суть ошибки. Пример: Не найдено соответствие пары логин\пароль.
entries – секция, содержащая список запрашиваемых ID сообщений, присвоенных SMSC, и соответствующих им статусов;
В случае возникновения ошибки данная секция может отсутствовать.
entry – секция, содержащая ID и статус одного сообщения;
smscid – запрашиваемый ID сообщения;
state – соответствующий ему статус.

Коды статусов сообщений.

Данные коды используются при возврате статусов сообщений.

ENROUTE – сообщение принято;
DELIVRD – сообщение доставлено;
EXPIRED – истек срок хранения сообщения;
UNDELIV – недоставляемое сообщение;
REJECTD - отклонено.

Пример кода отправки XML-запроса.

Данный код протестирован, и гарантирует положительный результат. Использование других методов – не тестировалось.

PHP-версия:

    <?php
      $xml = "
      <?xml version='1.0' encoding='utf-8'?>
      <request_sendsms>
            <username><![CDATA[username]]></username>
            <password><![CDATA[password]]></password>
            <from><![CDATA[XML]]></from>
            <to><![CDATA[380675126767]]></to>
            <text><![CDATA[Пример русского ЮТФ-8 текста]]></text>
      </request_sendsms>";
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_POST, true);
      curl_setopt($ch, CURLOPT_POSTFIELDS, array("xmlrequest" => $xml));
      curl_setopt($ch, CURLOPT_URL, 'https://gate.smsclub.mobi/xml/');
      $result = curl_exec($ch);
      echo $result;
    ?>

Загрузить примеры

Здесь Вы сможете скачать примеры скриптов, для работы с выбранным шлюзом

Метод	HTTP	XML	JSON
Одиночная
Массовая
Индивидуальная
Баланс
Отчеты

Навигация

Отправка сообщений

Получение статуса сообщений

Получение списка альфа-имен пользователя

Получение баланса пользователя

SMPP-шлюз

HTTP-шлюз

Отправка сообщений

Получение ответа

Запрос статусов сообщений

Коды статусов сообщений

Проверка баланса онлайн

XML-шлюз

Отправка сообщений (одиночных и массово)

Отправка персонализированных сообщений (одиночных и массово)

Запрос статусов сообщений

Коды статусов сообщений.

Пример кода отправки XML-запроса.

Загрузить примеры

Вход для клиентов