Presença

Online, digitando e visto por último.

Basehttps://app.onzap.io/v1/instances/{instanceId}AuthX-Instance-Token: SEU_TOKEN

Definir presença

POST/v1/instances/{instanceId}/presence
API OnZap

Corpo (JSON)

presencestringobrigatório
Valores:offlineonlinetypingrecordingpaused
chatIdstringopcional
Conversa: número com DDI e DDD (5511999999999) ou JID (…@c.us, …@g.us, …@lid). Pode ser enviado como phone.
phonestringopcional
Apelido de chatId: número com DDI e DDD.
Requisição
curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/presence" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "presence": "offline"
  }'
Resposta

Sucesso

Presenças assinadas

GET/v1/instances/{instanceId}/presence
API OnZap
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/presence" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
[
  {
    "id": "5511999999999@c.us",
    "presences": [
      {
        "lastKnownPresence": "offline",
        "lastSeen": 1686568773,
        "participant": "5511999999999@c.us"
      }
    ]
  }
]

Presença de um chat

GET/v1/instances/{instanceId}/presence/{chatId}
API OnZap

Parâmetros do caminho

chatIdstringobrigatório
Conversa: número com DDI e DDD (5511999999999) ou JID (…@c.us, …@g.us, …@lid).
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/presence/5511999999999" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
{
  "id": "5511999999999@c.us",
  "presences": [
    {
      "lastKnownPresence": "offline",
      "lastSeen": 1686568773,
      "participant": "5511999999999@c.us"
    }
  ]
}

Assinar presença de um chat

POST/v1/instances/{instanceId}/presence/{chatId}/subscribe
API OnZap

Parâmetros do caminho

chatIdstringobrigatório
Conversa: número com DDI e DDD (5511999999999) ou JID (…@c.us, …@g.us, …@lid).
Requisição
curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/presence/5511999999999/subscribe" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Sucesso