Розробникам

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: Помилка покриття запасу: пошук у вищому сервісі не повернув успішного результату покриття. Повторіть пізніше зі збільшенням інтервалів; помилка не означає нульовий запас.

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

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