Skip to main content
POST
/
api
/
{session}
/
presence
Definir presença da sessão
curl --request POST \
  --url https://{host}/api/{session}/presence \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "chatId": "[email protected]",
  "presence": "offline"
}
'
{
  "success": true,
  "message": "Presença atualizada com sucesso",
  "status": "AVAILABLE"
}

​
Descrição

Este endpoint permite definir o status de presença da sessão WhatsApp, controlando se a conta aparece como disponível (online) ou indisponível (offline) para outros usuários.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp

​
Body

{
  "status": "valor"
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
statusstring✅ SimStatus de presença a ser definido. Valores aceitos: - AVAILABLE - Aparece como disponível/online - UNAVAILABLE - Aparece como indisponível/offline

​
Resposta

{
  "success": true,
  "message": "Presença atualizada com sucesso",
  "status": "AVAILABLE"
}

​
Códigos de Status

  • 200 - Presença atualizada com sucesso
  • 400 - Parâmetros inválidos (status deve ser AVAILABLE ou UNAVAILABLE)
  • 401 - Não autorizado
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/presence \
  -H "Content-Type: application/json" \
  -d '{
    "status": "AVAILABLE"
  }'

​
Notas

  • O status AVAILABLE fará com que a conta apareça como online para outros usuários
  • O status UNAVAILABLE fará com que a conta apareça como offline
  • Esta configuração pode ser útil para controlar a visibilidade da presença da automação

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
session
string
required

Nome da sessão (instanceName)

Body

application/json
​
chatId
string
required

Chat ID - either group id or contact id

Example:

"[email protected]"

​
presence
enum<string>
required
Available options:
offline,
online,
typing,
recording,
paused

Response

201 - undefined