Разработчикам

GET/v3/getmobilecount/{prefix_id}

Проверка мобильного запаса для станции

Получите подсчёт мобильного запаса на текущий момент для NPA/NXX, представленных подходящим префиксом. Это подсказка о доступности, а не бронирование и не гарантия покупки.

На этой странице
  1. Выберите поддерживаемый префикс
  2. Используйте подсчёт как подсказку
  3. Отличайте нулевой запас от неудачного поиска
  4. Запрос
  5. Ответ
  6. Ошибки
  7. Доступность и побочные эффекты

Выберите поддерживаемый префикс

Используйте актуальный отдельный мобильный префикс из данных обнаружения. Этот эндпоинт предназначен для станций NANPA: NPA определяет код зоны, а NXX — станцию. Префикс только с кодом зоны слишком широк. Не отправляйте сгруппированные идентификаторы отображения и не делайте вывод о поддержке другой страны лишь потому, что её префикс содержит достаточно цифр.

Используйте подсчёт как подсказку

Прочитайте response.count, с response.npa и response.nxx которые определяют станцию. Это снимок состояния сервиса покрытия, а не запас, удерживаемый для вашего аккаунта. Подтвердите фактические номера, применимые ценовые предложения и любые требования к регистрации перед заказом. Успешный подсчёт никогда не авторизует покупку.

Отличайте нулевой запас от неудачного поиска

Успешный подсчёт нуля отличается от ошибки API. Проверьте status.code и status.msg а также HTTP-статус. Воспринимайте тайм-аут или неудачный поиск как неизвестную доступность и повторите позже с нарастающими интервалами.

Запрос

Используйте учётные данные вашего активированного API-аккаунта через HTTPS. Поддерживаются Basic-аутентификация и bearer-токены активированного API-аккаунта; применяются ограничения аккаунта.

Запрос методом GET с идентификатором префикса в пути URL. Документированных параметров запроса или тела нет.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getmobilecount/$PREFIX_ID"
Параметры пути
ИмяТипОбязательныйОписание
prefix_idstringДаСкопируйте отдельный идентификатор префикса из ответа обнаружения. Используйте поддерживаемый мобильный префикс NANPA, содержащий код зоны (NPA) и станцию (NXX), а не идентификатор только кода зоны или сгруппированный сводный идентификатор. Обращайтесь с идентификатором как с непрозрачным.

Ответ

Проверьте status.code в теле JSON, а также HTTP-статус. Успешный response содержит status.code 200 и status.msg Results. response — это объект, а не список: count — целочисленный снимок запаса; npa и nxx — строки из трёх символов. status.results для этого ассоциативного объекта отсутствует. Количество 0 означает, что при поиске покрытия не найдена соответствующая станция или возвращён нулевой запас; это не доказывает, что у всех поставщиков или других маршрутов обнаружения нет номеров.

Иллюстративная форма ответа; не действующие данные аккаунта и не актуальное ценовое предложение.

{
  "status": {
    "code": 200,
    "msg": "Results"
  },
  "response": {
    "count": 42,
    "npa": "212",
    "nxx": "555"
  }
}

Ошибки

  • 404: Провайдер отключён: покрытие мобильного запаса недоступно на сервисе.
  • 404: Недействительный идентификатор префикса: получите актуальный отдельный идентификатор префикса из обнаружения.
  • 404: Недействительный префикс: сохранённый префикс не содержит достаточно цифр для поиска NPA/NXX.
  • 500: Сбой покрытия запаса: поиск в вышестоящем сервисе не вернул успешный результат покрытия. Повторите позже с нарастающими интервалами; сбой не означает нулевой запас.

Доступность и побочные эффекты

  • Операция проверяет запас и не размещает заказ, не резервирует номера и не списывает сумму покупки.
  • Запас может измениться немедленно. Подсчёт покрытия не корректируется, чтобы гарантировать возможность покупки для конкретного аккаунта или ту же длину, что и следующий ответ поиска номеров.
  • Поиск обращается к сервису покрытия и может занимать время. Не опрашивайте повторно каждый префикс и не воспринимайте тайм-аут или ошибку как успешный нулевой запас.