Phone Numbers - Search Available Phone Numbers

Служба:: Communication

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

Найдите доступные номера телефонов для покупки.

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:search?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 для вызова

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

Имя	Обязательно	Тип	Описание
assignmentType	True	PhoneNumberAssignmentType	Тип назначения номеров телефонов для поиска. Номер телефона можно назначить пользователю или приложению.
capabilities	True	PhoneNumberCapabilities	Возможности номера телефона.
phoneNumberType	True	PhoneNumberType	Тип номеров телефонов для поиска, например географических, tollFree, мобильных устройств.
areaCode		string	Код области требуемого номера телефона, например 425.
quantity		integer (int32) minimum: 1 maximum: 2147483647	Количество нужных номеров телефонов. Значение по умолчанию — 1.

Ответы

Имя	Тип	Описание
202 Accepted	PhoneNumberSearchResult	Служба приняла запрос и начнет обработку позже. Он возвращает "Принято" немедленно и включает заголовки Operation-Location и Location. Клиентская сторона должна дополнительно запрашивать состояние операции с помощью URL-адреса, указанного в заголовке Operation-Location. Когда операция завершится успешно, выполните запрос к окончательному результату с помощью URL-адреса, указанного в заголовке Location. Заголовки Location: string Operation-Location: string operation-id: string search-id: string
Other Status Codes	CommunicationErrorResponse	Неудача

Имя

Тип

Описание

202 Accepted

PhoneNumberSearchResult

Служба приняла запрос и начнет обработку позже. Он возвращает "Принято" немедленно и включает заголовки Operation-Location и Location. Клиентская сторона должна дополнительно запрашивать состояние операции с помощью URL-адреса, указанного в заголовке Operation-Location. Когда операция завершится успешно, выполните запрос к окончательному результату с помощью URL-адреса, указанного в заголовке Location.

Заголовки

Location: string
Operation-Location: string
operation-id: string
search-id: string

Other Status Codes

CommunicationErrorResponse

Неудача

Примеры

Search for phone numbers

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

HTTP

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

{
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "areaCode": "425",
  "quantity": 1
}

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

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

Operation-Location: /phoneNumbers/operations/search_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28
operation-id: search_378ddf60-81be-452a-ba4f-613198ea6c28
search-id: 378ddf60-81be-452a-ba4f-613198ea6c28

{
  "searchId": "378ddf60-81be-452a-ba4f-613198ea6c28",
  "phoneNumbers": [
    "+18001212121"
  ],
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "cost": {
    "amount": 1.2,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  },
  "searchExpiresBy": "2020-11-19T16:31:49.048Z"
}

Определения

Имя	Описание
BillingFrequency	Частота выставления счетов за счет.
CommunicationError	Ошибка служб коммуникации.
CommunicationErrorResponse	Ошибка служб коммуникации.
Error	Сопоставление сообщений об ошибках с кодами
PhoneNumberAssignmentType	Представляет тип назначения предложения.
PhoneNumberCapabilities	Возможности номера телефона.
PhoneNumberCapabilityType	Значение возможности для вызова.
PhoneNumberCost	Плата за один номер телефона.
PhoneNumberSearchRequest	Представляет запрос на поиск номеров телефонов для поиска номеров телефонов. Найденные номера телефонов временно удерживаются для следующей покупки.
PhoneNumberSearchResult	Результат операции поиска номера телефона.
PhoneNumberType	Представляет тип числа предложения.

BillingFrequency

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

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

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

CommunicationError

Object

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

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

CommunicationErrorResponse

Object

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

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

Error

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

Сопоставление сообщений об ошибках с кодами

Значение	Описание
NoError
UnknownErrorCode
OutOfStock
AuthorizationDenied
MissingAddress
InvalidAddress
InvalidOfferModel
NotEnoughLicenses
NoWallet
NotEnoughCredit
NumbersPartiallyAcquired
AllNumbersNotAcquired
ReservationExpired
PurchaseFailed
BillingUnavailable
ProvisioningFailed
UnknownSearchError

PhoneNumberAssignmentType

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

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

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

PhoneNumberCapabilities

Object

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

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

PhoneNumberCapabilityType

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

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

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

PhoneNumberCost

Object

Плата за один номер телефона.

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

PhoneNumberSearchRequest

Object

Представляет запрос на поиск номеров телефонов для поиска номеров телефонов. Найденные номера телефонов временно удерживаются для следующей покупки.

Имя	Тип	Default value	Описание
areaCode	string		Код области требуемого номера телефона, например 425.
assignmentType	PhoneNumberAssignmentType		Тип назначения номеров телефонов для поиска. Номер телефона можно назначить пользователю или приложению.
capabilities	PhoneNumberCapabilities		Возможности номера телефона.
phoneNumberType	PhoneNumberType		Тип номеров телефонов для поиска, например географических, tollFree, мобильных устройств.
quantity	integer (int32) minimum: 1 maximum: 2147483647	1	Количество нужных номеров телефонов. Значение по умолчанию — 1.

PhoneNumberSearchResult

Object

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

Имя	Тип	Описание
assignmentType	PhoneNumberAssignmentType	Тип назначения номера телефона.
capabilities	PhoneNumberCapabilities	Возможности номера телефона.
cost	PhoneNumberCost	Плата за один номер телефона.
error	Error	Сопоставление сообщений об ошибках с кодами
errorCode	integer (int32)	Код ошибки поиска.
isAgreementToNotResellRequired	boolean	Указывает, требуется ли не перепродать соглашение. Если значение true, номера телефонов не могут быть приобретены, если клиент не предоставляет явное соглашение, чтобы не перепродать их.
phoneNumberType	PhoneNumberType	Тип телефона, например географический, tollFree, mobile.
phoneNumbers	string[]	Доступные номера телефонов. Может быть меньше требуемого количества поиска.
searchExpiresBy	string (date-time)	Дата истечения срока действия этого результата поиска, а номера телефонов больше не удерживаются. Срок действия результата поиска превышает 15 мин, например 2020-11-19T16:31:49.048Z.
searchId	string	Идентификатор поиска.

PhoneNumberType

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

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

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

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

Phone Numbers - Search Available Phone Numbers

Параметры URI

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

Ответы

Примеры

Search for phone numbers

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

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

Определения

BillingFrequency

CommunicationError

CommunicationErrorResponse

Error

PhoneNumberAssignmentType

PhoneNumberCapabilities

PhoneNumberCapabilityType

PhoneNumberCost

PhoneNumberSearchRequest

PhoneNumberSearchResult

PhoneNumberType