Получить количество номеров — API SMSCash
Возвращает доступное количество номеров по сервисам для страны и, при необходимости, конкретного оператора.
SMSCashСправочник методов API
Получить количество номеров
Возвращает доступное количество номеров по сервисам для страны и, при необходимости, конкретного оператора.
API-ключ в запросе
GET https://smscash.org/stubs/handler_api.php?api_key=APIKEY&action=getNumbersStatus&country=43&operator=1| Параметр | Тип | Обязательность | Описание | Пример |
|---|---|---|---|---|
| api_key | string | Обязательный | API-ключ. Также можно передать в заголовке X-API-Key или Authorization: Bearer. | APIKEY |
| action | string | Обязательный | Название метода | getNumbersStatus |
| country | string | Необязательный | Код страны. Обязателен, если operator не определяет конкретную страну. | 43 |
| operator | string | Необязательный | Код поставщика или код оператора, привязанного к поставщику и стране. | alpha_gb |
Пример ответа
{
"mm_0": 126,
"wa_0": 84
}operator=alpha — код поставщика из getProviders. Без country номер будет выбран из любой подходящей страны этого поставщика.
operator=alpha_gb — код оператора из getOperators. Он определяет поставщика и страну, поэтому country можно не передавать. Коды в этих примерах условные; используйте значения из справочников.
Если country указан вместе с кодом оператора, он должен соответствовать стране оператора. Иначе вернётся BAD_OPERATOR.
Без кода оператора для конкретной страны параметр country обязателен.
200 — JSON-объект: ключ сервиса и доступное количество.
Ошибки
BAD_KEY — Неверный, отозванный ключ или запрещённый IP. Проверьте ключ, доступ и IP-адрес сервера.
BANNED — Аккаунт заблокирован. Обратитесь в поддержку.
BAD_ACTION — Неизвестный метод или отсутствующий обязательный параметр. Исправьте action и обязательные параметры.
ERROR_RATE_LIMIT — Превышена частота или число одновременных запросов. Снизьте частоту и учтите Retry-After.
ERROR — Временная ошибка сервера. Примените задержку с увеличением интервала; выдачу повторяйте с тем же Idempotency-Key.
BAD_COUNTRY — Страна не найдена, отключена или телефонный код неоднозначен. Передайте api_code или буквенный code из getCountries.
BAD_OPERATOR — Оператор не найден. Проверьте getProviders или getOperators.