Phone Numbers - List Phone Numbers

Riferimento

Service:: Communication

API Version:: 2021-03-07

Ottiene l'elenco di tutti i numeri di telefono acquistati.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Risorsa di comunicazione, ad esempio https://resourcename.communication.azure.com.
api-version	query	True	string	Versione dell'API da richiamare.
skip	query		integer int32	Parametro facoltativo per il numero di voci da ignorare per scopi di impaginazione. Il valore predefinito è 0.
top	query		integer int32	Parametro facoltativo per il numero di voci da restituire, a scopo di paginazione. Il valore predefinito è 100.

Risposte

Nome	Tipo	Descrizione
200 OK	PurchasedPhoneNumbers	Operazione completata
Other Status Codes	CommunicationErrorResponse	Operazioni non riuscite

Esempio

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

Definizioni

Nome	Descrizione
BillingFrequency	Frequenza con cui viene fatturato il costo.
CommunicationError	Errore di Servizi di comunicazione.
CommunicationErrorResponse	Errore di Servizi di comunicazione.
PhoneNumberAssignmentType	Tipo di assegnazione dei numeri di telefono da cercare. Un numero di telefono può essere assegnato a una persona o a un'applicazione.
PhoneNumberCapabilities	Funzionalità di un numero di telefono.
PhoneNumberCapabilityType	Valore della funzionalità per la chiamata.
PhoneNumberCost	Costo addebitato per un singolo numero di telefono.
PhoneNumberType	Tipo di numeri di telefono da cercare, ad esempio geografico o tollFree.
PurchasedPhoneNumber	Rappresenta un numero di telefono acquistato.
PurchasedPhoneNumbers	Elenco dei numeri di telefono acquistati.

BillingFrequency

Frequenza con cui viene fatturato il costo.

Nome	Tipo	Descrizione
monthly	string

CommunicationError

Errore di Servizi di comunicazione.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	CommunicationError[]	Ulteriori dettagli sugli errori specifici che hanno causato questo errore.
innererror	CommunicationError	Errore interno, se presente.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

CommunicationErrorResponse

Errore di Servizi di comunicazione.

Nome	Tipo	Descrizione
error	CommunicationError	Errore di Servizi di comunicazione.

PhoneNumberAssignmentType

Tipo di assegnazione dei numeri di telefono da cercare. Un numero di telefono può essere assegnato a una persona o a un'applicazione.

Nome	Tipo	Descrizione
application	string
person	string

PhoneNumberCapabilities

Funzionalità di un numero di telefono.

Nome	Tipo	Descrizione
calling	PhoneNumberCapabilityType	Valore della funzionalità per la chiamata.
sms	PhoneNumberCapabilityType	Valore della funzionalità per SMS.

PhoneNumberCapabilityType

Valore della funzionalità per la chiamata.

Nome	Tipo	Descrizione
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Costo addebitato per un singolo numero di telefono.

Nome	Tipo	Descrizione
amount	number	Importo del costo.
billingFrequency	BillingFrequency	Frequenza con cui viene fatturato il costo.
currencyCode	string	Codice valuta ISO 4217 per l'importo del costo, ad esempio USD.

PhoneNumberType

Tipo di numeri di telefono da cercare, ad esempio geografico o tollFree.

Nome	Tipo	Descrizione
geographic	string
tollFree	string

PurchasedPhoneNumber

Rappresenta un numero di telefono acquistato.

Nome	Tipo	Descrizione
assignmentType	PhoneNumberAssignmentType	Tipo di assegnazione del numero di telefono. Un numero di telefono può essere assegnato a una persona o a un'applicazione.
capabilities	PhoneNumberCapabilities	Funzionalità di un numero di telefono.
cost	PhoneNumberCost	Costo addebitato per un singolo numero di telefono.
countryCode	string	Codice ISO 3166-2 del paese del numero di telefono, ad esempio Stati Uniti.
id	string	ID del numero di telefono, ad esempio 11234567890.
phoneNumber	string	Stringa del formato E.164 del numero di telefono, ad esempio +11234567890.
phoneNumberType	PhoneNumberType	Tipo del numero di telefono, ad esempio Geographic, TollFree.
purchaseDate	string	Data e ora in cui è stato acquistato il numero di telefono.

PurchasedPhoneNumbers

Elenco dei numeri di telefono acquistati.

Nome	Tipo	Descrizione
nextLink	string	Rappresenta il collegamento URL alla pagina successiva dei risultati del numero di telefono.
phoneNumbers	PurchasedPhoneNumber[]	Rappresenta un elenco di numeri di telefono.

Share via