Pular para o conteúdo principal

Confirmações de leitura

Método#

/privacy/read-receipts#

POST https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/privacy/read-receipts?value=VALOR_DA_CONFIGURAÇÃO

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Através deste método, é possível configurar as confirmações de leitura de mensagens (não aplicável a grupos).


Atributos#

Obrigatório#

AtributosTipoDescrição
valuestringHabilitar ou desabilitar as confirmações de leitura (enable, disable)

String (value) valores aceitos:

  • enable (Habilita as confirmações de leitura)
  • disable (Desabilita as confirmações de leitura)

Request Params#

URL exemplo#

Método

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/privacy/read-receipts?value=enable

Importante

Ao desabilitar as confirmações de leitura, você também não pode ver se suas mensagens foram lidas.


Response#

200#

AtributosTipoDescrição
successbooleantrue caso tenha dado certo e false em caso de falha

Exemplo

{
"success": true
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou PUT conforme especificado no inicio deste tópico.

415#

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"


Code#