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

Информация об аккаунте

Метод для получения информации об аккаунте

https://semysms.net/api/3/user.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)

Пример GET запроса:

  https://semysms.net/api/3/user.php?token=2d9d148edeb50768c22dc6d96f85d60b
        

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

{"code":0,"id_user":1,"is_pay":1,"type_premium":1,"date_end_premium":null,"messages_premium":4998}
        

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

• id_user - ID аккаунта
• is_pay - Статус премиум аккаунта (0 - бесплатный, 1 - Премиум)
• type_premium - Тип премиума (0 - по времени, 1 - поштучно)
• date_end_premium - Дата действия премиума (если тарифный план, по времени)
• messages_premium - Количество премиум сообщений (если тарифный план, поштучный)

Отправка SMS

Метод для отправки одного СМС-сообщения одному адресату

https://semysms.net/api/3/sms.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств. Один или несколько через запятую.
  Параметр так же может принимать значение device=active это означает, что будут использоваться все активные устройства в вашем аккаунте!
  Если параметр device имеет несколько значений или имеет значение active, то сервис будет распределять новые смс между указанными устройствами, поочерёдно! (обязательный параметр)
• phone - телефон получателя в международном формате с кодом страны (обязательный параметр)
• msg - текст сообщения, до 1000 символов (обязательный параметр)
• priority - Приоритет на отправку, чем больше число, тем выше приоритет (целое число от 0 - 1000000)
• add_contact - Создавать контакт в списке контактов (0 или пусто - нет, 1 - создать)
• name - Имя контакта для создания номера в списке контактов
• surname - Фамилия контакта для создания номера в списке контактов
• add_plus - Принудительно добавляет символ + к номеру телефона (0 или пусто - не используется, 1 - Добавить +)

Пример GET запроса:

Если одно устройство:
  https://semysms.net/api/3/sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1&phone=%2B7920123xxxx&msg=Сообщение

Если несколько устройств:
  https://semysms.net/api/3/sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1,15,25&phone=%2B7920123xxxx&msg=Сообщение
        

Пример POST запроса:

<?php
 $url = "https://semysms.net/api/3/sms.php"; //Адрес url для отправки СМС
 $phone = '+7920123xxxx'; // Номер телефона
 $msg = 'Сообщение';  // Сообщение
 $device = '1';  // Код вашего устройства
 $token = '2d9d148edeb50768c22dc6d96f85d60b';  // Ваш токен (секретный)

 $data = array(
        "phone" => $phone,
        "msg" => $msg,
        "device" => $device,
        "token" => $token
    );

    $curl = curl_init($url);
    curl_setopt($curl, CURLOPT_POST, true);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);     
    $output = curl_exec($curl);
    curl_close($curl);

    echo $output;
?>
        

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

{"code":"0","id":1201158}
        

Метод для отправки нескольких СМС-сообщений

https://semysms.net/api/3/sms_more.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств (обязательный параметр)
• phone - телефон получателя в международном формате с кодом страны (обязательный параметр)
• msg - текст сообщения, до 1000 символов (обязательный параметр)
• my_id - код смс из вашей учетной системы
• priority - Приоритет на отправку, чем больше число, тем выше приоритет (целое число от 0 - 1000000)

Пример POST запроса:

<?php
 $url = "https://semysms.net/api/3/sms_more.php"; //Адрес url для отправки СМС 
 $device = '1';  // Код вашего устройства
 $token = '2d9d148edeb50768c22dc6d96f85d60b';  // Ваш токен (секретный)

 $params = array('token'  => $token);

 for ($index = 1; $index <= $max_count; $index++) { // Заполняем в цикле массив с номерами, сообщениями и кодами устройств
   $params['data'][] = array(
            'my_id' => 'Код из вашей системы управления (он вместе с кодом из semysms вернется обратно)',
            'device' => $device, 'phone' => $phone, 'msg' => $msg);
 }

 $params = json_encode($params);

 $curl = curl_init($url);
 curl_setopt($curl, CURLOPT_URL, $url); 
 curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
 curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($params))
  );
 curl_setopt($curl, CURLOPT_POST, true);
 curl_setopt($curl, CURLOPT_POSTFIELDS,  $params);
 $result = curl_exec($curl);
 curl_close($curl);	   
 echo  $result;
?>
        

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

{"code":"0", data:[{"my_id":"будет значение если задан в запросе", "id":1201158}]}
        

Список исходящих SMS или WebHook для статусов

Метод для получения списка исходящих СМС-сообщений

https://semysms.net/api/3/outbox_sms.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств
• start_id - начальный код для фильтрации списка
• end_id - конечный код для фильтрации списка
• list_id - список кодов смс через запятую
• date_start - дата с которой начинать фильтрацию
• date_end - дата по которую фильтровать
• phone - номер телефона для фильтрации списка

Внимание - если параметры (start_id, list_id, date_start, date_end) не установлены, то метод вернёт данные только за сегодняшний день!

Пример GET запроса:

https://semysms.net/api/3/outbox_sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1&start_id=1&end_id=371&date_start=2015-08-9 10:30&date_end=2015-08-9 22:30&phone=87201234567
        

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

{"count":1,
 "data":[
         {
          "id":371,
          "phone":"8920123xxxx",
          "date":"2015-02-04 12:41:13.657724",
          "msg":"test",
          "id_device":1,
          "send_to_phone":"2015-02-04 12:42:01.490436",
          "is_send_to_phone":1,
          "is_send":1,
          "send":"2015-02-04 12:47:31",
          "is_delivered":1,
          "delivered":"2015-02-04 12:47:33",
          "is_cancel":0,
          "cancel":null,
          "is_error":0,
          "is_error_send":0,
          "error_date":null,
          "is_out":0, // сообщение создано извне (например: если сообщение создано в WhatsApp вручную в телефоне, а затем выгружено в сервис)
          "type":0  //  тип сообщения (0 - СМС, 1 - WhatsApp, 2 - WhatsApp Business)
         }
       ]
}
        

Список входящих SMS или WebHook

Метод для получения списка входящих СМС-сообщений

https://semysms.net/api/3/inbox_sms.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств (обязательный параметр)
• start_id - начальный код для фильтрации списка
• end_id - конечный код для фильтрации списка
• date_start - дата с которой начинать фильтрацию
• date_end - дата по которую фильтровать
• phone - номер телефона для фильтрации списка

Внимание - если параметры (start_id, date_start, date_end) не установлены, то метод вернёт данные только за сегодняшний день!

Пример GET запроса:

https://semysms.net/api/3/inbox_sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1&start_id=1&end_id=371&date_start=2015-08-9 10:30&date_end=2015-08-9 22:30&phone=87201234567
        

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

{"count":1,
 "data":[
         {
          "id":15,
          "phone":"+7920123xxxx",
          "date":"2015-01-27 13:03:42",
          "msg":"Test",
          "id_device":1,
          "type":0 //  тип сообщения (0 - СМС, 1 - WhatsApp, 2 - WhatsApp Business)
         }
        ]
}
        

Список устройств

Метод для получения списка устройств

https://semysms.net/api/3/devices.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• is_arhive - фильтрация по типу архивный или нет
• list_id - список кодов устройств через запятую

Пример GET запроса:

https://semysms.net/api/3/devices.php?token=2d9d148edeb50768c22dc6d96f85d60b&is_arhive=0&list_id=1,2,3
        

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

{
 "code":0,
 "count":1,
 "data":[
         {
            "id":351,
            "is_arhive":0,
            "is_deliv":1,
            "is_work":1,
            "power":1,
            "device_name":"U8186",
            "dop_name":"",
            "speed_sms":1,
            "date_last_active":"2015-09-11 14:25:29.548563",
            "version":"40",
            "limit_phone":null,
            "limit_use":null,
            "limit_date":"2015-09-08 14:33:39.54061",
            "limit_period":" ",
            "manufacturer":"HUAWEI",
            "android_version":"2.3.6",
            "bat":"58",
            "type":0
         }
       ]
}
        

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

• id - Код устройства
• is_arhive - В архиве
• is_deliv - Отчет о доставке
• is_work - Использовать в рассылке
• power - Включен/Выключен сервис в телефоне
• device_name - Имя устройства
• dop_name - Дополнительное имя
• speed_sms - Скорость отправки смс
• date_last_active - Дата последней активности устройства
• version - Версия программы
• limit_phone - Установленный лимит
• limit_use - Сколько использовано лимита
• limit_date - Дата установки лимита
• limit_period - Период действия лимита
• manufacturer - Производитель
• android_version - Версия Android
• bat - Заряд батареи в процентах
• type - Тип сообщения (0 - СМС, 1 - WhatsApp, 2 - WhatsApp Business)

Отмена отправки, всех не отправленных на устройства СМС

Метод для отмены отправки, всех не отправленных на устройства СМС

https://semysms.net/api/3/cancel_sms.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств
• id_sms - код смс из списка отправленных смс

Пример GET запроса:

https://semysms.net/api/3/cancel_sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1
        

Удаление исходящих SMS

Метод для удаление исходящих СМС-сообщений

https://semysms.net/api/3/del_outbox_sms.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств (обязательный параметр)
• start_id - начальный код для фильтрации списка
• end_id - конечный код для фильтрации списка
• list_id - список кодов смс через запятую
• date_start - дата с которой начинать фильтрацию
• date_end - дата по которую фильтровать
• phone - номер телефона для фильтрации списка

Внимание - если параметры (start_id, list_id, date_start, date_end) не установлены, то метод удалит данные только за сегодняшний день!

Пример GET запроса:

https://semysms.net/api/3/del_outbox_sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1&start_id=1&end_id=371&date_start=2015-08-9 10:30&date_end=2015-08-9 22:30&phone=87201234567
        

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

{"count":1,
 "data":[
         {
          "id":371,
          "phone":"8920123xxxx",
          "date":"2015-02-04 12:41:13.657724",
          "msg":"test",
          "id_device":1,
          "send_to_phone":"2015-02-04 12:42:01.490436",
          "is_send_to_phone":1,
          "is_send":1,
          "send":"2015-02-04 12:47:31",
          "is_delivered":1,
          "delivered":"2015-02-04 12:47:33",
          "is_error":0,
          "is_error_send":0,
          "error_date":null
         }
       ]
}
        

Удаление входящих SMS

Метод для удаление входящих СМС-сообщений

https://semysms.net/api/3/del_inbox_sms.php - адрес для отправки запросов

Параметры:

• token - секретный ключ доступа к API (обязательный параметр)
• device - код устройства из списка подключенных ваших устройств (обязательный параметр)
• start_id - начальный код для фильтрации списка
• end_id - конечный код для фильтрации списка
• date_start - дата с которой начинать фильтрацию
• date_end - дата по которую фильтровать
• phone - номер телефона для фильтрации списка

Внимание - если параметры (start_id, date_start, date_end) не установлены, то метод удалит данные только за сегодняшний день!

Пример GET запроса:

https://semysms.net/api/3/del_inbox_sms.php?token=2d9d148edeb50768c22dc6d96f85d60b&device=1&start_id=1&end_id=371&date_start=2015-08-9 10:30&date_end=2015-08-9 22:30&phone=87201234567
        

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

{"count":1,
 "data":[
         {
          "id":15,
          "phone":"+7920123xxxx",
          "date":"2015-01-27 13:03:42",
          "msg":"Test",
          "id_device":1
         }
        ]
}