Desligar chamadas

POST

/calls/{id}/hangup

Para encerrar uma chamada de voz, utilize o método POST na rota /calls/{id}/hangup. Este método requer o seguinte parâmetro:

• id: Identificador único da chamada

Este método retorna um objeto com a resposta da requisição, incluindo:

• id: Identificador único da chamada
• status: Status da requisição
• message: Mensagem de sucesso

Importante:

• Para encerrar uma chamada de voz, é necessário informar o token de autenticação no cabeçalho da requisição.
• Caso a chamada já tenha sido encerrada, a API retornará um erro informando que a chamada não foi encontrada.

Parâmetros

Parâmetros de Caminho

id*

Informe o id da chamada que deseja desligar

Tipostring

Obrigatório

Respostas

Request was successful

Content-Type

Usar exemplo

{

"status": "200",

"message": "successful request",

"id": "1PkXhmBsYAvr9legLB2d7BimT0Q"

}

POST

/calls/{id}/hangup

Exemplos

cURL

curl -X POST \
'https://api.api4com.com/api/v1/calls/{id}/hangup' \
 -H "Content-Type: application/json"

JavaScript

fetch('https://api.api4com.com/api/v1/calls/{id}/hangup', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = 'https://api.api4com.com/api/v1/calls/{id}/hangup';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = 'https://api.api4com.com/api/v1/calls/{id}/hangup'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())