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#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Através deste método, é possível configurar quem pode te adicionar em grupos.
Atributos#
Obrigatório#
| Atributos | Tipo | Descrição |
|---|---|---|
| type | string | Escopo 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#
| Atributos | Tipo | Descrição |
|---|---|---|
| contactsBlacklist | array object | Contatos a serem adicionados ou removidos da blacklist. Deve ser enviado quando o "type" for "CONTACT_BLACKLIST" |
Array Object (contactsBlacklist)
| Atributos | Tipo | Descrição |
|---|---|---|
| action | string | Ação a ser realizada para o contato; adicionar ou remover da blacklist (add, remove) |
| phone | string | Número do contato |
Request Body#
Método
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/privacy/group-add
Exemplo
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#
| Atributos | Tipo | Descrição |
|---|---|---|
| success | boolean | true caso tenha dado certo e false em caso de falha |
Exemplo
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"