Skip to navigation

Usando a API para consultar qualificações

Para consultar qualificações 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 qualificações

Este endpoint retorna todas as qualificações cadastradas no sistema.

Exemplo de chamada:

curl -X GET "https://sua-conta.callix.com.br/api/v1/qualifications" \
-H "Authorization: Bearer SEU_TOKEN"

Exemplo de resposta:

{
"data": [
{
"id": 1,
"type": "qualifications",
"attributes": {
"name": "Qualificação 1",
"cpc": true,
"success": true,
"is_system_qualification": false
}
},
{
"id": 2,
"type": "qualifications",
"attributes": {
"name": "Qualificação 2",
"cpc": true,
"success": false,
"is_system_qualification": false
}
}
]
}

Filtros disponíveis:

Esta rota permite filtrar qualificações usando os seguintes parâmetros:

FiltroTipoDescriçãoExemplo
filter[cpc]booleanRetorna apenas qualificações cujo atributo cpc seja igual ao valor definidofilter[cpc]=true
filter[success]booleanRetorna apenas qualificações cujo atributo success seja igual ao valor definidofilter[success]=true
filter[is_system_qualification]booleanRetorna apenas qualificações cujo atributo is_system_qualification seja igual ao valor definidofilter[is_system_qualification]=false

Exemplo de chamada com filtros:

curl -X GET "https://sua-conta.callix.com.br/api/v1/qualifications?filter[cpc]=true&filter[success]=true" \
-H "Authorization: Bearer SEU_TOKEN"

2. Consultar uma qualificação específica

Este endpoint retorna informações detalhadas de uma qualificação específica usando seu ID.

Exemplo de chamada:

curl -X GET "https://sua-conta.callix.com.br/api/v1/qualifications/1" \
-H "Authorization: Bearer SEU_TOKEN"

Exemplo de resposta:

{
"data": {
"id": 1,
"type": "qualifications",
"attributes": {
"name": "Qualificação 1",
"cpc": true,
"success": true,
"is_system_qualification": false
}
}
}

Atributos

AtributoTipoDescrição
namestringNome da qualificação
cpcbooleanIndica se é uma qualificação de contato com a pessoa certa
successbooleanIndica se é uma qualificação de sucesso
is_system_qualificationbooleanIndica se é uma qualificação do sistema