Phone Numbers - Get Search Result

Referenz

Dienst:: Communication

API-Version:: 2022-12-01

Ruft ein Suchergebnis für Telefonnummern nach Such-ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Die Kommunikationsressource, z. B. https://resourcename.communication.azure.com
searchId	path	True	string	Die Such-ID.
api-version	query	True	string	Version der API, die aufgerufen werden soll

Antworten

Name	Typ	Beschreibung
200 OK	PhoneNumberSearchResult	Erfolg
Other Status Codes	CommunicationErrorResponse	Versagen

Beispiele

Get PhoneNumber Search Result

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
BillingFrequency	Die Häufigkeit, mit der die Kosten in Rechnung gestellt werden.
CommunicationError	Der Kommunikationsdienstfehler.
CommunicationErrorResponse	Der Kommunikationsdienstfehler.
Error	Zuordnen von Fehlermeldungen zu Codes
PhoneNumberAssignmentType	Stellt den Zuordnungstyp des Angebots dar.
PhoneNumberCapabilities	Funktionen einer Telefonnummer.
PhoneNumberCapabilityType	Funktionswert für Anrufe.
PhoneNumberCost	Die entstandenen Kosten für eine einzelne Telefonnummer.
PhoneNumberSearchResult	Das Ergebnis eines Suchvorgangs für Telefonnummern.
PhoneNumberType	Stellt den Nummerntyp des Angebots dar.

BillingFrequency

Die Häufigkeit, mit der die Kosten in Rechnung gestellt werden.

Name	Typ	Beschreibung
monthly	string

CommunicationError

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CommunicationError[]	Weitere Details zu bestimmten Fehlern, die zu diesem Fehler geführt haben.
innererror	CommunicationError	Der innere Fehler( falls vorhanden).
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

CommunicationErrorResponse

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
error	CommunicationError	Der Kommunikationsdienstfehler.

Error

Zuordnen von Fehlermeldungen zu Codes

Name	Typ	Beschreibung
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

Stellt den Zuordnungstyp des Angebots dar.

Name	Typ	Beschreibung
application	string
person	string

PhoneNumberCapabilities

Funktionen einer Telefonnummer.

Name	Typ	Beschreibung
calling	PhoneNumberCapabilityType	Funktionswert für Anrufe.
sms	PhoneNumberCapabilityType	Funktionswert für SMS.

PhoneNumberCapabilityType

Funktionswert für Anrufe.

Name	Typ	Beschreibung
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Die entstandenen Kosten für eine einzelne Telefonnummer.

Name	Typ	Beschreibung
amount	number	Der Kostenbetrag.
billingFrequency	BillingFrequency	Die Häufigkeit, mit der die Kosten in Rechnung gestellt werden.
currencyCode	string	Der ISO 4217-Währungscode für den Kostenbetrag, z. B. USD.

PhoneNumberSearchResult

Das Ergebnis eines Suchvorgangs für Telefonnummern.

Name	Typ	Beschreibung
assignmentType	PhoneNumberAssignmentType	Zuweisungstyp der Telefonnummer.
capabilities	PhoneNumberCapabilities	Funktionen einer Telefonnummer.
cost	PhoneNumberCost	Die entstandenen Kosten für eine einzelne Telefonnummer.
error	Error	Zuordnen von Fehlermeldungen zu Codes
errorCode	integer	Der Fehlercode der Suche.
phoneNumberType	PhoneNumberType	Der Typ der Telefonnummer, z. B. ortsgebunden oder tollFree.
phoneNumbers	string[]	Die verfügbaren Telefonnummern. Kann kleiner als die gewünschte Suchmenge sein.
searchExpiresBy	string	Das Datum, an dem dieses Suchergebnis abläuft, und Telefonnummern werden nicht mehr gehalten. Ein Suchergebnis läuft in weniger als 15 Minuten ab, z. B. 2020-11-19T16:31:49.048Z.
searchId	string	Die Such-ID.

PhoneNumberType

Stellt den Nummerntyp des Angebots dar.

Name	Typ	Beschreibung
geographic	string
tollFree	string

Freigeben über