Phone Numbers - Get Search Result

Referentie

Service:: Communication

API-versie:: 2022-12-01

Hiermee haalt u een zoekresultaat op telefoonnummer op op zoek-id.

GET {endpoint}/availablePhoneNumbers/searchResults/{searchId}?api-version=2022-12-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	De communicatieresource, bijvoorbeeld https://resourcename.communication.azure.com
searchId	path	True	string	De zoek-id.
api-version	query	True	string	Versie van API die moet worden aangeroepen

Antwoorden

Name	Type	Description
200 OK	PhoneNumberSearchResult	Succes
Other Status Codes	CommunicationErrorResponse	Mislukking

Voorbeelden

Get PhoneNumber Search Result

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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.
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.

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

Delen via