Pular para o conteúdo principal

Permissão para adicionar em grupos

Método#

/privacy/group-add#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Através deste método, é possível configurar quem pode te adicionar em grupos.


Atributos#

Obrigatório#

AtributosTipoDescrição
typestringEscopo da permissão (ALL, CONTACTS, CONTACT_BLACKLIST)

String (type)

Escopo da permissão. Valores aceitos:

  • ALL (Todos podem adicionar)
  • CONTACTS (Apenas meus contatos)
  • CONTACT_BLACKLIST (Apenas meus contatos, exceto...)

Opcional#

AtributosTipoDescrição
contactsBlacklistarray objectContatos a serem adicionados ou removidos da blacklist. Deve ser enviado quando o "type" for "CONTACT_BLACKLIST"

Array Object (contactsBlacklist)

AtributosTipoDescrição
actionstringAção a ser realizada para o contato; adicionar ou remover da blacklist (add, remove)
phonestringNúmero do contato

Request Body#

Método

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

Exemplo

{
"type": "ALL"
}
{
"type": "CONTACT_BLACKLIST",
"contactsBlacklist": [
{ "action": "add", "phone": "554411111111" },
{ "action": "remove", "phone": "554422222222" }
]
}
Importante

É importante destacar que a blacklist (lista de contatos não permitidos) é diferente para cada configuração de privacidade, isto é, a blacklist de "visto por último" não é a mesma da "foto do perfil", e assim para todas a configurações que aceitam a blacklist.

Dica

Não é necessário reenviar o atributo "contactsBlacklist" com os contatos já adicionados. Esse parâmetro é somente para alterações na blacklist.


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#