Phone Numbers - List Phone Numbers

Tjänst:

Communication

API-version:

2025-04-01

Hämtar listan över alla köpta telefonnummer.

GET {endpoint}/phoneNumbers?api-version=2025-04-01

Med valfria parametrar:

GET {endpoint}/phoneNumbers?skip={skip}&top={top}&api-version=2025-04-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (url)	Kommunikationsresursen, till exempel https://resourcename.communication.azure.com
api-version	query	True	string	Version av API som ska anropas
skip	query		integer (int32)	En valfri parameter för hur många poster som ska hoppa över, i sidnumreringssyfte. Standardvärdet är 0.
top	query		integer (int32)	En valfri parameter för hur många poster som ska returneras i sidnumreringssyfte. Standardvärdet är 100.

Svar

Name	Typ	Description
200 OK	PurchasedPhoneNumbers	Framgång
Other Status Codes	CommunicationErrorResponse	Misslyckande

Exempel

List purchased phone numbers

Exempelbegäran

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers?api-version=2025-04-01

Exempelsvar

Statuskod:

200

{
  "phoneNumbers": [
    {
      "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"
      }
    }
  ]
}

Definitioner

Name	Description
BillingFrequency	Hur ofta kostnaden debiteras.
CommunicationError	Communication Services-felet.
CommunicationErrorResponse	Communication Services-felet.
PhoneNumberAssignmentType	Representerar tilldelningstypen för erbjudandet.
PhoneNumberCapabilities	Funktioner i ett telefonnummer.
PhoneNumberCapabilityType	Kapacitetsvärde för anrop.
PhoneNumberCost	Kostnaden för ett enda telefonnummer.
PhoneNumberType	Representerar erbjudandets nummertyp.
PurchasedPhoneNumber	Representerar ett köpt telefonnummer.
PurchasedPhoneNumbers	Listan över köpta telefonnummer.

BillingFrequency

Uppräkning

Hur ofta kostnaden debiteras.

Värde	Description
monthly

CommunicationError

Objekt

Communication Services-felet.

Name	Typ	Description
code	string	Felkoden.
details	CommunicationError[]	Mer information om specifika fel som ledde till det här felet.
innererror	CommunicationError	Det inre felet om det finns något.
message	string	Felmeddelandet.
target	string	Felmålet.

CommunicationErrorResponse

Objekt

Communication Services-felet.

Name	Typ	Description
error	CommunicationError	Communication Services-felet.

PhoneNumberAssignmentType

Uppräkning

Representerar tilldelningstypen för erbjudandet.

Värde	Description
application
person

PhoneNumberCapabilities

Objekt

Funktioner i ett telefonnummer.

Name	Typ	Description
calling	PhoneNumberCapabilityType	Kapacitetsvärde för anrop.
sms	PhoneNumberCapabilityType	Kapacitetsvärde för SMS.

PhoneNumberCapabilityType

Uppräkning

Kapacitetsvärde för anrop.

Värde	Description
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Objekt

Kostnaden för ett enda telefonnummer.

Name	Typ	Description
amount	number (double)	Kostnadsbeloppet.
billingFrequency	BillingFrequency	Hur ofta kostnaden debiteras.
currencyCode	string	Valutakoden ISO 4217 för kostnadsbeloppet, t.ex. USD.

PhoneNumberType

Uppräkning

Representerar erbjudandets nummertyp.

Värde	Description
geographic
tollFree

PurchasedPhoneNumber

Objekt

Representerar ett köpt telefonnummer.

Name	Typ	Description
assignmentType	PhoneNumberAssignmentType	Tilldelningstypen för telefonnumret. Ett telefonnummer kan tilldelas till en person eller till ett program.
capabilities	PhoneNumberCapabilities	Funktioner i ett telefonnummer.
cost	PhoneNumberCost	Kostnaden för ett enda telefonnummer.
countryCode	string	ISO 3166-2-koden i telefonnumrets land, t.ex. USA.
id	string	ID:t för telefonnumret, t.ex. 11234567890.
phoneNumber	string	Sträng i E.164-formatet för telefonnumret, t.ex. +11234567890.
phoneNumberType	PhoneNumberType	Telefonnumrets typ, t.ex. geografisk, tollFree.
purchaseDate	string (date-time)	Datum och tid då telefonnumret köptes.

PurchasedPhoneNumbers

Objekt

Listan över köpta telefonnummer.

Name	Typ	Description
nextLink	string	Representerar URL-länken till nästa sida med telefonnummerresultat.
phoneNumbers	PurchasedPhoneNumber[]	Representerar en lista med telefonnummer.