Mamute
  1. agent
Mamute
Mamute APIs
  • Relatórios
  • Mamute APIs
  • Mamute Addons APIs
  • Introdução
  • manager
    • sms
      • Saldo
      • Envio de SMS
    • Pabx
      • Capturar chamada
      • Fazer ligação
      • Encerrar chamada
      • Baixar gravações de um determinado dia
      • Baixar gravação formato padrão
      • Baixar gravação formato MP3
      • Ouvir gravação
  • sms
    • Saldo
      GET
    • Enivo de SMS
      GET
  • export
    • Volume de ligações da fila
      POST
  • report
    • Integracao
      • URA histórico requisições - Autoatendimento (D)
      • Master URA MVNO - Autoatendimento (C)
      • Plugin URA - Autoatendimento (C)
      • Plugin URA - Autoatendimento (D)
    • Call Center
      • Pausas do agente (D)
      • Atividades do agente (D)
      • Abandono (P)
      • Chamada da fila (D)
      • Produtividade da fila (P)
      • Chamadas do agente (D)
      • Pesquisa de satisfação (D)
      • Fila com ILA 20-60 (P)
      • Produtividade do agente (P)
      • Produtividade do agente (C)
      • Resumo da fila (CQ)
      • Métricas do agente (C)
      • Métricas média do agente mensal (C)
      • Classificação de chamadas (D)
      • Produtividade da fila (C)
      • Pronto atendimento do agente (CD)
      • Pronto atendimento do agente (CA)
    • Discador
      • Discador (D)
      • Lista de Discagem (D)
      • Percentual de discagem (C)
      • Eventos do discador (CD)
      • Campanha (D)
    • Central de Telefonia
      • Chamadas (D)
      • URA (C)
      • URA opções (C)
      • URA (D)
      • URA (CR)
      • URA Opções (CR)
      • Distribuição de Chamadas por Tronco (D)
      • Chamadas do ramal (C)
      • Chamadas do ramal (D)
  • queue
    • Listagem de Fila de Espera
      POST
    • Indentificação de Fila por ID
      GET
  • agent
    • Listagem de Agentes
      POST
    • Indentificação de Agente por ID
      GET
  • branch
    • Listagem de ramal
      POST
    • Identificação de ramal por ID
      GET
  1. agent

Listagem de Agentes

POST
http://{{HOST}}/service/v1/agents

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:
PropriedadeTipoDescrição
idNumberID do agente
nameStringNome do agente
emailStringE-mail do agente
createdStringData e horário de criação do agente (formato ISO 8601)
modifiedStringData e horário da última modificação do agente (formato ISO 8601)
enabledBooleanIndica se o agente está habilitado (true) ou desabilitado (false)
standardBooleanIndica se o agente é padrão do sistema (true) ou não (false)
scopeStringNível de permissão do agente
extenStringNúmero de extensão do agente
secretStringSenha de registro do agente
pausedBooleanIndica se o agente está pausado (true) ou não (false)
onCampaignBooleanIndica se o agente está em uma campanha (true) ou não (false)
t_typeStringTipo 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#

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

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo
{
    "start": 0,
    "length": 10,
    "sEcho": 1,
    "search": {
        "regex": false
    }
} 

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://{{HOST}}/service/v1/agents' \
--header 'PreAuthorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start": 0,
    "length": 10,
    "sEcho": 1,
    "search": {
        "regex": false
    }
}'

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"
        }
    ]
}
Modificado em 2024-08-23 19:26:42
Página anterior
Indentificação de Fila por ID
Próxima página
Indentificação de Agente por ID
Built with