Phone Numbers - Search Available Phone Numbers

Service:

Communication

API-versie:

2022-12-01

Zoek naar beschikbare telefoonnummers die u wilt kopen.

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:search?api-version=2022-12-01

URI-parameters

Name	In	Vereist	Type	Description
countryCode	path	True	string	De ISO 3166-2-landcode, bijvoorbeeld VS.
endpoint	path	True	string url	De communicatieresource, bijvoorbeeld https://resourcename.communication.azure.com
api-version	query	True	string	Versie van API die moet worden aangeroepen

Aanvraagbody

Name	Vereist	Type	Description
assignmentType	True	PhoneNumberAssignmentType	Het toewijzingstype van de telefoonnummers die moeten worden gezocht. Een telefoonnummer kan worden toegewezen aan een persoon of aan een toepassing.
capabilities	True	PhoneNumberCapabilities	Mogelijkheden van een telefoonnummer.
phoneNumberType	True	PhoneNumberType	Het type telefoonnummer dat moet worden gezocht, bijvoorbeeld geografisch of tollFree.
areaCode		string	Het netnummer van het gewenste telefoonnummer, bijvoorbeeld 425.
quantity		integer	Het aantal gewenste telefoonnummers. De standaardwaarde is 1.

Antwoorden

Name	Type	Description
202 Accepted	PhoneNumberSearchResult	De service heeft de aanvraag geaccepteerd en wordt later verwerkt. Het retourneert 'Geaccepteerd' onmiddellijk en bevat een header 'Operation-Location' en 'Location'. Clientzijde moet de bewerkingsstatus verder opvragen met behulp van de URL die is opgegeven in de header Operation-Location. Wanneer de bewerking is voltooid, wordt het uiteindelijke resultaat van de query uitgevoerd met behulp van de URL die is opgegeven in de header Locatie. Kopteksten Location: string Operation-Location: string operation-id: string search-id: string
Other Status Codes	CommunicationErrorResponse	Mislukking

Voorbeelden

Search for phone numbers

Voorbeeldaanvraag

HTTP

POST https://resourcename.communication.azure.com//availablePhoneNumbers/countries/US/:search?api-version=2022-12-01

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
BillingFrequency	De frequentie waarmee de kosten worden gefactureerd.
CommunicationError	De Communication Services-fout.
CommunicationErrorResponse	De Communication Services-fout.
Error	Foutberichten toewijzen aan codes
PhoneNumberAssignmentType	Vertegenwoordigt het toewijzingstype van het aanbod.
PhoneNumberCapabilities	Mogelijkheden van een telefoonnummer.
PhoneNumberCapabilityType	Mogelijkheidswaarde voor aanroepen.
PhoneNumberCost	De gemaakte kosten voor één telefoonnummer.
PhoneNumberSearchRequest	Vertegenwoordigt een zoekaanvraag voor telefoonnummers om telefoonnummers te vinden. Gevonden telefoonnummers worden tijdelijk bewaard voor een volgende aankoop.
PhoneNumberSearchResult	Het resultaat van een zoekbewerking voor telefoonnummers.
PhoneNumberType	Vertegenwoordigt het nummertype van het aanbod.

BillingFrequency

De frequentie waarmee de kosten worden gefactureerd.

Name	Type	Description
monthly	string

CommunicationError

De Communication Services-fout.

Name	Type	Description
code	string	De foutcode.
details	CommunicationError[]	Meer informatie over specifieke fouten die tot deze fout hebben geleid.
innererror	CommunicationError	De interne fout indien aanwezig.
message	string	Het foutbericht.
target	string	Het foutdoel.

CommunicationErrorResponse

De Communication Services-fout.

Name	Type	Description
error	CommunicationError	De Communication Services-fout.

Error

Foutberichten toewijzen aan codes

Name	Type	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

Vertegenwoordigt het toewijzingstype van het aanbod.

Name	Type	Description
application	string
person	string

PhoneNumberCapabilities

Mogelijkheden van een telefoonnummer.

Name	Type	Description
calling	PhoneNumberCapabilityType	Mogelijkheidswaarde voor aanroepen.
sms	PhoneNumberCapabilityType	Mogelijkheidswaarde voor sms.

PhoneNumberCapabilityType

Mogelijkheidswaarde voor aanroepen.

Name	Type	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

De gemaakte kosten voor één telefoonnummer.

Name	Type	Description
amount	number	Het kostenbedrag.
billingFrequency	BillingFrequency	De frequentie waarmee de kosten worden gefactureerd.
currencyCode	string	De ISO 4217-valutacode voor het kostenbedrag, bijvoorbeeld USD.

PhoneNumberSearchRequest

Vertegenwoordigt een zoekaanvraag voor telefoonnummers om telefoonnummers te vinden. Gevonden telefoonnummers worden tijdelijk bewaard voor een volgende aankoop.

Name	Type	Default value	Description
areaCode	string		Het netnummer van het gewenste telefoonnummer, bijvoorbeeld 425.
assignmentType	PhoneNumberAssignmentType		Het toewijzingstype van de telefoonnummers die moeten worden gezocht. Een telefoonnummer kan worden toegewezen aan een persoon of aan een toepassing.
capabilities	PhoneNumberCapabilities		Mogelijkheden van een telefoonnummer.
phoneNumberType	PhoneNumberType		Het type telefoonnummer dat moet worden gezocht, bijvoorbeeld geografisch of tollFree.
quantity	integer	1	Het aantal gewenste telefoonnummers. De standaardwaarde is 1.

PhoneNumberSearchResult

Het resultaat van een zoekbewerking voor telefoonnummers.

Name	Type	Description
assignmentType	PhoneNumberAssignmentType	Het toewijzingstype van het telefoonnummer.
capabilities	PhoneNumberCapabilities	Mogelijkheden van een telefoonnummer.
cost	PhoneNumberCost	De gemaakte kosten voor één telefoonnummer.
error	Error	Foutberichten toewijzen aan codes
errorCode	integer	De foutcode van de zoekopdracht.
phoneNumberType	PhoneNumberType	Het type telefoonnummer, bijvoorbeeld geografisch of tollFree.
phoneNumbers	string[]	De telefoonnummers die beschikbaar zijn. Kan minder zijn dan de gewenste zoekhoeveelheid.
searchExpiresBy	string	De datum waarop dit zoekresultaat verloopt en telefoonnummers niet meer in bewaring zijn. Een zoekresultaat verloopt in minder dan 15 minuten, bijvoorbeeld 2020-11-19T16:31:49.048Z.
searchId	string	De zoek-id.

PhoneNumberType

Vertegenwoordigt het nummertype van het aanbod.

Name	Type	Description
geographic	string
tollFree	string