Phone Numbers - Search Available Phone Numbers

Služba:

Communication

Verze rozhraní API:

2025-02-11

Vyhledejte dostupná telefonní čísla, která si můžete koupit.

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:search?api-version=2025-02-11

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
countryCode	path	True	string	Kód země ISO 3166-2, např. USA.
endpoint	path	True	string url	Komunikační prostředek, například https://resourcename.communication.azure.com
api-version	query	True	string	Verze rozhraní API pro vyvolání

Text požadavku

Name	Vyžadováno	Typ	Description
assignmentType	True	PhoneNumberAssignmentType	Typ zadání telefonních čísel, která chcete vyhledat. Telefonní číslo může být přiřazeno osobě nebo aplikaci.
capabilities	True	PhoneNumberCapabilities	Možnosti telefonního čísla
phoneNumberType	True	PhoneNumberType	Typ telefonních čísel, která se mají vyhledat, např. zeměpisné číslo nebo tollFree.
areaCode		string	Směrové číslo oblasti požadovaného telefonního čísla, např. 425.
quantity		integer	Množství požadovaných telefonních čísel. Výchozí hodnota je 1.

Odpovědi

Name	Typ	Description
202 Accepted	PhoneNumberSearchResult	Služba žádost přijala a začne ji později zpracovávat. Okamžitě se vrátí akceptovaná a bude obsahovat hlavičky Operation-Location (Umístění operace) a Location (Umístění). Na straně klienta by se měl stav operace dále dotazovat pomocí adresy URL zadané v hlavičce Operation-Location. Po úspěšném dokončení operace se konečný výsledek dotazu pomocí adresy URL zadané v hlavičce Umístění. Hlavičky Location: string Operation-Location: string operation-id: string search-id: string
Other Status Codes	CommunicationErrorResponse	Selhání

Příklady

Search for phone numbers

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

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"
}

Definice

Name	Description
BillingFrequency	Frekvence, s jakou se náklady účtují.
CommunicationError	Chyba Komunikační služby.
CommunicationErrorResponse	Chyba Komunikační služby.
Error	Mapování chybových zpráv na kódy
PhoneNumberAssignmentType	Představuje typ přiřazení nabídky.
PhoneNumberCapabilities	Možnosti telefonního čísla
PhoneNumberCapabilityType	Hodnota schopností pro volání
PhoneNumberCost	Náklady na jedno telefonní číslo.
PhoneNumberSearchRequest	Představuje žádost o hledání telefonních čísel k vyhledání telefonních čísel. Nalezená telefonní čísla se dočasně uchovávají pro následující nákup.
PhoneNumberSearchResult	Výsledek operace hledání telefonního čísla.
PhoneNumberType	Představuje typ čísla nabídky.

BillingFrequency

Frekvence, s jakou se náklady účtují.

Name	Typ	Description
monthly	string

CommunicationError

Chyba Komunikační služby.

Name	Typ	Description
code	string	Kód chyby.
details	CommunicationError[]	Další podrobnosti o konkrétních chybách, které vedly k této chybě.
innererror	CommunicationError	Vnitřní chyba, pokud existuje.
message	string	Chybová zpráva.
target	string	Cíl chyby.

CommunicationErrorResponse

Chyba Komunikační služby.

Name	Typ	Description
error	CommunicationError	Chyba Komunikační služby.

Error

Mapování chybových zpráv na kódy

Name	Typ	Description
AllNumbersNotAcquired	string
AuthorizationDenied	string
BillingUnavailable	string
InvalidAddress	string
InvalidOfferModel	string
MissingAddress	string
NoError	string
NoWallet	string
NotEnoughCredit	string
NotEnoughLicenses	string
NumbersPartiallyAcquired	string
OutOfStock	string
ProvisioningFailed	string
PurchaseFailed	string
ReservationExpired	string
UnknownErrorCode	string
UnknownSearchError	string

PhoneNumberAssignmentType

Představuje typ přiřazení nabídky.

Name	Typ	Description
application	string
person	string

PhoneNumberCapabilities

Možnosti telefonního čísla

Name	Typ	Description
calling	PhoneNumberCapabilityType	Hodnota schopností pro volání
sms	PhoneNumberCapabilityType	Hodnota schopností pro SMS.

PhoneNumberCapabilityType

Hodnota schopností pro volání

Name	Typ	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Náklady na jedno telefonní číslo.

Name	Typ	Description
amount	number	Částka nákladů.
billingFrequency	BillingFrequency	Frekvence, s jakou se náklady účtují.
currencyCode	string	Kód měny ISO 4217 pro částku nákladů, např. USD.

PhoneNumberSearchRequest

Představuje žádost o hledání telefonních čísel k vyhledání telefonních čísel. Nalezená telefonní čísla se dočasně uchovávají pro následující nákup.

Name	Typ	Default value	Description
areaCode	string		Směrové číslo oblasti požadovaného telefonního čísla, např. 425.
assignmentType	PhoneNumberAssignmentType		Typ zadání telefonních čísel, která chcete vyhledat. Telefonní číslo může být přiřazeno osobě nebo aplikaci.
capabilities	PhoneNumberCapabilities		Možnosti telefonního čísla
phoneNumberType	PhoneNumberType		Typ telefonních čísel, která se mají vyhledat, např. zeměpisné číslo nebo tollFree.
quantity	integer	1	Množství požadovaných telefonních čísel. Výchozí hodnota je 1.

PhoneNumberSearchResult

Výsledek operace hledání telefonního čísla.

Name	Typ	Description
assignmentType	PhoneNumberAssignmentType	Typ zadání telefonního čísla
capabilities	PhoneNumberCapabilities	Možnosti telefonního čísla
cost	PhoneNumberCost	Náklady na jedno telefonní číslo.
error	Error	Mapování chybových zpráv na kódy
errorCode	integer	Kód chyby hledání.
phoneNumberType	PhoneNumberType	Typ telefonního čísla, např. zeměpisné číslo nebo tollFree.
phoneNumbers	string[]	Telefonní čísla, která jsou k dispozici. Může být menší než požadované množství hledání.
searchExpiresBy	string	Datum vypršení platnosti tohoto výsledku hledání a telefonní čísla už nejsou blokována. Výsledek hledání vyprší za méně než 15 minut, například 2020-11-19T16:31:49.048Z.
searchId	string	ID hledání.

PhoneNumberType

Představuje typ čísla nabídky.

Name	Typ	Description
geographic	string
tollFree	string