Skip to content

Realizar chamadas

POST
/dialer

Para realizar uma chamada de voz, utilize o método POST na rota /dialer. Este método requer os seguintes parâmetros:

  • extension: Ramal do usuário
  • phone: Número de telefone do destinatário
  • metadata: Metadados da chamada

Este método retorna um objeto com os dados da chamada, incluindo:

  • id: Identificador único da chamada
  • message: Mensagem de sucesso

Importante:

  • Para realizar uma chamada de voz, é necessário informar o token de autenticação no cabeçalho da requisição.
  • Todas as chaves / valores enviados no campo metadata serão disponibilizados no webhook da chamada.
  • Este recurso possui um débito técnico onde o ID da chamada retornado não é o mesmo ID da chamada na Lista de Chamadas.
  • Este ID retornado funciona apenas para cancelar a chamada.
  • Para obter o ID da chamada correto utilize webhooks.

Corpo da Requisição

JSON
{
"extension": "1000",
"phone": "+554833328530",
"metadata": {
}
}

Respostas

Request was successful
JSON
{
"id": "1PkXhmBsYAvr9legLB2d7BimT0Q",
"message": "successfull"
}

Exemplos

cURL
curl -X POST \
'https://api.api4com.com/api/v1/dialer' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.api4com.com/api/v1/dialer', {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/dialer';
$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/dialer'

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

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

Released under the MIT License.