Criar ou atualizar ramais

PATCH

/extensions

Para criar ou atualizar um ramal na conta, utilize o método PATCH na rota /extensions. Este método requer os seguintes parâmetros:

• id: Identificador único do ramal
• 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

Este método retorna um objeto com os dados do ramal criado ou atualizado, 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 criar ou atualizar um ramal na conta, é necessário informar o token de autenticação no cabeçalho da requisição.
• Caso o campo id seja informado, o método atualiza o ramal com o identificador informado. Caso contrário, o método cria um novo ramal.
• 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.

Corpo da Requisição

Usar exemplo

{

"id": 123,

"ramal": "1001",

"senha": "PwDLooL",

"bina": "4833328530",

"first_name": "Silvio",

"last_name": "Fernandes",

"email_address": "suporte@api4com.com",

"gravar_audio": 1

}

Respostas

Request was successful

Content-Type

Usar exemplo

{

"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

}

PATCH

/extensions

Exemplos

cURL

curl -X PATCH \
'https://api.api4com.com/api/v1/extensions' \
 -H "Content-Type: application/json"

JavaScript

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

PHP

<?php
$url = 'https://api.api4com.com/api/v1/extensions';
$method = 'PATCH';
$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'

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

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