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

Phone Numbers - Get By Number

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

Получает сведения о указанном приобретенном номере телефона.

GET {endpoint}/phoneNumbers/{phoneNumber}?api-version=2025-06-01

Параметры URI

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

string (url)

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

string

Приобретенный номер телефона, сведения о которых необходимо получить в формате E.164, например +11234567890.
api-version
 query True

string

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

Ответы

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

PurchasedPhoneNumber

Успех
Other Status Codes

CommunicationErrorResponse

Неудача

Примеры

Fetch purchased phone number

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

GET https://resourcename.communication.azure.com//phoneNumbers/+11234567890?api-version=2025-06-01

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

Код состояния:
200 
{
  "id": "11234567890",
  "phoneNumber": "+11234567890",
  "countryCode": "US",
  "assignmentType": "person",
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "inbound+outbound",
    "sms": "inbound"
  },
  "purchaseDate": "2020-11-19T16:31:49.048Z",
  "cost": {
    "amount": 0.8,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  }
}

Определения

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

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

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

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

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

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

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

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

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

Представляет приобретенный номер телефона.

BillingFrequency

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

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

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

CommunicationError

Object

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

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

string

Код ошибки.
details

CommunicationError[]

Дополнительные сведения об определенных ошибках, которые привели к этой ошибке.
innererror

CommunicationError

Внутренняя ошибка, если она есть.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

CommunicationErrorResponse

Object

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

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

CommunicationError

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

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.

PhoneNumberType

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

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

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

PurchasedPhoneNumber

Object

Представляет приобретенный номер телефона.

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

PhoneNumberAssignmentType

Тип назначения номера телефона. Номер телефона можно назначить пользователю или приложению.
capabilities

PhoneNumberCapabilities

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

PhoneNumberCost

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

string

Код ISO 3166-2 страны телефона, например США.
id

string

Идентификатор номера телефона, например 11234567890.
phoneNumber

string

Строка формата E.164 номера телефона, например +11234567890.
phoneNumberType

PhoneNumberType

Тип телефона, например географический, tollFree, mobile.
purchaseDate

string (date-time)

Дата и время приобретения номера телефона.