Phone Numbers - Get Search Result

Usługa:

Communication

Wersja interfejsu API:

2025-02-11

Pobiera wynik wyszukiwania numeru telefonu według identyfikatora wyszukiwania.

GET {endpoint}/availablePhoneNumbers/searchResults/{searchId}?api-version=2025-02-11

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Zasób komunikacji, na przykład https://resourcename.communication.azure.com
searchId	path	True	string	Identyfikator wyszukiwania.
api-version	query	True	string	Wersja interfejsu API do wywołania

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PhoneNumberSearchResult	Sukces
Other Status Codes	CommunicationErrorResponse	Niepowodzenie

Przykłady

Get PhoneNumber Search Result

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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",
  "errorCode": 1000,
  "error": "OutOfStock"
}

Definicje

Nazwa	Opis
BillingFrequency	Częstotliwość naliczania opłat za koszt.
CommunicationError	Błąd usług komunikacyjnych.
CommunicationErrorResponse	Błąd usług komunikacyjnych.
Error	Mapowanie komunikatów o błędach na kody
PhoneNumberAssignmentType	Reprezentuje typ przypisania oferty.
PhoneNumberCapabilities	Możliwości numeru telefonu.
PhoneNumberCapabilityType	Wartość możliwości wywołania.
PhoneNumberCost	Naliczony koszt pojedynczego numeru telefonu.
PhoneNumberSearchResult	Wynik operacji wyszukiwania numeru telefonu.
PhoneNumberType	Reprezentuje typ liczbowy oferty.

BillingFrequency

Enumeration

Częstotliwość naliczania opłat za koszt.

Wartość	Opis
monthly

CommunicationError

Object

Błąd usług komunikacyjnych.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	CommunicationError[]	Dalsze szczegółowe informacje o konkretnych błędach, które doprowadziły do tego błędu.
innererror	CommunicationError	Wewnętrzny błąd, jeśli istnieje.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

CommunicationErrorResponse

Object

Błąd usług komunikacyjnych.

Nazwa	Typ	Opis
error	CommunicationError	Błąd usług komunikacyjnych.

Error

Enumeration

Mapowanie komunikatów o błędach na kody

Wartość	Opis
AllNumbersNotAcquired
AuthorizationDenied
BillingUnavailable
InvalidAddress
InvalidOfferModel
MissingAddress
NoError
NoWallet
NotEnoughCredit
NotEnoughLicenses
NumbersPartiallyAcquired
OutOfStock
ProvisioningFailed
PurchaseFailed
ReservationExpired
UnknownErrorCode
UnknownSearchError

PhoneNumberAssignmentType

Enumeration

Reprezentuje typ przypisania oferty.

Wartość	Opis
application
person

PhoneNumberCapabilities

Object

Możliwości numeru telefonu.

Nazwa	Typ	Opis
calling	PhoneNumberCapabilityType	Wartość możliwości wywołania.
sms	PhoneNumberCapabilityType	Wartość możliwości dla wiadomości SMS.

PhoneNumberCapabilityType

Enumeration

Wartość możliwości wywołania.

Wartość	Opis
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Object

Naliczony koszt pojedynczego numeru telefonu.

Nazwa	Typ	Opis
amount	number	Kwota kosztu.
billingFrequency	BillingFrequency	Częstotliwość naliczania opłat za koszt.
currencyCode	string	Kod waluty ISO 4217 dla kwoty kosztu, np. USD.

PhoneNumberSearchResult

Object

Wynik operacji wyszukiwania numeru telefonu.

Nazwa	Typ	Opis
assignmentType	PhoneNumberAssignmentType	Typ przypisania numeru telefonu.
capabilities	PhoneNumberCapabilities	Możliwości numeru telefonu.
cost	PhoneNumberCost	Naliczony koszt pojedynczego numeru telefonu.
error	Error	Mapowanie komunikatów o błędach na kody
errorCode	integer	Kod błędu wyszukiwania.
phoneNumberType	PhoneNumberType	Typ numeru telefonu, np. geograficzny lub bezpłatny.
phoneNumbers	string[]	Dostępne numery telefonów. Może być mniejsza niż żądana ilość wyszukiwania.
searchExpiresBy	string	Data wygaśnięcia tego wyniku wyszukiwania i numery telefonów nie są już wstrzymane. Wynik wyszukiwania wygasa w mniej niż 15 minut, np. 2020-11-19T16:31:49.048Z.
searchId	string	Identyfikator wyszukiwania.

PhoneNumberType

Enumeration

Reprezentuje typ liczbowy oferty.

Wartość	Opis
geographic
tollFree