Skip to content

Exibir ramal

GET
/extensions/{id}

Para buscar um ramal na conta, utilize o método GET na rota /extensions/{id}. Este método requer os seguintes parâmetros:

  • id: Identificador único do ramal

Este método retorna um objeto com os dados do ramal, incluindo:

  • id: Identificador único do ramal
  • domain: Domínio da conta
  • ramal: Número do ramal
  • senha: Senha do ramal
  • bina: Bina do ramal
  • first_name: Nome do usuário do ramal
  • last_name: Sobrenome do usuário do ramal
  • email_address: E-mail do usuário do ramal
  • gravar_audio: Indica se as chamadas do ramal devem ser gravadas

Para o campo gravar_audio, os valores possíveis são:

  • 0: Não gravar chamadas
  • 1: Gravar chamadas

Importante:

  • Para buscar um ramal na conta, é necessário informar o token de autenticação no cabeçalho da requisição.
  • O campo gravar_audio indica se as chamadas do ramal devem ser gravadas.
  • O campo bina é opcional e pode ser utilizado para identificar o número de origem das chamadas.
  • Caso o ramal não seja encontrado, o método retorna um erro com o código 404.

Parâmetros

Parâmetros de Caminho

id*

ID do ramal

Tipostring
Obrigatório

Respostas

Request was successful
JSON
{
"id": 123,
"domain": "suporte.api4com.com",
"ramal": "1001",
"senha": "PwDLooL",
"bina": "4833328530",
"first_name": "Silvio",
"last_name": "Fernandes",
"email_address": "suporte@api4com.com",
"gravar_audio": 0
}

Exemplos

cURL
curl -X GET \
'https://api.api4com.com/api/v1/extensions/{id}' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.api4com.com/api/v1/extensions/{id}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://api.api4com.com/api/v1/extensions/{id}';
$method = 'GET';
$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/extensions/{id}'

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

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

Released under the MIT License.