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, retornado ao criar a chamada via POST /calls

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

Use o ID retornado por POST /calls

Esta rota é compatível com chamadas criadas via POST /calls. O id retornado pela rota /dialer (descontinuada) não identifica a chamada no PBX e, se usado aqui, a API retorna 404 - ID not found.

Exemplo: criar e encerrar uma chamada

1. Crie a chamada com POST /calls/:

curl --request POST \
  --url https://api.api4com.com/api/v1/calls/ \
  --header 'Authorization: {SEU_TOKEN}' \
  --header 'Content-Type: application/json' \
  --data '{
    "extension": "1000",
    "caller": "1000",
    "called": "+5548988669122",
    "metadata": {}
  }'

2. Guarde o id da resposta:

{
  "status": "200",
  "id": "1PkXhmBsYAvr9legLB2d7BimT0Q",
  "message": "successful request"
}

3. Use esse id para encerrar a chamada:

curl --request POST \
  --url https://api.api4com.com/api/v1/calls/1PkXhmBsYAvr9legLB2d7BimT0Q/hangup \
  --header 'Authorization: {SEU_TOKEN}'

Importante:

• Para encerrar uma chamada de voz, é necessário informar o token de autenticação no cabeçalho da requisição.
• A API retorna 404 - ID not found quando o id não corresponde a uma chamada em andamento: chamada já encerrada ou id obtido pela rota /dialer.
• Esta rota tem limite de 30 requisições por minuto por usuário. Consulte Rate Limit.

Parâmetros

Parâmetros de Caminho

id*

Informe o id da chamada que deseja desligar, retornado por POST /calls. O id retornado por /dialer não é aceito.

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