Документація REST API

REST API телефонних номерів

Знаходьте доступні країни й номери, переглядайте повну пропозицію та керуйте номерами, якими ви володієте.

Відкрити довідник для вашого облікового запису Розробники й автоматизація

Обирайте API та облікові дані разом

Схвалені облікові записи з профілями «Розробники й автоматизація», «Бізнес» і «Постачальники комунікаційних послуг» можуть інтегрувати ввімкнені послуги. Індивідуальному розробникові не потрібно видавати себе за компанію. Для SMS/MMS із застосунків потрібні відповідне погодження надсилання та реєстрація. Послуга «Для приватних осіб і сімей» не має доступного клієнтам API для надсилання повідомлень.

Сімейство API	Базова URL-адреса	Автентифікація та результат
Комунікації v3	`https://api.multitel.net/v3`	Схвалені облікові дані Basic; придатні надані токени лише для операцій, які їх підтримують. JSON `status` і `response`.
Реєстрація екстрених викликів	`https://api.multi.tel/emergency`	Схвалені облікові дані Basic або спеціально наданий доступ за bearer-токеном. JSON `code`, `message` і `data`.
REST-інтеграції порталу	Хост і операція, указані в довіднику розробника вашого облікового запису	Використовуйте задокументовані для цієї операції облікові дані, області доступу та схему. Запити із сеансу браузера використовують окремий інтерфейс.

Перш ніж використовувати приклади, задайте MULTITEL_API_USERNAME і MULTITEL_API_PASSWORD через конфігурацію секретів вашого сервера. Ніколи не вбудовуйте їх у публічний JavaScript для браузера, URL-адреси чи систему контролю версій. Окремими обліковими даними можна керувати в розділі налаштувань інтеграції API.

Читання каталогу доступних країн

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getcountries"

Відповідь v3 містить status і масив response. Записи країн включають isocode, name, countrycode, відомості про можливості та next_function. Доступність залежить від облікового запису та наявного запасу номерів; наявність країни не є обіцянкою, що кожен префікс чи тип номера є в наявності.

{
  "status": {
    "code": 200,
    "msg": "Results: 1"
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "37.0902",
      "longitude": "-95.7129",
      "next_function": "v3/getareas/US"
    }
  ]
}

Від пошуку до активації

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

Покрокове керівництво з купівлі номера Вимоги до реєстрації за країнами Канали та включені хвилини

Обробка помилок і повторних спроб

Збій автентифікації або дозволів: Перевірте, чи ввімкнено облікові дані API, яку послугу дозволено та які обмеження діють для IP-адреси джерела. Cookie сеансу порталу не є обліковими даними для інтеграції.
Недостатньо коштів або невиконане погодження: Перш ніж повторювати операцію, усуньте проблему з балансом рахунку, погодженням надсилання або вимогою щодо документів.
Немає результату: Сприймайте порожній перелік номерів або відсутнє ім’я абонента як звичайний результат. Не припускайте, що синтаксично коректний номер має всі служби.
Тайм-аут мережі або збій служби: Для читання використовуйте обмежену кількість повторних спроб із затримкою, що зростає. Для купівлі, надсилання або реєстрації спершу перевірте стан операції: повторення прийнятого запиту може продублювати платну дію.

Підтримка ідемпотентності залежить від сімейства API. Emergency API підтримує ключі повторних спроб, але це не робить довільні запити v3 ідемпотентними. Зберігайте для служби підтримки часові позначки, повернуті ідентифікатори та відповіді, з яких вилучено конфіденційні дані.

Продовжте з довідником вашого облікового запису

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

Каталог кінцевих точок для вашого облікового запису Консоль Communications REST Публічний документ OpenAPI для комунікацій Посібник з інтеграції OAuth