Phone Numbers - List Phone Numbers

Referens

Service:: Communication

API Version:: 2021-03-07

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

GET {endpoint}/phoneNumbers?api-version=2021-03-07

With optional parameters:

GET {endpoint}/phoneNumbers?skip={skip}&top={top}&api-version=2021-03-07

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	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	Klart
Other Status Codes	CommunicationErrorResponse	Fel

Exempel

List purchased phone numbers

Sample Request

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers?api-version=2021-03-07

Sample Response

Status code:: 200

{
  "phoneNumbers": [
    {
      "id": "11234567890",
      "phoneNumber": "+11234567890",
      "countryCode": "US",
      "assignmentType": "user",
      "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	Tilldelningstypen för de telefonnummer som ska sökas efter. Ett telefonnummer kan tilldelas till en person eller till ett program.
PhoneNumberCapabilities	Funktioner i ett telefonnummer.
PhoneNumberCapabilityType	Kapacitetsvärde för anrop.
PhoneNumberCost	Kostnaden för ett enda telefonnummer.
PhoneNumberType	Typ av telefonnummer att söka efter, t.ex. geografisk eller tollFree.
PurchasedPhoneNumber	Representerar ett köpt telefonnummer.
PurchasedPhoneNumbers	Listan över köpta telefonnummer.

BillingFrequency

Hur ofta kostnaden debiteras.

Name	Typ	Description
monthly	string

CommunicationError

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ågra.
message	string	Felmeddelandet.
target	string	Felmålet.

CommunicationErrorResponse

Communication Services-felet.

Name	Typ	Description
error	CommunicationError	Communication Services-felet.

PhoneNumberAssignmentType

Tilldelningstypen för de telefonnummer som ska sökas efter. Ett telefonnummer kan tilldelas till en person eller till ett program.

Name	Typ	Description
application	string
person	string

PhoneNumberCapabilities

Funktioner i ett telefonnummer.

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

PhoneNumberCapabilityType

Kapacitetsvärde för anrop.

Name	Typ	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Kostnaden för ett enda telefonnummer.

Name	Typ	Description
amount	number	Kostnadsbeloppet.
billingFrequency	BillingFrequency	Hur ofta kostnaden debiteras.
currencyCode	string	Iso 4217-valutakoden för kostnadsbeloppet, t.ex. USD.

PhoneNumberType

Typ av telefonnummer att söka efter, t.ex. geografisk eller tollFree.

Name	Typ	Description
geographic	string
tollFree	string

PurchasedPhoneNumber

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, Avgiftsfri.
purchaseDate	string	Datum och tid då telefonnumret köptes.

PurchasedPhoneNumbers

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.

Share via