Skip to main content
GET
/
api
/
sessions
/
{session}
Obter informações da sessão
curl --request GET \
  --url https://{host}/api/sessions/{session} \
  --header 'apikey: <api-key>'
{
  "session": "my-session",
  "status": "authenticated",
  "authenticated": true,
  "config": {
    "store": {
      "dialect": "sqlite3",
      "address": "/app/data/whatsmeow.db"
    },
    "log": {
      "level": "INFO"
    }
  }
}

​
Descrição

Este endpoint retorna informações detalhadas sobre uma sessão específica, incluindo seu status atual (ativo, pausado, autenticado, etc.) e configurações.

​
Parâmetros de URL

​
session
string
required
ID único da sessão a ser consultada

​
Resposta

​
session
string
required
ID da sessão
​
status
string
required
Status atual da sessão: “active”, “stopped”, “disconnected”, “authenticated”
​
authenticated
boolean
required
Indica se a sessão está autenticada no WhatsApp
​
config
object
Configurações da sessão (se disponíveis)
{
  "session": "my-session",
  "status": "authenticated",
  "authenticated": true,
  "config": {
    "store": {
      "dialect": "sqlite3",
      "address": "/app/data/whatsmeow.db"
    },
    "log": {
      "level": "INFO"
    }
  }
}

​
Códigos de Status

  • 200 - Informações obtidas com sucesso
  • 400 - Parâmetros inválidos
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X GET https://api.wappfy.com.br/api/sessions/my-session

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
session
string
required

O nome da sessão (instanceName) que você deseja consultar

Response

200 - application/json
​
name
string
required

Nome da instância da sessão. Use 'session' como valor padrão

Example:

"default"

​
status
enum<string>
required
Available options:
STOPPED,
STARTING,
SCAN_QR_CODE,
WORKING,
FAILED
​
me
object
​
assignedWorker
string
​
config
object