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

Phone Numbers - Get Reservation

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

Возвращает резервирование по идентификатору.
Извлекает резервирование с указанным идентификатором, включая все номера телефонов, связанные с ним.

GET {endpoint}/availablePhoneNumbers/reservations/{reservationId}?api-version=2025-06-01

Параметры URI

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

string (url)

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

string (uuid)

Идентификатор резервирования.
api-version
 query True

string

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

Ответы

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

PhoneNumbersReservation

Успешно извлечено резервирование.
Other Status Codes

CommunicationErrorResponse

Неудача

Примеры

Get reservation

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

GET https://resourcename.communication.azure.com/availablePhoneNumbers/reservations/65c18c7f-8074-4efb-a572-e0df127a9964?api-version=2025-06-01

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

Код состояния:
200 
{
  "id": "65c18c7f-8074-4efb-a572-e0df127a9964",
  "expiresAt": "2023-08-23T22:29:17.092Z",
  "phoneNumbers": {},
  "status": "active"
}

Определения

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

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

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

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

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

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

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

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

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

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

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

Представляет резервирование для номеров телефонов. Резервирование — это временная удержание по телефонным номерам, которые позже можно приобрести. Резервирование имеет ограниченное время существования, после которого номера телефонов освобождаются, если они не приобретены. Резервирования старше 1 месяца автоматически удаляются.
PhoneNumberType

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

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

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

PhoneNumberCapabilities

Object

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

Имя Тип Описание
calling

PhoneNumberCapabilityType

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

PhoneNumberCapabilityType

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

PhoneNumberCapabilityType

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

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

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

PhoneNumbersReservation

Object

Представляет резервирование для номеров телефонов. Резервирование — это временная удержание по телефонным номерам, которые позже можно приобрести. Резервирование имеет ограниченное время существования, после которого номера телефонов освобождаются, если они не приобретены. Резервирования старше 1 месяца автоматически удаляются.

Имя Тип Описание
expiresAt

string (date-time)

Время истечения срока действия резервирования. Если резервирование не приобретено до этого времени, все зарезервированные номера телефонов будут освобождены и предоставлены другим пользователям для покупки.
id

string (uuid)

Идентификатор резервирования.
phoneNumbers

<string,  AvailablePhoneNumber>

Словарь, содержащий номера телефонов резервирования. Ключ — это идентификатор номера телефона (только цифры), а значения — объекты AvailablePhoneNumber. Не заполняется при получении коллекций PhoneNumbersReservation.
status

ReservationStatus

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

PhoneNumberType

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

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

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

ReservationStatus

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

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

Значение Описание
active
submitted
completed
expired