Usando a API para consultar filas
Para consultar filas de chamada usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.
Cumprindo esse requisito, siga os passos descritos abaixo:
1. Listar todas as filas
Este endpoint retorna todas as filas de chamada cadastradas no sistema.
Exemplo de chamada:
GET
Params
Authorization
| Key | Value |
|---|
var axios = require("axios").default; var options = { method: 'GET', url: 'https://exemplo.callix.com.br/api/v1/call_queues', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer {seu_token }'} }; axios.request(options).then(function (response) { console.log(response.data); }).catch(function (error) { console.error(error); });
Para testar, configure na página de Autenticação.
Exemplo de resposta:
{
"data": [
{
"id": 1,
"type": "call_queues",
"attributes": {
"name": "Fila 1"
}
},
{
"id": 2,
"type": "call_queues",
"attributes": {
"name": "Fila 2"
}
}
]
}A resposta inclui um array com todas as filas cadastradas, seus IDs e nomes.
2. Consultar uma fila específica
Este endpoint retorna informações detalhadas de uma fila específica usando seu ID.
Exemplo de chamada:
GET
Params
Authorization
| Key | Value |
|---|
var axios = require("axios").default; var options = { method: 'GET', url: 'https://exemplo.callix.com.br/api/v1/call_queues/1', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer {seu_token }'} }; axios.request(options).then(function (response) { console.log(response.data); }).catch(function (error) { console.error(error); });
Para testar, configure na página de Autenticação.
Exemplo de resposta:
{
"data": {
"id": 1,
"type": "call_queues",
"attributes": {
"name": "Fila 1"
}
}
}Atributos
| Atributo | Tipo | Descrição |
|---|---|---|
name | string | Nome da fila de chamada |
Last updated on