curl -X GET "https://api.oxenty.api.br/api/sessions/550e8400-e29b-41d4-a716-446655440000" \
-H "X-API-Key: YOUR_API_KEY"
const session = await client.sessions.get('550e8400-e29b-41d4-a716-446655440000');
session = client.sessions.get('550e8400-e29b-41d4-a716-446655440000')
{
"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"
}
{
"statusCode": 404,
"error": "SESSION_NOT_FOUND",
"message": "Sessão não encontrada"
}
Sessões
Obter Sessão
Obtém detalhes de uma sessão específica
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"
const session = await client.sessions.get('550e8400-e29b-41d4-a716-446655440000');
session = client.sessions.get('550e8400-e29b-41d4-a716-446655440000')
{
"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"
}
{
"statusCode": 404,
"error": "SESSION_NOT_FOUND",
"message": "Sessão não encontrada"
}
Retorna os detalhes completos de uma sessão.
Path Parameters
string
required
ID da sessão (UUID).
Resposta
string
ID único da sessão.
string
Nome da sessão.
string
Status atual da sessão.
string
Número de telefone conectado (quando conectado).
boolean
Se mensagens de grupo estão habilitadas.
string
URL do webhook configurado.
string[]
Eventos configurados para o webhook.
boolean
Se há webhook configurado.
string
Data de criação (ISO 8601).
string
Data da última atualização.
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"
const session = await client.sessions.get('550e8400-e29b-41d4-a716-446655440000');
session = client.sessions.get('550e8400-e29b-41d4-a716-446655440000')
{
"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"
}
{
"statusCode": 404,
"error": "SESSION_NOT_FOUND",
"message": "Sessão não encontrada"
}