Phone Numbers - Update Capabilities
Atualizações as capacidades de um número de telefone.
PATCH {endpoint}/phoneNumbers/{phoneNumber}/capabilities?api-version=2021-03-07
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
O recurso de comunicação, por exemplo https://resourcename.communication.azure.com. |
phone
|
path | True |
string |
O ID do número de telefone no formato E.164. A adição à esquerda pode ser + ou codificada como %2B, por exemplo, +11234567890. |
api-version
|
query | True |
string |
Versão da API a invocar. |
Corpo do Pedido
Media Types: "application/merge-patch+json"
Name | Tipo | Description |
---|---|---|
calling |
Valor de capacidade para chamar. |
|
sms |
Valor de capacidade para SMS. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
O serviço aceitou o pedido e começará a ser processado mais tarde. Devolverá imediatamente "Aceite" e incluirá os cabeçalhos "Operation-Location" e "Location". O lado do cliente deve consultar ainda mais o estado da operação com o URL especificado no cabeçalho "Operation-Location". Quando a operação for concluída, consulte com êxito o resultado final com o URL especificado no cabeçalho "Localização". Headers
|
|
Other Status Codes |
Falha |
Exemplos
Update phoneNumber capabilities
Sample Request
PATCH https://resourcename.communication.azure.com//phoneNumbers/+14792000102/capabilities?api-version=2021-03-07
{
"calling": "inbound+outbound",
"sms": "none"
}
Sample Response
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"
}
}
Definições
Name | Description |
---|---|
Billing |
A frequência com que o custo é faturado. |
Communication |
O erro dos Serviços de Comunicação. |
Communication |
O erro dos Serviços de Comunicação. |
Phone |
O tipo de atribuição dos números de telefone a procurar. Um número de telefone pode ser atribuído a uma pessoa ou a uma aplicação. |
Phone |
Capacidades de um número de telefone. |
Phone |
Capacidades de um número de telefone. |
Phone |
Valor de capacidade para chamar. |
Phone |
O custo incorrido para um único número de telefone. |
Phone |
O tipo de números de telefone a procurar, por exemplo, geográficos ou gratuitos. |
Purchased |
Representa um número de telefone comprado. |
BillingFrequency
A frequência com que o custo é faturado.
Name | Tipo | Description |
---|---|---|
monthly |
string |
CommunicationError
O erro dos Serviços de Comunicação.
Name | Tipo | Description |
---|---|---|
code |
string |
O código de erro. |
details |
Mais detalhes sobre erros específicos que levaram a este erro. |
|
innererror |
O erro interno, se existir. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
CommunicationErrorResponse
O erro dos Serviços de Comunicação.
Name | Tipo | Description |
---|---|---|
error |
O erro dos Serviços de Comunicação. |
PhoneNumberAssignmentType
O tipo de atribuição dos números de telefone a procurar. Um número de telefone pode ser atribuído a uma pessoa ou a uma aplicação.
Name | Tipo | Description |
---|---|---|
application |
string |
|
person |
string |
PhoneNumberCapabilities
Capacidades de um número de telefone.
Name | Tipo | Description |
---|---|---|
calling |
Valor de capacidade para chamar. |
|
sms |
Valor de capacidade para SMS. |
PhoneNumberCapabilitiesRequest
Capacidades de um número de telefone.
Name | Tipo | Description |
---|---|---|
calling |
Valor de capacidade para chamar. |
|
sms |
Valor de capacidade para SMS. |
PhoneNumberCapabilityType
Valor de capacidade para chamar.
Name | Tipo | Description |
---|---|---|
inbound |
string |
|
inbound+outbound |
string |
|
none |
string |
|
outbound |
string |
PhoneNumberCost
O custo incorrido para um único número de telefone.
Name | Tipo | Description |
---|---|---|
amount |
number |
O montante do custo. |
billingFrequency |
A frequência com que o custo é faturado. |
|
currencyCode |
string |
O código de moeda ISO 4217 para o montante do custo, por exemplo, USD. |
PhoneNumberType
O tipo de números de telefone a procurar, por exemplo, geográficos ou gratuitos.
Name | Tipo | Description |
---|---|---|
geographic |
string |
|
tollFree |
string |
PurchasedPhoneNumber
Representa um número de telefone comprado.
Name | Tipo | Description |
---|---|---|
assignmentType |
O tipo de atribuição do número de telefone. Um número de telefone pode ser atribuído a uma pessoa ou a uma aplicação. |
|
capabilities |
Capacidades de um número de telefone. |
|
cost |
O custo incorrido para um único número de telefone. |
|
countryCode |
string |
O código ISO 3166-2 do país do número de telefone, por exemplo, E.U.A. |
id |
string |
O ID do número de telefone, por exemplo, 11234567890. |
phoneNumber |
string |
Cadeia do formato E.164 do número de telefone, por exemplo, +11234567890. |
phoneNumberType |
O tipo do número de telefone, por exemplo, Geográfico, TollFree. |
|
purchaseDate |
string |
A data e hora em que o número de telefone foi comprado. |