Phone Numbers - Update Capabilities

Servizio:

Communication

Versione API:

2021-03-07

Aggiornamenti le funzionalità di un numero di telefono.

PATCH {endpoint}/phoneNumbers/{phoneNumber}/capabilities?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.
phoneNumber	path	True	string	ID numero di telefono in formato E.164. Il segno più iniziale può essere + o codificato come %2B, ad esempio +11234567890.
api-version	query	True	string	Versione dell'API da richiamare.

Corpo della richiesta

Media Types: "application/merge-patch+json"

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

Risposte

Nome	Tipo	Descrizione
202 Accepted	PurchasedPhoneNumber	Il servizio ha accettato la richiesta e inizierà l'elaborazione in un secondo momento. Restituirà immediatamente 'Accepted' e includerà le intestazioni 'Operation-Location' e 'Location'. Il lato client deve eseguire ulteriori query sullo stato dell'operazione usando l'URL specificato nell'intestazione 'Operation-Location'. Quando l'operazione viene completata correttamente, eseguire una query sul risultato finale usando l'URL specificato nell'intestazione 'Location'. Intestazioni Location: string Operation-Location: string operation-id: string capabilities-id: string
Other Status Codes	CommunicationErrorResponse	Operazioni non riuscite

Esempio

Update phoneNumber capabilities

Esempio di richiesta

HTTP

PATCH https://resourcename.communication.azure.com//phoneNumbers/+14792000102/capabilities?api-version=2021-03-07

{
  "calling": "inbound+outbound",
  "sms": "none"
}

Risposta di esempio

Codice di stato:

202

Operation-Location: /phoneNumbers/operations/capabilities_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /phoneNumbers/%2b14792000102
operation-id: capabilities_378ddf60-81be-452a-ba4f-613198ea6c28
capabilities-id: 378ddf60-81be-452a-ba4f-613198ea6c28

{
  "id": "14792000102",
  "phoneNumber": "+14792000102",
  "countryCode": "US",
  "assignmentType": "person",
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "inbound+outbound",
    "sms": "none"
  },
  "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.
PhoneNumberCapabilitiesRequest	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.

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.

PhoneNumberCapabilitiesRequest

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.