Skip to main content
POST
/
api
/
{session}
/
presence
/
{chatId}
/
subscribe
Inscrever-se em eventos de presença para a conversa
curl --request POST \
  --url https://{host}/api/{session}/presence/{chatId}/subscribe \
  --header 'apikey: <api-key>'
{
  "success": true,
  "message": "Subscrição de presença criada com sucesso",
  "chatId": "5511999999999@s.whatsapp.net"
}

​
Descrição

Este endpoint permite subscrever para receber atualizações de presença (status online/offline) de um contato específico. Após a subscrição, você receberá eventos sempre que o contato ficar online ou offline.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp
​
chatId
string
required
ID do chat/contato no formato 5511999999999@s.whatsapp.net

​
Resposta

{
  "success": true,
  "message": "Subscrição de presença criada com sucesso",
  "chatId": "5511999999999@s.whatsapp.net"
}

​
Códigos de Status

  • 200 - Subscrição criada com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado
  • 404 - Chat/Sessão não encontrado

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/presence/5511999999999@s.whatsapp.net/subscribe

​
Notas

  • Após subscrever, você receberá eventos de presença através do stream de eventos
  • Use o endpoint /api/events/stream/{sessionId} para receber os eventos em tempo real
  • Os eventos informarão quando o contato ficar online (AVAILABLE) ou offline (UNAVAILABLE)
  • Útil para implementar indicadores de status online em aplicações

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
chatId
string
required

ID da Conversa

Response

201 - undefined