Phone Numbers - List Phone Numbers

Referencia

Service:: Communication

API Version:: 2021-03-07

Lekéri az összes megvásárolt telefonszám listáját.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A kommunikációs erőforrás, például https://resourcename.communication.azure.com: .
api-version	query	True	string	A meghívandó API verziója.
skip	query		integer int32	Nem kötelező paraméter, hogy hány bejegyzést hagyjon ki lapozási célokra. Az alapértelmezett érték a 0.
top	query		integer int32	Nem kötelező paraméter, hogy hány bejegyzést kell visszaadni lapozási célokra. Az alapértelmezett érték 100.

Válaszok

Name	Típus	Description
200 OK	PurchasedPhoneNumbers	Siker
Other Status Codes	CommunicationErrorResponse	Hiba

Példák

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

Definíciók

Name	Description
BillingFrequency	A költségek számlázásának gyakorisága.
CommunicationError	A Communication Services hibája.
CommunicationErrorResponse	A Communication Services hibája.
PhoneNumberAssignmentType	A keresendő telefonszámok hozzárendelési típusa. Telefonszámot hozzárendelhet egy személyhez vagy egy alkalmazáshoz.
PhoneNumberCapabilities	A telefonszám képességei.
PhoneNumberCapabilityType	A hívás képességértéke.
PhoneNumberCost	Egyetlen telefonszám felmerült költsége.
PhoneNumberType	A keresendő telefonszámok típusa, például földrajzi vagy tollFree.
PurchasedPhoneNumber	Egy megvásárolt telefonszámot jelöl.
PurchasedPhoneNumbers	A megvásárolt telefonszámok listája.

BillingFrequency

A költségek számlázásának gyakorisága.

Name	Típus	Description
monthly	string

CommunicationError

A Communication Services hibája.

Name	Típus	Description
code	string	A hibakód.
details	CommunicationError[]	További részletek a hibához vezető konkrét hibákról.
innererror	CommunicationError	A belső hiba, ha van ilyen.
message	string	A hibaüzenet.
target	string	A hiba célja.

CommunicationErrorResponse

A Communication Services hibája.

Name	Típus	Description
error	CommunicationError	A Communication Services hibája.

PhoneNumberAssignmentType

A keresendő telefonszámok hozzárendelési típusa. Telefonszámot hozzárendelhet egy személyhez vagy egy alkalmazáshoz.

Name	Típus	Description
application	string
person	string

PhoneNumberCapabilities

A telefonszám képességei.

Name	Típus	Description
calling	PhoneNumberCapabilityType	A hívás képességértéke.
sms	PhoneNumberCapabilityType	Az SMS-hez tartozó képességérték.

PhoneNumberCapabilityType

A hívás képességértéke.

Name	Típus	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Egyetlen telefonszám felmerült költsége.

Name	Típus	Description
amount	number	A költség összege.
billingFrequency	BillingFrequency	A költségek számlázásának gyakorisága.
currencyCode	string	A költség összegének ISO 4217-es pénznemkódja, például USD.

PhoneNumberType

A keresendő telefonszámok típusa, például földrajzi vagy tollFree.

Name	Típus	Description
geographic	string
tollFree	string

PurchasedPhoneNumber

Egy megvásárolt telefonszámot jelöl.

Name	Típus	Description
assignmentType	PhoneNumberAssignmentType	A telefonszám hozzárendelési típusa. Telefonszámot hozzárendelhet egy személyhez vagy egy alkalmazáshoz.
capabilities	PhoneNumberCapabilities	A telefonszám képességei.
cost	PhoneNumberCost	Egyetlen telefonszám felmerült költsége.
countryCode	string	A telefonszám országának ISO 3166-2 kódja, pl. USA.
id	string	A telefonszám azonosítója, például 11234567890.
phoneNumber	string	A telefonszám E.164 formátumának sztringje, például +11234567890.
phoneNumberType	PhoneNumberType	A telefonszám típusa, például Földrajzi, TollFree.
purchaseDate	string	A telefonszám megvásárlásának dátuma és időpontja.

PurchasedPhoneNumbers

A megvásárolt telefonszámok listája.

Name	Típus	Description
nextLink	string	A telefonszám eredményének következő oldalára mutató URL-hivatkozást jelöli.
phoneNumbers	PurchasedPhoneNumber[]	A telefonszámok listáját jelöli.

Share via