Namespace: microsoft.graph
Assine o DTMF (dual-tone multi-frequency signaling), que permite que você seja notificado quando o usuário pressionar as teclas em um "teclado de discagem".
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global |
Governo dos EUA L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão |
Permissões menos privilegiadas |
Permissões com privilégios mais elevados |
| Delegado (conta corporativa ou de estudante) |
Sem suporte. |
Sem suporte. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
Calls.AccessMedia.All |
Indisponível. |
Observação: Os dados de tom fornecidos não podem ser persistentes. Certifique-se de estar em conformidade com as leis e regulamentos de sua área em relação à proteção de dados e confidencialidade das comunicações. Confira os Termos de Uso e converse com sua assessoria jurídica para saber mais.
Solicitação HTTP
POST /communications/calls/{id}/subscribeToTone
Corpo da solicitação
Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.
| Parâmetro |
Tipo |
Descrição |
| clientContext |
Cadeia de caracteres |
Cadeia de caracteres de contexto de cliente exclusiva. Pode ter no máximo 256 caracteres. |
Resposta
Se bem sucedido, este método retorna um código de resposta 200 OK.
Exemplo
O exemplo a seguir mostra como chamar essa API.
Solicitação
O exemplo a seguir mostra a solicitação.
POST https://graph.microsoft.com/v1.0/communications/calls/{id}/subscribeToTone
Content-Type: application/json
Content-Length: 46
{
"clientContext": "fd1c7836-4d84-4e24-b6aa-23188688cc54"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Communications.Calls.Item.SubscribeToTone;
var requestBody = new SubscribeToTonePostRequestBody
{
ClientContext = "fd1c7836-4d84-4e24-b6aa-23188688cc54",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Communications.Calls["{call-id}"].SubscribeToTone.PostAsync(requestBody);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphcommunications "github.com/microsoftgraph/msgraph-sdk-go/communications"
//other-imports
)
requestBody := graphcommunications.NewSubscribeToTonePostRequestBody()
clientContext := "fd1c7836-4d84-4e24-b6aa-23188688cc54"
requestBody.SetClientContext(&clientContext)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
subscribeToTone, err := graphClient.Communications().Calls().ByCallId("call-id").SubscribeToTone().Post(context.Background(), requestBody, nil)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.communications.calls.item.subscribetotone.SubscribeToTonePostRequestBody subscribeToTonePostRequestBody = new com.microsoft.graph.communications.calls.item.subscribetotone.SubscribeToTonePostRequestBody();
subscribeToTonePostRequestBody.setClientContext("fd1c7836-4d84-4e24-b6aa-23188688cc54");
var result = graphClient.communications().calls().byCallId("{call-id}").subscribeToTone().post(subscribeToTonePostRequestBody);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
const options = {
authProvider,
};
const client = Client.init(options);
const subscribeToToneOperation = {
clientContext: 'fd1c7836-4d84-4e24-b6aa-23188688cc54'
};
await client.api('/communications/calls/{id}/subscribeToTone')
.post(subscribeToToneOperation);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Communications\Calls\Item\SubscribeToTone\SubscribeToTonePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new SubscribeToTonePostRequestBody();
$requestBody->setClientContext('fd1c7836-4d84-4e24-b6aa-23188688cc54');
$result = $graphServiceClient->communications()->calls()->byCallId('call-id')->subscribeToTone()->post($requestBody)->wait();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Import-Module Microsoft.Graph.CloudCommunications
$params = @{
clientContext = "fd1c7836-4d84-4e24-b6aa-23188688cc54"
}
Invoke-MgSubscribeCommunicationCallToTone -CallId $callId -BodyParameter $params
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.communications.calls.item.subscribe_to_tone.subscribe_to_tone_post_request_body import SubscribeToTonePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = SubscribeToTonePostRequestBody(
client_context = "fd1c7836-4d84-4e24-b6aa-23188688cc54",
)
result = await graph_client.communications.calls.by_call_id('call-id').subscribe_to_tone.post(request_body)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
Location: https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5
{
"@odata.type": "#microsoft.graph.subscribeToToneOperation",
"clientContext": "clientContext-value",
"id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
"status": "completed"
}
Notificação - notificação de tom
A notificação contém informações sobre o tom pressionado no recurso toneinfo .
POST https://bot.contoso.com/api/calls
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.commsNotifications",
"value": [
{
"@odata.type": "#microsoft.graph.commsNotification",
"changeType": "updated",
"resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
"resourceData": {
"@odata.type": "#microsoft.graph.call",
"state": "established",
"toneInfo": {
"@odata.type": "#microsoft.graph.toneInfo",
"sequenceId": 1,
"tone": "tone1"
}
}
}
]
}