PEPINO ZAPdocs
Referência da APIMensagens

Marca mensagens como lidas

Ver como Markdown
POST
/v1/instances/{id}/messages/read

Enfileira a marcacao de uma ou mais mensagens como lidas (read receipt). messageIds lista os IDs a marcar e fromMe indica se foram enviadas pela propria instancia. O envio e assincrono (resposta 202).

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador da instancia.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/instances/cm5x8a9k20001abc123def456/messages/read" \  -H "Content-Type: application/json" \  -d '{    "to": "5511999999999",    "messageIds": [      "3EB0XXXXXXXXXXXXXXXX"    ],    "fromMe": false  }'
{
  "queued": true,
  "to": "5511999999999"
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}