Удалить вызов

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

Удалите или повесите активный вызов. Для групповых вызовов это приведет к удалению только этапа вызова, и базовый групповой вызов по-прежнему будет продолжаться.

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

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

Разрешения

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

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

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

HTTP-запрос

DELETE /communications/calls/{id}

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

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

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

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 204 No Content. Он не возвращает ничего в теле ответа.

Пример

Запрос

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

HTTP

DELETE https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896

C#

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Communications.Calls["{call-id}"].DeleteAsync();

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

CLI

mgc communications calls delete --call-id {call-id}

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

Go

// 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"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Communications().Calls().ByCallId("call-id").Delete(context.Background(), nil)

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

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.communications().calls().byCallId("{call-id}").delete();

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896')
	.delete();

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


$graphServiceClient->communications()->calls()->byCallId('call-id')->delete()->wait();

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

PowerShell

Import-Module Microsoft.Graph.CloudCommunications

Remove-MgCommunicationCall -CallId $callId

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.communications.calls.by_call_id('call-id').delete()

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

Отклик

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

HTTP/1.1 204 No Content

Уведомление — прекращение

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

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

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/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "state": "terminated",
        "resultInfo": {
          "@odata.type": "#microsoft.graph.resultInfo",
          "code": "200",
          "subcode": "5001",
          "message": "The conversation has ended."
        }
      }
    }
  ]
}

Коды причин завершения вызова

Ниже приведены некоторые из распространенных кодов ошибок, получаемых через уведомление при завершении вызова.

Код	Вложенный код	Причина прекращения
200	4097	Вызов закончился другим участником звонка.
200	4521	Вызов завершился другим участником однорангового вызова.
200	5000	Удален из беседы другим участником.
200	5001	Разговор закончился.
200	5002	Беседа закончилась, так как все остальные участники покинули звонок.
200	5003	Разговор закончился.
200	5007	Беседа закончилась, так как инициатор группового вызова покинул беседу.
200	5010	Беседа закончилась, так как в беседе остался только один участник.
200	5012	Беседа закончилась, так как во входящем списке участников нет.
200	5013	Беседа закончилась, так как никто другой не присоединился к групповому вызову.
200	5014	Беседа закончилась, так как нам не удалось определить потенциального узла для группового вызова.
200	5020	Беседа завершилась, так как во входящем списке нет не скрытых участников.
200	5030	Беседа закончилась, так как продолжительность переговорной комнаты истекла.
200	5300	Участник был удален из беседы другим участником.
200	5855	Участник, ожидая в зале ожидания, был удален из беседы после истечения времени ожидания бездействия в лобби.
200	7000	Беседа завершилась ботом.
200	7015	Вызов завершился после успешного завершения передачи.
200	10550	Беседа завершилась ботом.
200	18503	Другой участник однорангового вызова покинул беседу.
200	540000/560000	Вызов завершен пользователем ТСОП.
408	8537	Время ожидания для поддержания активности, очистка неактивного вызова.
408	1106	Подтверждение не было получено для принятия звонка в отведенное время.
408	10057	Время ожидания вызова истекло из-за отсутствия сигналов от конечных точек вызываемого объекта.
410	301005	Сбой подключения к мультимедиа.
480	10037	Конечные точки вызываемого абонента не найдены.
480	10076	Не удалось связаться с вызываемой.
480	10134	Вызов отклонен из-за невозможности маршрутизации вызова.
480	10199	Вызов отклонен как частный вызов для пользователя отключен.
500	1005	Сервер столкнулся с ошибкой подключения к носителю бота. Проверьте подключение мультимедиа между Bot и Корпорацией Майкрософт.