Listagem de Agentes
POST
http://{{HOST}}/service/v1/agents
Listagem de Agentes
Propriedades da Resposta
| Propriedade | Tipo | Descrição |
|---|---|---|
| id | Number | ID do agente |
| name | String | Nome do agente |
| String | E-mail do agente | |
| created | String | Data e horário de criação do agente (formato ISO 8601) |
| modified | String | Data e horário da última modificação do agente (formato ISO 8601) |
| enabled | Boolean | Indica se o agente está habilitado (true) ou desabilitado (false) |
| standard | Boolean | Indica se o agente é padrão do sistema (true) ou não (false) |
| scope | String | Nível de permissão do agente |
| exten | String | Número de extensão do agente |
| secret | String | Senha de registro do agente |
| paused | Boolean | Indica se o agente está pausado (true) ou não (false) |
| onCampaign | Boolean | Indica se o agente está em uma campanha (true) ou não (false) |
| t_type | String | Tipo do objeto |
Exemplo de Corpo da Resposta
{
"sEcho": 4,
"page": 0,
"iTotalRecords": 5,
"iTotalDisplayRecords": 5,
"aaData": [
{
"id": 1003,
"name": "Agente 3",
"email": "402@localhost",
"created": "2022-10-28T15:05:31-03:00",
"modified": "2022-10-28T15:05:31-03:00",
"enabled": true,
"standard": false,
"scope": "ROLE_AGENT",
"exten": "402",
"secret": "06237657",
"paused": false,
"onCampaign": false,
"t_type": "agent"
},
// Outros agentes...
]
}
Paginação
1.
start (Inteiro): Este campo indica a posição de início da página de resultados. Ele define o índice inicial a partir do qual os resultados devem ser recuperados. No exemplo, start está definido como 0, o que significa que a página de resultados começa a partir do primeiro registro.2.
length (Inteiro): Este campo define o número máximo de registros que devem ser retornados em uma única página de resultados. No exemplo, length está definido como 10, o que significa que a página deve conter até 10 registros.3.
sEcho (Inteiro): O campo sEcho é frequentemente usado para rastrear solicitações de paginação. Cada vez que uma nova solicitação de página é feita, esse número de sequência é incrementado. Ele pode ser usado para garantir que as respostas correspondam às solicitações e evitar resultados desatualizados.4.
search (Objeto): Este campo é usado para configurar opções de pesquisa, mas no exemplo fornecido, parece estar configurado para desativar a pesquisa usando regex (expressões regulares). O campo regex está definido como false, o que significa que a pesquisa não deve usar expressões regulares.Requisição
Parâmetros Header
PreAuthorization
string
requerido
Exemplo:
Bearer {{access_token}}
Parâmetros Bodyapplication/json