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

Phone Numbers - Get Search Result

Служба:
Communication
Версия API:
2025-06-01

Возвращает результат поиска по номеру телефона по идентификатору поиска.

GET {endpoint}/availablePhoneNumbers/searchResults/{searchId}?api-version=2025-06-01

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (url)

Ресурс связи, например https://resourcename.communication.azure.com
searchId
 path True

string

Идентификатор поиска.
api-version
 query True

string

Версия API для вызова

Ответы

Имя Тип Описание
200 OK

PhoneNumberSearchResult

Успех
Other Status Codes

CommunicationErrorResponse

Неудача

Примеры

Get PhoneNumber Search Result

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

GET https://resourcename.communication.azure.com//availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28?api-version=2025-06-01

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

Код состояния:
200 
{
  "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",
  "isAgreementToNotResellRequired": false,
  "errorCode": 1000,
  "error": "OutOfStock"
}

Определения

Имя Описание
BillingFrequency

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

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

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

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

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

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

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

Плата за один номер телефона.
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.

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