Skip to main content
POST
/
api
/
sessions
/
{session}
/
stop
Parar a sessão
curl --request POST \
  --url https://{host}/api/sessions/{session}/stop \
  --header 'apikey: <api-key>'
{
  "success": true,
  "message": "Sessão pausada com sucesso",
  "session": "my-session"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

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

​
Descrição

Este endpoint pausa uma sessão do WhatsApp que está ativa. A sessão não será desconectada do WhatsApp, apenas pausada temporariamente. Para desconectar completamente, use o endpoint de logout.

​
Parâmetros de URL

​
session
string
required
ID único da sessão a ser pausada
{
  "success": true,
  "message": "Sessão pausada com sucesso",
  "session": "my-session"
}

​
Códigos de Status

  • 200 - Sessão pausada com sucesso
  • 400 - Parâmetros inválidos
  • 404 - Sessão não encontrada
  • 409 - Sessão já está pausada

​
Exemplo de Uso

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

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 parar

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