Pular para conteúdo

Encerrar Chamada

O endpoint /api/calls/{id}/end permite encerrar uma chamada utilizando seu Token de API.

Requisição

Encerra uma chamada específica do projeto.

Cabeçalhos:

{
  "Authorization": "Bearer {API_TOKEN}"
}

Exemplos de Implementação

curl -X POST "https://api.videochamada.com.br/api/calls/{id}/end" \
  -H "Authorization: Bearer {API_TOKEN}"

import requests

response = requests.post(
    "https://api.videochamada.com.br/api/calls/{id}/end",
    headers={"Authorization": "Bearer {API_TOKEN}"}
)

const response = await fetch('https://api.videochamada.com.br/api/calls/{id}/end', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {API_TOKEN}'
  }
});

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer {API_TOKEN}");
var response = await client.PostAsync("https://api.videochamada.com.br/api/calls/{id}/end", null);

Resposta

Exemplo de Resposta:

{
  "message": "Call ended successfully",
  "call": {
    "id": "a958641b-8c17-4d6e-8d75-30585d315089",
    "projectId": "proj_123",
    "status": "ended",
    "created": "2025-06-11T10:00:00Z",
    "started": "2025-06-11T10:05:00Z",
    "ended": "2025-06-11T10:35:00Z",
    "totalBillableMinutes": 30.5,
    "url": "https://example.videochamada.com.br/chamada/a958641b-8c17-4d6e-8d75-30585d315089"
  }
}

Chamada já foi encerrada

{
  "statusCode": 400,
  "message": "Call is already ended",
  "error": "Bad Request"
}

Chamada não pertence ao projeto

{
  "statusCode": 401,
  "message": "Call does not belong to this project",
  "error": "Unauthorized"
}

Chamada não encontrada

{
  "statusCode": 404,
  "message": "Call not found",
  "error": "Not Found"
}

Explicação dos Campos:

  • message: Mensagem de confirmação do encerramento
  • call: Objeto com os detalhes da chamada encerrada
  • id: Identificador único da chamada
  • projectId: Identificador do projeto
  • status: Status atual da chamada (será "ended")
  • created: Data e hora de criação da chamada
  • started: Data e hora de início da chamada
  • ended: Data e hora de encerramento da chamada
  • totalBillableMinutes: Total de minutos cobrados
  • url: URL da chamada

Boas Práticas

  • Verificação de Status: Antes de encerrar, verifique se a chamada está realmente em andamento para evitar erros.
  • Gestão de Recursos: Encerre chamadas que não estão mais sendo utilizadas para otimizar o uso de recursos e custos.
  • Logs e Auditoria: Registre as ações de encerramento para fins de auditoria e análise posterior.

Warning

Importante: Uma vez encerrada, a chamada não pode ser reiniciada. Certifique-se de que todos os participantes finalizaram suas atividades antes de encerrar.