Розробникам

GET/v3/getmobiles/{prefix_id}/{quantity}

Пошук доступних мобільних номерів

Шукайте доступні мобільні номери, використовуючи актуальний префікс та обліковий запис з увімкненим інвентарем мобільних номерів. Перегляньте повернутий номер і тарифний план разом перед замовленням.

На цій сторінці
  1. Підтвердьте, що мобільний інвентар увімкнено
  2. Зберігайте кожен номер разом із його власним вибором ціни
  3. Використовуйте невелику додатну кількість
  4. Розрізняйте відсутність запасів і збій пошуку
  5. Перевірте повторно перед купівлею
  6. Запит
  7. Відповідь
  8. Помилки
  9. Доступність і побічні ефекти

Підтвердьте, що мобільний інвентар увімкнено

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

Поточний застарілий маршрут не відхиляє надійно кожен неприпустимий запит. Обліковий запис без увімкненого мобільного інвентаря може отримати звичайний інвентар, тоді як відповідь усе ще каже info.is_mobile: 1. Префікс безкоштовних викликів також може потрапити в гілку інвентаря безкоштовних номерів із цією міткою. Не використовуйте цю мітку самостійно для ідентифікації мобільної служби і не надсилайте звичайні або безкоштовні префікси на цю кінцеву точку. Використовуйте підтверджений мобільний каталог облікового запису та увімкнений робочий процес.

Зберігайте кожен номер разом із його власним вибором ціни

Для кожного кандидата зберігайте number, info.uuid і список цін того самого запису price разом. Відповідь також містить метадані префікса/області/країни, умови договору та реєстраційні обмеження. Кандидати відсортовані за місячною ціною першого варіанта ціни за зростанням; гарантованого стабільного порядку для однакових цін немає. Не замінюйте повернутий ідентифікатор номера на ідентифікатор області або префікса і не поєднуйте його з ідентифікатором ціни іншого кандидата.

Повна відповідь може містити додаткові метадані та поля цін. Повернуті features, значення каналів і restrictions описують кандидата; вони не є гарантією того, що дзвінки, SMS, MMS або факс уже придатні до використання. Права облікового запису, реєстрація та вибраний тарифний план усе ще застосовуються. Не вважайте заповнювачі з прикладу дійсними ідентифікаторами чи цінами.

Використовуйте невелику додатну кількість

Почніть з кількості 1. Звичайний запит до провайдера нормалізує непозитивну кількість до 1 і обмежує верхнє значення на рівні 300, але подальша обробка результатів усе ще використовує початковий ввід. Тому нульова кількість може запросити інвентар провайдера й не повернути жодного кандидата. Інші застарілі гілки не завжди дотримуються запитуваної кількості результатів. Не покладайтеся на єдиний універсальний максимум і не надсилайте від'ємні, дробові або нечислові значення. Для цього маршруту не задокументовано жодного підтримуваного публічного фільтра пошуку або параметра тіла з ідентифікатором ціни.

Розрізняйте відсутність запасів і збій пошуку

Відповідь 404 може означати недоступний інвентар, вимкнену службу, збій пошуку постачальника або неприпустимі записи каталогу. Розглядайте тайм-аут або збій провайдера як невідому доступність, а не як підтверджений нульовий запас. За потреби оновіть вибір і повторіть спробу із затримкою. Уникайте повторного опитування кожної станції. Окрема кінцева точка підрахунку мобільного інвентаря є підказкою-знімком і не зобов'язана збігатися з довжиною списку кандидатів цього облікового запису.

Перевірте повторно перед купівлею

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

Запит

Використовуйте увімкнений API-обліковий запис через HTTPS з дозволеної вихідної IP-адреси. Мобільний інвентар також має бути увімкненим для клієнтського облікового запису; самої автентифікації API недостатньо для його увімкнення.

GET з актуальним ідентифікатором індивідуального префікса та додатною цілочисельною кількістю в шляху URL. Кількість за замовчуванням дорівнює 1, якщо її опущено. Використовуйте приклад із 1; цей маршрут не забезпечує послідовної перевірки та застосування універсального ліміту результатів.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getmobiles/$PREFIX_ID/1"
Параметри шляху
НазваТипОбов'язковийОпис
prefix_idstringТакНепрозорий видимий ідентифікатор відповідного індивідуального мобільного префікса, отриманий через виявлення. Використовуйте префікс мобільної станції NPA/NXX, підтримуваний вашим обліковим записом; не підставляйте ідентифікатор області, згрупований ідентифікатор відображення, буквальний префікс набору номера або безкоштовний префікс.
quantityintegerНіЗапитувана кількість кандидатів. За замовчуванням 1. Вкажіть помірне додатне ціле число. Звичайний запит до провайдера обмежує кількість на рівні 300, але це не є універсально валідованим вводом або гарантією розміру відповіді.

Відповідь

Перевіряйте status.code і status.msg у тілі JSON, а також HTTP-статус. У разі успіху response є списком кандидатів-номерів, status.msg — це Results: з подальшою кількістю повернутих, а status.results — серіалізована довжина списку. Ціни кандидатів специфічні для облікового запису. Ілюстративний скорочений приклад використовує заповнювачі замість реального інвентаря або тарифної пропозиції. Номери містять код країни без знака плюс; ідентифікатори є непрозорими рядками.

Ілюстративна форма відповіді; не живі дані облікового запису і не актуальна пропозиція.

{
  "status": {
    "code": 200,
    "msg": "Results: 1",
    "results": 1
  },
  "response": [
    {
      "number": "12025550123",
      "info": {
        "uuid": "NUMBER_ID",
        "prefix_uuid": "PREFIX_ID",
        "country_iso": "US",
        "is_mobile": 1
      },
      "price": [
        {
          "uuid": "PRICE_ID",
          "monthly_price": "ACCOUNT_MONTHLY_PRICE",
          "setup_price": "ACCOUNT_SETUP_PRICE",
          "per_minute": "ACCOUNT_INCOMING_RATE",
          "channels": "PLAN_CHANNELS"
        }
      ],
      "features": [
        "voice",
        "sms",
        "mms",
        "t38"
      ]
    }
  ]
}

Помилки

  • 404: неприпустимий ідентифікатор префікса, країни або області: оновіть вибір індивідуального мобільного префікса.
  • 404: номерів не знайдено: може означати відсутність придатних запасів, вимкнену службу, збій пошуку провайдера, непідтримуваний вибір або обмеження облікового запису. Це не є доказом авторитетного нульового підрахунку інвентаря.

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

  • Пошук не орендує та не резервує номер, і переглянутий шлях не списує суму купівлі. Він зв'язується з постачальником інвентаря і може тривати певний час.
  • Успішні пошуки записують пов'язані з обліковим записом записи кешу номерів і цін, а також журнали запитів. Повторення пошуку не є резервуванням, фіксацією ціни або купівлею.
  • Повернуті ціни, умови, обмеження та можливості мають бути переглянуті для вибраного облікового запису й номера. Мітка можливості не підтверджує активацію, схвалення обміну повідомленнями або перевірену працездатність служби.