Obter sessão

Em desenvolvimento

GET

https://api.botszap.com.br/api/v1/sessions/{sessionid}

Obtém dados da sessão

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-api-key

Exemplo:

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

Parâmetros de Caminho

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff 'https://api.botszap.com.br/api/v1/sessions/{{$string.uuid}}' \
--header 'x-api-key: <api-key>'

Respostas

🟢200Sessão encontrada

application/json

Bodyapplication/json

Exemplo

{
    "sessionId": "82c6c663-5a1d-4a7b-acf6-e15f423770b1",
    "sessionDescription": "Minha sessão",
    "sessionStatus": 2,
    "displayName": null,
    "displayImage": null,
    "isTimelocked": true,
    "timelockedUntilUtc": "2026-10-09T01:01:31.008Z",
    "newContactTotalQuota": 19,
    "newContactUsedQuota": 46,
    "newContactCycleStartUtc": "2026-10-09T01:01:31.008Z",
    "newContactCycleEndUtc": "2026-10-09T01:01:31.008Z",
    "isActive": false
}

🟠404Sessão não encontrada

Modificado em 2026-10-09 12:13:10