Listagem de Agentes

Descrição: A API "Listagem de Agentes" tem como objetivo listar os agentes criados no sistema PABX e fornecer informações relevantes sobre o status de cada agente. Ela oferece detalhes essenciais, como o ID do agente, nome, e-mail, data de criação, data de modificação, status de habilitação, permissões, número de extensão, senha de registro, status de pausa, status de campanha e tipo do objeto.

Propriedades da Resposta

A tabela abaixo apresenta as propriedades que são retornadas pela API:

Propriedade	Tipo	Descrição
id	Number	ID do agente
name	String	Nome do agente
email	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

Essas informações permitem entender melhor os detalhes do agente do Asterisk retornados pelo JSON.

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...
    ]
}

O exemplo acima mostra o formato da resposta da API com uma entrada fictícia de agente.

Paginação

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.

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.

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.

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.

Em resumo, esse JSON de paginação é usado para definir os parâmetros de uma solicitação de busca paginada, incluindo o início da página, o número máximo de registros por página, informações de rastreamento e configurações de pesquisa, como o uso de expressões regulares (neste caso, desativado). Isso é frequentemente utilizado em aplicações web para exibir grandes conjuntos de dados de forma paginada e controlada.

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Listagem de Agentes

application/json

Body

Exemplo

{
    "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"
        },
        {
            "id": 1004,
            "name": "Agente 4",
            "email": "403@localhost",
            "created": "2022-10-28T15:05:34-03:00",
            "modified": "2022-10-28T15:05:34-03:00",
            "enabled": true,
            "standard": false,
            "scope": "ROLE_AGENT",
            "exten": "403",
            "secret": "20178371",
            "paused": false,
            "onCampaign": false,
            "t_type": "agent"
        },
        {
            "id": 1005,
            "name": "Agente 5",
            "email": "404@localhost",
            "created": "2022-10-28T15:05:37-03:00",
            "modified": "2022-10-28T15:05:37-03:00",
            "enabled": true,
            "standard": false,
            "scope": "ROLE_AGENT",
            "exten": "404",
            "secret": "44488353",
            "paused": false,
            "onCampaign": false,
            "t_type": "agent"
        },
        {
            "id": 1001,
            "name": "Agente 1",
            "email": "400@localhost",
            "created": "2022-10-28T15:05:25-03:00",
            "modified": "2023-06-07T10:35:33-03:00",
            "enabled": true,
            "standard": false,
            "scope": "ROLE_AGENT:ROLE_APP_1:ROLE_APP_2:ROLE_APP_2_1:ROLE_APP_2_2:ROLE_APP_2_3:ROLE_APP_2_4:ROLE_APP_2_5:ROLE_APP_2_6:ROLE_APP_2_7:ROLE_APP_2_8:ROLE_APP_2_10:ROLE_APP_2_11:ROLE_APP_3:ROLE_APP_3_12:ROLE_APP_3_13:ROLE_APP_6:ROLE_APP_7:ROLE_APP_7_16:ROLE_APP_7_17:ROLE_APP_7_18:ROLE_APP_7_19:ROLE_APP_7_20:ROLE_APP_7_21:ROLE_APP_7_22:ROLE_APP_7_23:ROLE_APP_7_24:ROLE_APP_7_44:ROLE_APP_7_45:ROLE_APP_8:ROLE_APP_8_25:ROLE_APP_8_26:ROLE_APP_8_27:ROLE_APP_8_28:ROLE_APP_8_29:ROLE_APP_9:ROLE_APP_9_30:ROLE_APP_9_31:ROLE_APP_9_32:ROLE_APP_9_33:ROLE_APP_9_34:ROLE_APP_9_35:ROLE_APP_9_36:ROLE_APP_9_37:ROLE_APP_9_38:ROLE_APP_10:ROLE_APP_10_39:ROLE_APP_10_40:ROLE_APP_11:ROLE_APP_12:ROLE_APP_12_41:ROLE_APP_12_42:ROLE_APP_12_43:ROLE_APP_13:ROLE_APP_14:ROLE_APP_15:ROLE_APP_16:ROLE_APP_16_46:ROLE_APP_16_47:ROLE_APP_16_48",
            "profileName": "Todos",
            "profileId": 1,
            "exten": "400",
            "secret": "06442647",
            "paused": false,
            "onCampaign": false,
            "t_type": "agent"
        },
        {
            "id": 1002,
            "name": "Agente 2",
            "email": "401@localhost",
            "created": "2022-10-28T15:05:28-03:00",
            "modified": "2023-06-13T12:30:17-03:00",
            "enabled": true,
            "standard": false,
            "scope": "ROLE_AGENT:ROLE_APP_1:ROLE_APP_2:ROLE_APP_2_1:ROLE_APP_2_2:ROLE_APP_2_3:ROLE_APP_2_4:ROLE_APP_2_5:ROLE_APP_2_6:ROLE_APP_2_7:ROLE_APP_2_8:ROLE_APP_2_10:ROLE_APP_2_11:ROLE_APP_3:ROLE_APP_3_12:ROLE_APP_3_13:ROLE_APP_6:ROLE_APP_7:ROLE_APP_7_16:ROLE_APP_7_17:ROLE_APP_7_18:ROLE_APP_7_19:ROLE_APP_7_20:ROLE_APP_7_21:ROLE_APP_7_22:ROLE_APP_7_23:ROLE_APP_7_24:ROLE_APP_7_44:ROLE_APP_7_45:ROLE_APP_8:ROLE_APP_8_25:ROLE_APP_8_26:ROLE_APP_8_27:ROLE_APP_8_28:ROLE_APP_8_29:ROLE_APP_9:ROLE_APP_9_30:ROLE_APP_9_31:ROLE_APP_9_32:ROLE_APP_9_33:ROLE_APP_9_34:ROLE_APP_9_35:ROLE_APP_9_36:ROLE_APP_9_37:ROLE_APP_9_38:ROLE_APP_10:ROLE_APP_10_39:ROLE_APP_10_40:ROLE_APP_11:ROLE_APP_12:ROLE_APP_12_41:ROLE_APP_12_42:ROLE_APP_12_43:ROLE_APP_13:ROLE_APP_14:ROLE_APP_15:ROLE_APP_16:ROLE_APP_16_46:ROLE_APP_16_47:ROLE_APP_16_48",
            "profileName": "Todos",
            "profileId": 1,
            "exten": "401",
            "secret": "44526797",
            "paused": false,
            "onCampaign": false,
            "t_type": "agent"
        }
    ]
}

Listagem de Agentes