Skip to main content
POST
/
session
/
connect
Criar sessão
curl --request POST \
  --url https://apizap.loce.io/v1/session/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionName": "<string>",
  "webhookUrl": "<string>",
  "webhookMessages": true
}
'
{
  "sessionId": "<string>",
  "status": "<string>",
  "qrCode": "<string>",
  "webhookUrl": "<string>",
  "webhookMessages": true
}
POST /session/connect 
curl -X POST "BASE_URL/v1/session/connect" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -d '{
    "sessionName": "NOME_DA_SESSAO",
    "webhookUrl": "https://seu-webhook.com/eventos",
    "webhookMessages": true,
    "mode": "qr",
    "pairingNumber": "5511999999999"
  }'
  • sessionName (string) e webhookUrl (URL) sao obrigatorios.
  • webhookMessages bool (default true).
  • mode: qr ou pairing (default qr).
  • pairingNumber: so quando mode = pairing (DDI+numero).
  • Se o ambiente exigir API key, adicione o header extra (ex.: -H "x-api-key: SUA_API_KEY").

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sessionName
string
required

Nome amigável exibido no painel. Deve ser único por workspace.

​
webhookUrl
string<uri>
required

Endpoint HTTPS que receberá eventos da sessão.

​
webhookMessages
boolean

Ativa o envio de webhooks de mensagens (dependente do plano).

Response

Sessão criada com sucesso.

​
sessionId
string

Identificador único da sessão criada.

​
status
string

Estado atual da sessão (ex.: pending, connected).

​
qrCode
string

Payload do QR Code que deve ser renderizado para pareamento.

​
webhookUrl
string<uri>
​
webhookMessages
boolean