Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
privacy
/
disallowed-contacts
Listar contatos não permitidos
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/disallowed-contacts \
  --header 'Client-Token: <api-key>'
{
  "disallowedContacts": [
    {}
  ]
}

​
Conceituação

Através deste método, é possível listar os contatos que estão na lista de não permitidos (blacklist) para certas interações com sua conta.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
type
string
obrigatório
Define o escopo do bloqueio: lastSeen, photo, description ou groupAdd

​
Response

​
200

​
disallowedContacts
array
Lista de números de telefone bloqueados
{
  "disallowedContacts": [
    "554411111111",
    "554422222222"
  ]
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início 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”.