Skip to main content
GET
/
api
/
sessions
/
:id
curl -X GET "https://api.oxenty.api.br/api/sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "atendimento-principal",
  "status": "connected",
  "phone": "5511999999999",
  "allowGroup": true,
  "webhookUrl": "https://seu-servidor.com/webhook",
  "webhookEvents": ["message.received", "message.status"],
  "hasWebhook": true,
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-01-15T10:00:00.000Z",
  "connectedAt": "2024-01-15T10:05:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oxenty.api.br/llms.txt

Use this file to discover all available pages before exploring further.

Retorna os detalhes completos de uma sessão.

​
Path Parameters

​
id
string
required
ID da sessão (UUID).

​
Resposta

​
id
string
ID único da sessão.
​
name
string
Nome da sessão.
​
status
string
Status atual da sessão.
​
phone
string
Número de telefone conectado (quando conectado).
​
allowGroup
boolean
Se mensagens de grupo estão habilitadas.
​
webhookUrl
string
URL do webhook configurado.
​
webhookEvents
string[]
Eventos configurados para o webhook.
​
hasWebhook
boolean
Se há webhook configurado.
​
createdAt
string
Data de criação (ISO 8601).
​
updatedAt
string
Data da última atualização.
​
connectedAt
string
Data da última conexão bem-sucedida.
curl -X GET "https://api.oxenty.api.br/api/sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "atendimento-principal",
  "status": "connected",
  "phone": "5511999999999",
  "allowGroup": true,
  "webhookUrl": "https://seu-servidor.com/webhook",
  "webhookEvents": ["message.received", "message.status"],
  "hasWebhook": true,
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-01-15T10:00:00.000Z",
  "connectedAt": "2024-01-15T10:05:00.000Z"
}