Excluir chamada

Namespace: microsoft.graph

Exclua ou desligue uma chamada ativa. Para chamadas em grupo, isso só excluirá sua etapa de chamada e a chamada de grupo subjacente ainda continuará.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Sem suporte.	Sem suporte.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	Calls.Initiate.All	Calls.AccessMedia.All

Nota: As permissões são verificadas quando a chamada é criada; nenhuma marcar de permissão adicional é feita ao chamar essa API. Calls.AccessMedia.All só é necessário para chamadas que usam mídia hospedada por aplicativo.

Solicitação HTTP

DELETE /communications/calls/{id}

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se bem sucedido, este método retorna um código de resposta 204 No Content. Ele não retorna nada no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra a solicitação.

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();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc communications calls delete --call-id {call-id}

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



graphClient.Communications().Calls().ByCallId("call-id").Delete(context.Background(), nil)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.CloudCommunications

Remove-MgCommunicationCall -CallId $callId

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

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 204 No Content

Notificação – terminação

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

Notificação – encerrada

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."
        }
      }
    }
  ]
}

Códigos de motivo de término de chamada

Estes são alguns dos códigos de erro comuns recebidos por meio de notificação quando a chamada é encerrada.

Código	Sub-código	Motivo da rescisão
200	4097	A chamada foi encerrada pelo outro participante na chamada.
200	4521	A chamada foi encerrada pelo outro participante na chamada ponto a ponto.
200	5000	Removido da conversa por outro participante.
200	5001	A conversa terminou.
200	5002	A conversa terminou quando todos os outros participantes deixaram a chamada.
200	5003	A conversa terminou.
200	5007	A conversa terminou quando o iniciador da chamada do grupo deixou a conversa.
200	5010	A conversa terminou como apenas um participante permaneceu na conversa.
200	5012	A conversa terminou porque não há participantes na lista de entrada.
200	5013	A conversa terminou quando ninguém mais se juntou à chamada do grupo.
200	5014	A conversa terminou porque não foi possível determinar um potencial host para a chamada do grupo.
200	5020	A conversa terminou porque não há participantes não ocultos na lista de entrada.
200	5030	A conversa terminou quando a duração da sala de fuga passou.
200	5300	O participante foi removido da conversa por outro participante.
200	5855	O participante que aguardava no lobby foi removido da conversa após o tempo limite de inatividade do lobby.
200	7000	A conversa terminou por bot.
200	7015	A chamada terminou quando a transferência foi concluída com êxito.
200	10550	A conversa terminou por bot.
200	18503	O outro participante da chamada ponto a ponto deixou a conversa.
200	540000/560000	A chamada foi encerrada pelo Usuário PSTN.
408	8537	Manter o tempo limite vivo, a chamada inativa limpa.
408	1106	Um reconhecimento não foi recebido pela aceitação da chamada no tempo atribuído.
408	10057	Tempo limite de chamada devido a nenhuma sinalização de pontos de extremidade de callee.
410	301005	Falha de conectividade de mídia.
480	10037	Nenhum ponto de extremidade de callee foi encontrado.
480	10076	O callee não pôde ser contatado.
480	10134	Chamada rejeitada devido à incapacidade de rotear a chamada.
480	10199	A chamada rejeitada como chamada privada está desabilitada para o usuário.
500	1005	O servidor encontrou um erro de conectividade com a mídia do Bot. Verifique a conectividade de mídia entre Bot e Microsoft.