Listar sessões

Em desenvolvimento

GET

https://api.botszap.com.br/api/v1/sessions/

Lista todas as sessões ativas e/ou desativadas

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Consulta

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.botszap.com.br/api/v1/sessions/?page=1&size=50&filterByIsActive=1' \
--header 'x-api-key: <api-key>'

Respostas

🟢200Lista de sessões

application/json

Bodyapplication/json

Exemplo

{
    "page": 1,
    "pageSize": 2,
    "total": 2,
    "totalPages": 1,
    "sessions": [
        {
            "sessionId": "5687308d-5cb9-4784-b01b-bf95f286e503",
            "sessionDescription": "Minha sessão",
            "sessionStatus": 1,
            "displayName": null,
            "displayImage": null,
            "isTimelocked": true,
            "timelockedUntilUtc": "2026-10-09T01:05:43.938Z",
            "newContactTotalQuota": 18,
            "newContactUsedQuota": 96,
            "newContactCycleStartUtc": "2026-10-09T01:05:43.938Z",
            "newContactCycleEndUtc": "2026-10-09T01:05:43.939Z",
            "isActive": true
        },
        {
            "sessionId": "f8945573-41d2-4f40-b1f0-43231e20f381",
            "sessionDescription": "Minha outra sessão",
            "sessionStatus": 1,
            "displayName": null,
            "displayImage": null,
            "isTimelocked": false,
            "timelockedUntilUtc": "2026-10-09T01:05:43.939Z",
            "newContactTotalQuota": 23,
            "newContactUsedQuota": 50,
            "newContactCycleStartUtc": "2026-10-09T01:05:43.940Z",
            "newContactCycleEndUtc": "2026-10-09T01:05:43.940Z",
            "isActive": true
        }
    ]
}

Modificado em 2026-10-09 01:39:38

Próxima página

Obter dados da sessão