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

GET/v3/numberinfo/{number}

Получение данных об одном приобретённом номере

Получение сохранённой конфигурации, флагов возможностей и устаревших справочных полей приобретённого телефонного номера.

На этой странице
  1. Запрос
  2. Ответ
  3. Подходящий номер не найден
  4. Использование результата

Получение одной записи о приобретённом номере и его сохранённой конфигурации. Эта операция возвращает объект, тогда как конечная точка inventory возвращает массив.

Запрос

Используйте учётные данные API на стороне сервера и передавайте их по HTTPS. В примерах учётные данные считываются из переменных окружения; действующих учётных данных в них нет. Проверяйте status.code в теле JSON, а также статус HTTP. Эти устаревшие обработчики не всегда устанавливают статус ошибки HTTP при ошибке приложения.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/numberinfo/12025550100"

Обязательный сегмент пути — сохранённый телефонный номер в международном формате, а не его UUID или внутренний номер АТС. Этот обработчик не использует параметры запроса или тело запроса.

Ответ

Это пример структуры ответа, а не данные учётной записи или актуальное ценовое предложение.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550100",
    "uuid": "NUMBER_UUID",
    "description": "Main reception",
    "isocode": "US",
    "config": {
      "uri": "sip:reception@example.com",
      "uri2": "",
      "uri3": "",
      "forward_destination": "",
      "sms_uri": "",
      "sms_forward_destination": ""
    },
    "features": {
      "voice": "1",
      "sms": "1",
      "mms": "0"
    },
    "status": {
      "capacity": {
        "assigned_channels": "2",
        "used_channels": "0",
        "overflow": "0",
        "overage_charge": "0.01"
      },
      "origination": {
        "origination_trunk_id": "ORIGINATION_ID",
        "origination_trunk_name": "ORIGINATION_NAME",
        "origination_country_iso": "US",
        "origination_continent_iso": "NA",
        "origination_continent_name": "North America"
      },
      "service_active": "1",
      "force_codec": "",
      "force_dtmf": ""
    },
    "billing": {
      "cnam": "0",
      "overflow": "0",
      "autorenew": "1",
      "persistent": "0",
      "date_created": "2026-01-01 00:00:00"
    },
    "price": {
      "setup_price": "0.00",
      "monthly_price": "1.00",
      "per_minute": "0.01",
      "free_minutes": "0",
      "remaining_minutes": "0",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}
Возвращаемые поля номера
ПолеЗначение
number, uuid, description, isocodeСохранённый телефонный номер, непрозрачный идентификатор номера, описание и код страны.
configСохранённые поля направлений голосовых вызовов, внешней переадресации, направления SMS и переадресации SMS. Эта конечная точка не изменяет их.
featuresСохранённые флаги поддержки голосовых вызовов, SMS и MMS. Не гарантируется, что устаревшие сохранённые флаги имеют логический тип JSON.
status.capacityКоличество выделенных и используемых каналов, настройка переполнения и сохранённая плата за превышение лимита. Это сохранённые метаданные, а не актуальное предложение по ёмкости каналов или проверка реального вызова.
status.originationСохранённые метаданные источника входящих вызовов. Считайте идентификаторы непрозрачными; не стройте логику приложения на основе внутренних имён.
status.service_active, force_codec, force_dtmfСохранённые поля активации и настройки медиапотоков. Сам по себе флаг не подтверждает успешную доставку входящего трафика.
billingСохранённые значения CNAM, переполнения, продления, постоянного сохранения и создания. Их чтение не изменяет настройки продления или другие настройки выставления счетов.
priceСохранённые цены подключения, ежемесячной абонентской платы и минуты разговора, а также лимиты минут. Обработчик не предоставляет поле валюты или актуальное ценовое предложение. Не определяйте валюту по значениям из примера и не используйте их как актуальное ценовое предложение для покупки.

По сравнению с inventory, эта конечная точка также возвращает needs_registration, vrating, country_id, area_id, provider_id и price.perminute_charges. Это устаревшие сохранённые значения, а не отдельный ответ об одобрении проверки личности. Справочные идентификаторы следует считать непрозрачными; не составляйте на их основе URL для обнаружения ресурсов и не определяйте соответствия провайдерам без соответствующего ответа механизма обнаружения.

Подходящий номер не найден

Если для учётной записи, прошедшей аутентификацию, не найдена соответствующая неаннулированная запись, тело JSON содержит status.code 404 и сообщение, содержащее number not found. Не полагайтесь на суффикс сообщения, указывающий строку исходного кода. Перед повторной попыткой проверьте сохранённый номер и inventory.

Использование результата

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