call: sendDtmfTones

Пространство имен: microsoft.graph

Отправка тонов DTMF в вызове.

Дополнительные сведения об обработке операций см. в разделе commsOperation.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Не поддерживается.	Не поддерживается.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	Calls.Initiate.All	Calls.AccessMedia.All

Примечание: При создании вызова проверяются разрешения; при вызове этого API дополнительные проверка разрешений не выполняется. Методы Calls.AccessMedia.All необходимы только для вызовов, использующих мультимедиа, размещенные в приложении.

HTTP-запрос

POST /app/calls/{id}/sendDtmfTones
POST /communications/calls/{id}/sendDtmfTones

Примечание. Путь /app является устаревшим. В дальнейшем используйте путь /communications.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.

Параметр	Тип	Описание
Тонах	Коллекция ToneInfo	Отправляемые тона.
delayBetweenTonesMs	Int32	Задержка в миллисекундах между тонами.
clientContext	String	Уникальная строка контекста клиента. Может содержать не более 256 символов.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект sendDtmfTonesOperation в теле отклика.

Примеры

В следующем примере показано, как отправлять тона DTMF в вызове.

Запрос

Ниже показан пример запроса.

HTTP

POST https://graph.microsoft.com/v1.0/communications/calls/481f3600-983e-4276-9b59-c1b30ec8d125/microsoft.graph.sendDtmfTones
Content-Type: application/json
Content-Length: 166

{
  "tones": [
    "tone1",
    "tone2",
    "tone3",
    "tone4",
    "tone5",
    "tone6",
    "tone7",
    "tone8",
    "tone9",
    "tone0",
    "star",
    "pound"
  ],
  "delayBetweenTonesMs": 1000,
  "clientContext": "e0be71f1-a14f-4cec-b65a-e7aba5db7c53"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Communications.Calls.Item.SendDtmfTones;
using Microsoft.Graph.Models;

var requestBody = new SendDtmfTonesPostRequestBody
{
	Tones = new List<Tone?>
	{
		Tone.Tone1,
		Tone.Tone2,
		Tone.Tone3,
		Tone.Tone4,
		Tone.Tone5,
		Tone.Tone6,
		Tone.Tone7,
		Tone.Tone8,
		Tone.Tone9,
		Tone.Tone0,
		Tone.Star,
		Tone.Pound,
	},
	DelayBetweenTonesMs = 1000,
	ClientContext = "e0be71f1-a14f-4cec-b65a-e7aba5db7c53",
};

// 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}"].SendDtmfTones.PostAsync(requestBody);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc communications calls send-dtmf-tones post --call-id {call-id} --body '{\
  "tones": [\
    "tone1",\
    "tone2",\
    "tone3",\
    "tone4",\
    "tone5",\
    "tone6",\
    "tone7",\
    "tone8",\
    "tone9",\
    "tone0",\
    "star",\
    "pound"\
  ],\
  "delayBetweenTonesMs": 1000,\
  "clientContext": "e0be71f1-a14f-4cec-b65a-e7aba5db7c53"\
}\
'

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphcommunications "github.com/microsoftgraph/msgraph-sdk-go/communications"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphcommunications.NewSendDtmfTonesPostRequestBody()
tones := []graphmodels.Toneable {
	tone := graphmodels.TONE1_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE2_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE3_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE4_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE5_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE6_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE7_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE8_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE9_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.TONE0_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.STAR_TONE 
	requestBody.SetTone(&tone) 
	tone := graphmodels.POUND_TONE 
	requestBody.SetTone(&tone)
}
requestBody.SetTones(tones)
delayBetweenTonesMs := int32(1000)
requestBody.SetDelayBetweenTonesMs(&delayBetweenTonesMs) 
clientContext := "e0be71f1-a14f-4cec-b65a-e7aba5db7c53"
requestBody.SetClientContext(&clientContext) 

sendDtmfTones, err := graphClient.Communications().Calls().ByCallId("call-id").SendDtmfTones().Post(context.Background(), requestBody, nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// 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.senddtmftones.SendDtmfTonesPostRequestBody sendDtmfTonesPostRequestBody = new com.microsoft.graph.communications.calls.item.senddtmftones.SendDtmfTonesPostRequestBody();
LinkedList<Tone> tones = new LinkedList<Tone>();
tones.add(Tone.Tone1);
tones.add(Tone.Tone2);
tones.add(Tone.Tone3);
tones.add(Tone.Tone4);
tones.add(Tone.Tone5);
tones.add(Tone.Tone6);
tones.add(Tone.Tone7);
tones.add(Tone.Tone8);
tones.add(Tone.Tone9);
tones.add(Tone.Tone0);
tones.add(Tone.Star);
tones.add(Tone.Pound);
sendDtmfTonesPostRequestBody.setTones(tones);
sendDtmfTonesPostRequestBody.setDelayBetweenTonesMs(1000);
sendDtmfTonesPostRequestBody.setClientContext("e0be71f1-a14f-4cec-b65a-e7aba5db7c53");
var result = graphClient.communications().calls().byCallId("{call-id}").sendDtmfTones().post(sendDtmfTonesPostRequestBody);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const sendDtmfTonesOperation = {
  tones: [
    'tone1',
    'tone2',
    'tone3',
    'tone4',
    'tone5',
    'tone6',
    'tone7',
    'tone8',
    'tone9',
    'tone0',
    'star',
    'pound'
  ],
  delayBetweenTonesMs: 1000,
  clientContext: 'e0be71f1-a14f-4cec-b65a-e7aba5db7c53'
};

await client.api('/communications/calls/481f3600-983e-4276-9b59-c1b30ec8d125/microsoft.graph.sendDtmfTones')
	.post(sendDtmfTonesOperation);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SendDtmfTonesPostRequestBody;
use Microsoft\Graph\Generated\Models\Tone;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SendDtmfTonesPostRequestBody();
$requestBody->setTones([new Tone('tone1'),new Tone('tone2'),new Tone('tone3'),new Tone('tone4'),new Tone('tone5'),new Tone('tone6'),new Tone('tone7'),new Tone('tone8'),new Tone('tone9'),new Tone('tone0'),new Tone('star'),new Tone('pound'),	]);
$requestBody->setDelayBetweenTonesMs(1000);
$requestBody->setClientContext('e0be71f1-a14f-4cec-b65a-e7aba5db7c53');

$result = $graphServiceClient->communications()->calls()->byCallId('call-id')->sendDtmfTones()->post($requestBody)->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	tones = @(
	"tone1"
"tone2"
"tone3"
"tone4"
"tone5"
"tone6"
"tone7"
"tone8"
"tone9"
"tone0"
"star"
"pound"
)
delayBetweenTonesMs = 1000
clientContext = "e0be71f1-a14f-4cec-b65a-e7aba5db7c53"
}

Send-MgCommunicationCallDtmfTone -CallId $callId -BodyParameter $params

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.communications.calls.item.send_dtmf_tones.send_dtmf_tones_post_request_body import SendDtmfTonesPostRequestBody
from msgraph.generated.models.tone import Tone

graph_client = GraphServiceClient(credentials, scopes)

request_body = SendDtmfTonesPostRequestBody(
	tones = [
		Tone.Tone1,
		Tone.Tone2,
		Tone.Tone3,
		Tone.Tone4,
		Tone.Tone5,
		Tone.Tone6,
		Tone.Tone7,
		Tone.Tone8,
		Tone.Tone9,
		Tone.Tone0,
		Tone.Star,
		Tone.Pound,
	],
	delay_between_tones_ms = 1000,
	client_context = "e0be71f1-a14f-4cec-b65a-e7aba5db7c53",
)

result = await graph_client.communications.calls.by_call_id('call-id').send_dtmf_tones.post(request_body)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

---

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Location: https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/d36fe651-9f50-484d-bd4b-1e6415eae448

{
  "@odata.type": "#microsoft.graph.sendDtmfTonesOperation",
  "status": "running",
  "clientContext": "e0be71f1-a14f-4cec-b65a-e7aba5db7c53",
  "id": "d36fe651-9f50-484d-bd4b-1e6415eae448"
}

Уведомление — операция завершена

Успешное обращение

POST https://bot.contoso.com/api/calls
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "/communications/calls/481f3600-983e-4276-9b59-c1b30ec8d125/operations/d36fe651-9f50-484d-bd4b-1e6415eae448",
      "resourceData": {
        "@odata.type": "#microsoft.graph.sendDtmfTonesOperation",
        "status": "completed",
        "completionReason": "completedSuccessfully",
        "clientContext": "e0be71f1-a14f-4cec-b65a-e7aba5db7c53",
        "id": "d36fe651-9f50-484d-bd4b-1e6415eae448"
      }
    }
  ]
}

Ошибка 1

POST https://bot.contoso.com/api/calls
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "/communications/calls/481f3600-983e-4276-9b59-c1b30ec8d125/operations/d36fe651-9f50-484d-bd4b-1e6415eae448",
      "resourceData": {
        "@odata.type": "#microsoft.graph.sendDtmfTonesOperation",
        "status": "completed",
        "completionReason": "mediaOperationCanceled",
        "clientContext": "e0be71f1-a14f-4cec-b65a-e7aba5db7c53",
        "id": "d36fe651-9f50-484d-bd4b-1e6415eae448"
      }
    }
  ]
}

Ошибка 2

POST https://bot.contoso.com/api/calls
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "/communications/calls/481f3600-983e-4276-9b59-c1b30ec8d125/operations/d36fe651-9f50-484d-bd4b-1e6415eae448",
      "resourceData": {
        "@odata.type": "#microsoft.graph.sendDtmfTonesOperation",
        "status": "completed",
        "completionReason": "unknown",
        "clientContext": "e0be71f1-a14f-4cec-b65a-e7aba5db7c53",
        "id": "d36fe651-9f50-484d-bd4b-1e6415eae448"
      }
    }
  ]
}