Интеграция с сервисом (HTTP/HTTPS API)
Описание API для СМС-рассылки и СМС-номеров
- Зарегистрируйтесь на сайте или войдите в личный кабинет, если уже зарегистрировались;
- Перейдите на страницу API и нажмите кнопку "Активировать API";
- Ознакомьтесь с методами API ниже;
- Скопируйте ключ API и используйте его для авторизации API приложения;
- Для методов Подключение номера, Отправить Сообщение пополните свой баланс;
API для работы с номерами
GET Список номеров
Данный метод возвращает список номеров для Вашего аккаунта
GET https://sms-numbers.co/api/numbers
Описание параметров, передаваемых Серверу:
| Название параметра | Описание |
|---|---|
| api_token (string) | Обязательный API-ключ, полученный в Личном кабинете или с помощью метода Логин |
GET Поиск номеров доступных для подключения
Данный метод возвращает список номеров доступных для подключения
GET https://sms-numbers.co/api/numbers/search
Описание параметров, передаваемых Серверу:
| Название параметра | Описание |
|---|---|
| api_token (string) | Обязательный API-ключ, полученный в Личном кабинете или с помощью метода Логин |
| country (string) | Обязательный Двухзначный код страны для фильтрации (в формате ISO 3166-1 alpha-2) |
POST Подключение номера
Данный метод позволяет подключить выбранный номер
POST https://sms-numbers.co/api/number/buy
Описание параметров, передаваемых Серверу:
| Название параметра | Описание |
|---|---|
| api_token (string) | Обязательный API-ключ, полученный в Личном кабинете или с помощью метода Логин |
| id (integer) | Обязательный id номера для подключения, который вернул метод Поиск номеров доступных для подключения |
POST Отключение номера
Данный метод позволяет отключить выбранный номер
POST https://sms-numbers.co/api/number/cancel
Описание параметров, передаваемых Серверу:
| Название параметра | Описание |
|---|---|
| api_token (string) | Обязательный API-ключ, полученный в Личном кабинете или с помощью метода Логин |
| id (integer) | Обязательный id номера для отключения, который вернул метод Список номеров |
| email (string) | Обязательный 0 - отключить по окончанию срока оплаты, 1 - отключить немедленно |
POST Изменение настроек номера
Данный метод позволяет настроить переадресацию сообщений для выбранного номера
POST https://sms-numbers.co/api/number/update
Описание параметров, передаваемых Серверу:
| Название параметра | Описание |
|---|---|
| api_token (string) | Обязательный API-ключ, полученный в Личном кабинете или с помощью метода Логин |
| id (integer) | Обязательный id номера для отключения, который вернул метод Список номеров |
| email (string) | необязательный email для переадресации входящих СМС для номера с id |
| phone (string) | необязательный номер телефона для переадресации входящих СМС для номера с id |
| url (string) | необязательный URL для переадресации входящих СМС для номера с id |
| telegram_enable (integer) | необязательный 0 - отключить переадресацию сообщений в Telegram, 1 - включить переадресацию сообщений в Telegram |
Ответы сервера:
| 200 - OK | Успешно. |
|---|---|
| 400 - Bad Request | Неверные переметры запроса. |
| 401 - Unauthorized | Не авторизовано. |
| 402 - Request Failed | Параметры верные, но запрос не успешен. |
| 403 - Forbidden | Запрещено. |
| 404 - Not Found | Запрошенный ресурс не найден. |
| 429 - Too Many Requests | Исчерпан лимит запросов. |
| 500, 502, 503, 504 - Server Errors | Ошибка на стороне сервера. |
Зарегистрироваться
Зерегистрируйтесь сейчас, подтвердите e-mail и получите деньги на счёт для тестирования номеров
