Інтеграція з сервісом (HTTP/HTTPS API)

  • Зареєструйтесь на сайті або увійдіть до особистого кабінету, якщо вже зареєструвалися;
  • Перейдіть до налаштувань API та увімкніть API;
  • Ознайомтеся з методами API нижче;
  • Скопіюйте ключ API і використовуйте його для авторизації (Bearer token в заголовку Authorization);
  • Для методів Підключення номера та Надіслати повідомлення поповніть баланс;

Опис методів API

API

Аутентифікація

Усі запити API (крім /api/login, /api/register та /api/public/*) вимагають авторизації через Bearer token:

Authorization: Bearer <api_token>

Базовий URL: https://sms-numbers.co/api


API для роботи з номерами

GET Список номерів

Повертає список номерів вашого акаунту.

GET https://sms-numbers.co/api/numbers

Заголовки: Authorization: Bearer <api_token>

Параметри запиту: filter (string) — Опціонально фільтр за статусом (напр. active)


GET Інформація про номер

Повертає інформацію про конкретний номер.

GET https://sms-numbers.co/api/number/{id}

Параметри шляху: id (integer) — ID номера зі списку.


GET Пошук номерів для підключення

Повертає доступні номери за кодом країни (ISO 3166-1 alpha-2).

GET https://sms-numbers.co/api/numbers/search/{iso}

Параметри шляху: iso (string) — двокодовий код країни (напр. ua, us).

Тарифи: GET https://sms-numbers.co/api/public/countries та GET https://sms-numbers.co/api/public/prices/{country_id}.


POST Підключення номера

Дозволяє підключити обраний номер. Покупка через веб-інтерфейс.

POST https://sms-numbers.co/api/number/buy

Заголовки: Authorization: Bearer <api_token>, Content-Type: application/json

Тіло: id (integer) — ID номера для підключення (з результатів пошуку).


POST Відключення номера

Відключає обраний номер.

POST https://sms-numbers.co/api/number/cancel

Заголовки: Authorization: Bearer <api_token>, Content-Type: application/json

Тіло: id (integer) — ID номера для відключення (зі списку номерів).


POST Зміна налаштувань номера

Налаштовує переадресацію повідомлень для обраного номера.

POST https://sms-numbers.co/api/number/update

Заголовки: Authorization: Bearer <api_token>, Content-Type: application/json

Параметри тіла: id (обов'язковий), email, number, user_tag (опціонально).


API для повідомлень

GET https://sms-numbers.co/api/messages — Список повідомлень

GET https://sms-numbers.co/api/app/messages — Діалоги (згруповані)

GET https://sms-numbers.co/api/app/messages/{number} — Повідомлення за номером

POST https://sms-numbers.co/api/message/send — Надіслати SMS (from, to, body)


Акаунт та платежі

GET https://sms-numbers.co/api/account/profile — Профіль

GET https://sms-numbers.co/api/account/balance — Баланс

GET https://sms-numbers.co/api/payments — Історія платежів

POST https://sms-numbers.co/api/payment/create — Створити платіж


Публічні ендпоінти (без авторизації)

GET https://sms-numbers.co/api/public/countries — Список країн

GET https://sms-numbers.co/api/public/countries/numbers — Країни з номерами

GET https://sms-numbers.co/api/public/services — Список послуг

POST https://sms-numbers.co/api/login — Вхід (email, password)

POST https://sms-numbers.co/api/register — Реєстрація


Відповіді сервера

200 - OKУспішно
400 - Bad RequestНевірні параметри запиту
401 - UnauthorizedНе авторизовано (невірний або відсутній токен)
402 - Request FailedПараметри вірні, але запит не успішний
403 - ForbiddenЗаборонено
404 - Not FoundРесурс не знайдено
429 - Too Many RequestsВичерпано ліміт запитів
500, 502, 503, 504Помилка сервера

Успішна відповідь: {"success": true, "data": {...}, "message": "..."}

Помилка: {"success": false, "message": "...", "data": {...}}

Sign up icon

Зареєструватися

Зареєструйтеся зараз, підтвердьте e-mail та отримайте тестові кошти для перевірки номерів