Phone Numbers - Get By Number

Service:

Communication

API-versie:

2022-12-01

Hiermee haalt u de details op van het opgegeven aangeschafte telefoonnummer.

GET {endpoint}/phoneNumbers/{phoneNumber}?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
phoneNumber	path	True	string	Het aangeschafte telefoonnummer waarvan de gegevens moeten worden opgehaald in E.164-indeling, bijvoorbeeld +11234567890.
api-version	query	True	string	Versie van API die moet worden aangeroepen

Antwoorden

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

Voorbeelden

Fetch purchased phone number

Voorbeeldaanvraag

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers/+11234567890?api-version=2022-12-01

Voorbeeldrespons

Statuscode:

200

{
  "id": "11234567890",
  "phoneNumber": "+11234567890",
  "countryCode": "US",
  "assignmentType": "person",
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "inbound+outbound",
    "sms": "inbound"
  },
  "purchaseDate": "2020-11-19T16:31:49.048Z",
  "cost": {
    "amount": 0.8,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  }
}

Definities

Name	Description
BillingFrequency	De frequentie waarmee de kosten worden gefactureerd.
CommunicationError	De Communication Services-fout.
CommunicationErrorResponse	De Communication Services-fout.
PhoneNumberAssignmentType	Vertegenwoordigt het toewijzingstype van het aanbod.
PhoneNumberCapabilities	Mogelijkheden van een telefoonnummer.
PhoneNumberCapabilityType	Mogelijkheidswaarde voor aanroepen.
PhoneNumberCost	De gemaakte kosten voor één telefoonnummer.
PhoneNumberType	Vertegenwoordigt het nummertype van het aanbod.
PurchasedPhoneNumber	Vertegenwoordigt een gekocht telefoonnummer.

BillingFrequency

Inventarisatie

De frequentie waarmee de kosten worden gefactureerd.

Waarde	Description
monthly

CommunicationError

Object

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

Object

De Communication Services-fout.

Name	Type	Description
error	CommunicationError	De Communication Services-fout.

PhoneNumberAssignmentType

Inventarisatie

Vertegenwoordigt het toewijzingstype van het aanbod.

Waarde	Description
application
person

PhoneNumberCapabilities

Object

Mogelijkheden van een telefoonnummer.

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

PhoneNumberCapabilityType

Inventarisatie

Mogelijkheidswaarde voor aanroepen.

Waarde	Description
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Object

De gemaakte kosten voor één telefoonnummer.

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

PhoneNumberType

Inventarisatie

Vertegenwoordigt het nummertype van het aanbod.

Waarde	Description
geographic
tollFree

PurchasedPhoneNumber

Object

Vertegenwoordigt een gekocht telefoonnummer.

Name	Type	Description
assignmentType	PhoneNumberAssignmentType	Het toewijzingstype van het telefoonnummer. Een telefoonnummer kan worden toegewezen aan een persoon of aan een toepassing.
capabilities	PhoneNumberCapabilities	Mogelijkheden van een telefoonnummer.
cost	PhoneNumberCost	De gemaakte kosten voor één telefoonnummer.
countryCode	string	De ISO 3166-2-code van het land van het telefoonnummer, bijvoorbeeld VS.
id	string	De id van het telefoonnummer, bijvoorbeeld 11234567890.
phoneNumber	string	Tekenreeks van de E.164-notatie van het telefoonnummer, bijvoorbeeld +11234567890.
phoneNumberType	PhoneNumberType	Het type telefoonnummer, bijvoorbeeld geografisch, tollFree.
purchaseDate	string (date-time)	De datum en tijd waarop het telefoonnummer is gekocht.