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

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

Находите доступные страны и номера, изучайте предложение целиком и управляйте принадлежащими вам номерами.

Открыть справочник для вашего аккаунта Разработчики и автоматизация

Выбирайте API и учётные данные вместе

Одобренные аккаунты с профилями «Разработчики и автоматизация», «Бизнес» и «Операторы связи» могут интегрироваться с включёнными сервисами. Частному разработчику не нужно выдавать себя за компанию. Для SMS/MMS из приложений требуются соответствующее разрешение на отправку и регистрация. У сервиса «Для частных лиц и семей» нет доступного клиентам API для отправки сообщений.

Семейство API	Базовый URL	Аутентификация и результат
Communications v3	`https://api.multitel.net/v3`	Одобренные учётные данные Basic; выданные токены, если они допустимы, — только для операций, которые их поддерживают. В JSON — `status` и `response`.
Регистрация экстренных вызовов	`https://api.multi.tel/emergency`	Одобренные учётные данные Basic или специально выданный bearer-доступ. В JSON — `code`, `message` и `data`.
REST-интеграции портала	Хост и операция указаны в справочнике разработчика вашего аккаунта	Используйте учётные данные, области доступа (scopes) и схему, описанные для этой операции. Запросы из браузерной сессии относятся к отдельному контуру.

Перед использованием примеров задайте 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 сессии портала не является учётными данными для интеграции.
Недостаточно средств или не выполнено требование об одобрении: Прежде чем повторять операцию, устраните проблему с балансом аккаунта, разрешением на отправку или требованием о документах.
Нет результата: Пустой список номеров или отсутствие имени вызывающего абонента считайте обычным исходом. Не предполагайте, что для синтаксически корректного номера доступны все услуги.
Тайм-аут сети или сбой сервиса: Для операций чтения используйте ограниченное число повторов с задержкой (backoff). Перед повтором покупки, отправки или регистрации сначала проверьте состояние операции: повторение принятого запроса может привести к дублированию платного действия.

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

Продолжите со справочником вашей учётной записи

Справочник после входа в систему отображает только те операции, которые доступны с учётом ваших разрешений и подключённых услуг. Используйте указанные в нём точный хост, тип учётных данных, поля запроса и схему ответа. Консоли могут выполнять реальные операции, включая покупки и отправку сообщений.

Каталог конечных точек для вашей учётной записи Консоль Communications REST Общедоступный документ OpenAPI для коммуникационных сервисов Руководство по интеграции OAuth