Phone Numbers - Browse Available Numbers

Служба:: Communication

Версия API:: 2025-06-01

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

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:browse?api-version=2025-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
countryCode	path	True	string	Код страны ISO 3166-2, например США.
endpoint	path	True	string (url)	Ресурс связи, например https://resourcename.communication.azure.com
api-version	query	True	string	Версия API для вызова

Текст запроса

Имя	Обязательно	Тип	Описание
phoneNumberType	True	PhoneNumberType	Представляет тип числа предложения.
assignmentType		PhoneNumberAssignmentType	Представляет тип назначения предложения. Также называется вариантом использования.
capabilities		PhoneNumberBrowseCapabilitiesRequest	Минимальные необходимые возможности для запроса операции обзора.
phoneNumberPrefixes		string[]	Префикс номера телефона, соответствующий. Если задано, поиск будет ограничен номерами телефонов, начинающимися с любого из заданных префиксов.

Ответы

Имя	Тип	Описание
200 OK	PhoneNumbersBrowseResult	Случайный список номеров телефонов, доступных для покупки, соответствующий критериям просмотра.
Other Status Codes	CommunicationErrorResponse	Неудача

Примеры

Browse available phone numbers

Образец запроса

HTTP

POST https://resourcename.communication.azure.com/availablePhoneNumbers/countries/US/:browse?api-version=2025-06-01

{
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "outbound",
    "sms": "none"
  },
  "assignmentType": "person",
  "phoneNumberPrefixes": [
    "1425",
    "1626"
  ]
}

Пример ответа

Код состояния:: 200

{
  "phoneNumbers": [
    {
      "id": "14254567890",
      "countryCode": "US",
      "phoneNumber": "+14254567890",
      "capabilities": {
        "calling": "outbound",
        "sms": "none"
      },
      "phoneNumberType": "geographic",
      "assignmentType": "person",
      "cost": {
        "amount": 1,
        "currencyCode": "USD",
        "billingFrequency": "monthly"
      },
      "status": "available",
      "isAgreementToNotResellRequired": false
    },
    {
      "id": "16264567890",
      "countryCode": "US",
      "phoneNumber": "+16264567890",
      "capabilities": {
        "calling": "outbound",
        "sms": "none"
      },
      "phoneNumberType": "geographic",
      "assignmentType": "person",
      "cost": {
        "amount": 1,
        "currencyCode": "USD",
        "billingFrequency": "monthly"
      },
      "status": "available",
      "isAgreementToNotResellRequired": false
    }
  ]
}

Определения

Имя	Описание
AvailablePhoneNumber	Представляет номер телефона, доступный в инвентаризации
AvailablePhoneNumberError	Содержит сведения об ошибке в случае сбоя при резервирования, освобождении или покупке номера телефона. Обратите внимание, что это игнорируется службой при наличии в запросах.
AvailablePhoneNumberStatus	Представляет состояние номера телефона. Возможные значения включают: "available", "зарезервировано", "истек срок действия", "ошибка", "приобретено".
BillingFrequency	Частота выставления счетов за счет.
CommunicationError	Ошибка служб коммуникации.
CommunicationErrorResponse	Ошибка служб коммуникации.
Cost	Расходы на этот номер телефона.
PhoneNumberAssignmentType	Представляет тип назначения предложения.
PhoneNumberBrowseCapabilitiesRequest	Минимальные необходимые возможности для запроса операции обзора.
PhoneNumberCapabilities	Возможности номера телефона.
PhoneNumberCapabilityType	Значение возможности для вызова.
PhoneNumbersBrowseRequest	Параметры операции обзора.
PhoneNumbersBrowseResult	Результат операции просмотра номера телефона.
PhoneNumberType	Представляет тип числа предложения.

AvailablePhoneNumber

Object

Представляет номер телефона, доступный в инвентаризации

Имя	Тип	Описание
assignmentType	PhoneNumberAssignmentType	Представляет тип назначения предложения. Также называется вариантом использования.
capabilities	PhoneNumberCapabilities	Возможности номера телефона.
cost	Cost	Расходы на этот номер телефона.
countryCode	string	Код страны ISO 3166-2, например США.
error	AvailablePhoneNumberError	Содержит сведения об ошибке в случае сбоя при резервирования, освобождении или покупке номера телефона. Обратите внимание, что это игнорируется службой при наличии в запросах.
id	string	Идентификатор номера телефона.
isAgreementToNotResellRequired	boolean	Указывает, требуется ли не перепродать соглашение. Если значение true, номер телефона не может быть получен, если клиент не предоставляет явное соглашение о том, чтобы не перепродать его.
phoneNumber	string	Номер телефона в формате E.164, например +11234567890.
phoneNumberType	PhoneNumberType	Представляет тип числа предложения.
status	AvailablePhoneNumberStatus	Представляет состояние номера телефона. Возможные значения включают: "available", "зарезервировано", "истек срок действия", "ошибка", "приобретено".

AvailablePhoneNumberError

Object

Содержит сведения об ошибке в случае сбоя при резервирования, освобождении или покупке номера телефона. Обратите внимание, что это игнорируется службой при наличии в запросах.

Имя	Тип	Описание
code	string	Код ошибки, указывающий причину сбоя операции, выполняемой на номере телефона.
message	string	Сообщение об ошибке, описывающее сбой, который произошел.

AvailablePhoneNumberStatus

Перечисление

Представляет состояние номера телефона. Возможные значения включают: "available", "зарезервировано", "истек срок действия", "ошибка", "приобретено".

Значение	Описание
available
reserved
expired
error
purchased

BillingFrequency

Перечисление

Частота выставления счетов за счет.

Значение	Описание
monthly

CommunicationError

Object

Ошибка служб коммуникации.

Имя	Тип	Описание
code	string	Код ошибки.
details	CommunicationError[]	Дополнительные сведения об определенных ошибках, которые привели к этой ошибке.
innererror	CommunicationError	Внутренняя ошибка, если она есть.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

CommunicationErrorResponse

Object

Ошибка служб коммуникации.

Имя	Тип	Описание
error	CommunicationError	Ошибка служб коммуникации.

Cost

Object

Расходы на этот номер телефона.

Имя	Тип	Описание
amount	number (double)	Сумма затрат.
billingFrequency	BillingFrequency	Частота выставления счетов за счет.
currencyCode	string	Код валюты ISO 4217 для суммы затрат, например USD.

PhoneNumberAssignmentType

Перечисление

Представляет тип назначения предложения.

Значение	Описание
person
application

PhoneNumberBrowseCapabilitiesRequest

Object

Минимальные необходимые возможности для запроса операции обзора.

Имя	Тип	Описание
calling	PhoneNumberCapabilityType	Значение возможности для вызова.
sms	PhoneNumberCapabilityType	Значение возможности для SMS.

PhoneNumberCapabilities

Object

Возможности номера телефона.

Имя	Тип	Описание
calling	PhoneNumberCapabilityType	Значение возможности для вызова.
sms	PhoneNumberCapabilityType	Значение возможности для SMS.

PhoneNumberCapabilityType

Перечисление

Значение возможности для вызова.

Значение	Описание
none
inbound
outbound
inbound+outbound

PhoneNumbersBrowseRequest

Object

Параметры операции обзора.

Имя	Тип	Описание
assignmentType	PhoneNumberAssignmentType	Представляет тип назначения предложения. Также называется вариантом использования.
capabilities	PhoneNumberBrowseCapabilitiesRequest	Минимальные необходимые возможности для запроса операции обзора.
phoneNumberPrefixes	string[]	Префикс номера телефона, соответствующий. Если задано, поиск будет ограничен номерами телефонов, начинающимися с любого из заданных префиксов.
phoneNumberType	PhoneNumberType	Представляет тип числа предложения.

PhoneNumbersBrowseResult

Object

Результат операции просмотра номера телефона.

Имя	Тип	Описание
phoneNumbers	AvailablePhoneNumber[]	Номера телефонов, доступные для покупки.

PhoneNumberType

Перечисление

Представляет тип числа предложения.

Значение	Описание
geographic
tollFree
mobile

Поделиться через

Phone Numbers - Browse Available Numbers

Параметры URI

Текст запроса

Ответы

Примеры

Browse available phone numbers

Образец запроса

Пример ответа

Определения

AvailablePhoneNumber

AvailablePhoneNumberError

AvailablePhoneNumberStatus

BillingFrequency

CommunicationError

CommunicationErrorResponse

Cost

PhoneNumberAssignmentType

PhoneNumberBrowseCapabilitiesRequest

PhoneNumberCapabilities

PhoneNumberCapabilityType

PhoneNumbersBrowseRequest

PhoneNumbersBrowseResult

PhoneNumberType