Skip to main content
POST
/
api
/
sessions
/
{session}
/
start
Iniciar a sessão
curl --request POST \
  --url https://{host}/api/sessions/{session}/start \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{}'
{
  "success": true,
  "message": "Sessão iniciada com sucesso",
  "session": "my-session"
}

​
Descrição

Este endpoint inicializa uma nova sessão do WhatsApp. Após iniciar a sessão, você precisará autenticá-la usando o QR Code ou código de pareamento. É possível fornecer configurações personalizadas para o armazenamento e logs da sessão.

​
Parâmetros de URL

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

​
Body

{
  "config": {
    "store": {
      "dialect": "sqlite3",
      "address": "/app/data/whatsmeow.db"
    },
    "log": {
      "level": "INFO"
    }
  }
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
configobject❌ NãoConfigurações opcionais para a sessão
config.storeobject❌ NãoConfigurações de armazenamento da sessão
config.store.dialectstring❌ NãoTipo de banco de dados (padrão: “sqlite3”)
config.store.addressstring❌ NãoCaminho do arquivo do banco de dados (padrão: “/app/data/whatsmeow.db”)
config.logobject❌ NãoConfigurações de log da sessão
config.log.levelstring❌ NãoNível de log: “DEBUG”, “INFO”, “WARN”, “ERROR” (padrão: “INFO”)
{
  "success": true,
  "message": "Sessão iniciada com sucesso",
  "session": "my-session"
}

​
Códigos de Status

  • 200 - Sessão iniciada com sucesso
  • 400 - Parâmetros inválidos
  • 409 - Sessão já existe e está ativa

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/sessions/my-session/start \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "store": {
        "dialect": "sqlite3",
        "address": "/app/data/whatsmeow.db"
      },
      "log": {
        "level": "INFO"
      }
    }
  }'

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 iniciar

Body

application/json · object

Response

201 - application/json
​
name
string
required

Nome da sessão (instanceName)

Example:

"my-session"

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