Pular para o conteúdo principal

Visualização de online

Método#

/privacy/online#

POST https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/privacy/online

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Através deste método, é possível configurar quem pode ver quando você estiver online.


Atributos#

Obrigatório#

AtributosTipoDescrição
visualizationTypestringEscopo de visualização (ALL, SAME_LAST_SEEN)

String (visualizationType)

Escopo de visualização. Valores aceitos:

  • ALL (Todos podem ver)
  • SAME_LAST_SEEN (Mesma configuração utilizada no "visto por último")

Request Body#

Método

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/privacy/online

Exemplo

{
"visualizationType": "ALL"
}

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#