Lista de agentes

GET

/v1/agents/agentlist

Endpoint utilizado para buscar a lista de agents do PABX. Tamanho máximo da lista será de 200 itens. Se houver mais agentes configurados no PABX uTech, deve-se utilizar o parâmetro page, para buscar os próximos 200. Os valores aceitos para o parâmetro page são de 0 a 5000.

Versão do PABX

Igual ou superior a versão 2.0.1 - Ter 02 Dez 2025 15:55:58 -03 C7

Requisição

Parâmetros de Consulta

Respostas

🟢200Sucesso

application/json

Body

🟠401Authentication error

🔴500Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://seupabxutech.exemplo.com.br/v1/agents/agentlist?token=d743a66706879a1b700d44f2aba90070&page=0'

Response Example

200 - Sucesso

{
    "status": "ok",
    "agentlist": {
        "agents": [
            {
                "id": "123",
                "agentid": "200",
                "name": "Luiz Mario",
                "queues": [
                    {
                        "queue": "7000",
                        "priority": "0"
                    },
                    {
                        "queue": "7001",
                        "priority": "1"
                    },
                ],
                "callback": false,
                "shift": true,
                "shiftlist": {
                    "993": {
                        "name": "Semana",
                        "start": "08:00",
                        "end": "18:00",
                        "week": "mon,tue,wed,thu,fri"
                    },
                    "994": {
                        "name": "Fim de semana",
                        "start": "08:00",
                        "end": "12:00",
                        "week": "sun,sat"
                    }
                },
                "holdmusic": "padrao",
                "disable": false,
                "email": false,
                "chat": true
            }
        ],
        "total": 1,
        "count": 1,
        "page": 0
    }
}

Modificado em 2025-12-29 14:26:23