Z-API (NicoApp)
Traz as operações do WhatsApp por QR Code do Z-API para dentro do fluxo: grupos, comunidades, catálogo, etiquetas, dados do aparelho e anúncios de origem.
O Z-API é um serviço brasileiro que expõe o WhatsApp como API a partir de uma sessão conectada por QR Code — na prática, quase tudo o que você faz no WhatsApp Web dá para fazer por chamada. Este MiniApp traz essas operações para dentro do fluxo do NicoChat.
O uso mais comum é chegar onde o canal padrão não chega: administrar grupos e comunidades, mexer no catálogo do WhatsApp Business, aplicar etiquetas, consultar dados do aparelho conectado e ler as informações do anúncio que originou a conversa.
Site oficial: www.z-api.io.
Nota
Você precisa ter uma instância contratada no Z-API. O ID e o Token da instância ficam nos ajustes dela; o Token de segurança da conta fica em app.z-api.io/app/security.
Campo
Obrigatório
Onde encontrar
ID da instância
Sim
Presente nos ajustes do Z-API
Token da instância
Sim
Presente nos ajustes do Z-API
Token de segurança da conta
Sim
Presente em https://app.z-api.io/app/security
As ações estão organizadas nas mesmas pastas que aparecem no construtor. As entradas listadas são as obrigatórias; as saídas viram variáveis para as etapas seguintes.
Ação
O que faz
Entradas obrigatórias
Saídas
Adicionar Administrador
Adicionar um ou mais administradores de um grupo.
ID / Link do Grupo
—
Adicionar Participantes
Por adicionar lista de novos participantes ao grupo.
ID / Link do Grupo, Convidar por Link caso não consiga adicionar?
—
Aprovar Participantes
Por aceitar a entrada de participantes no grupo.
ID / Link do Grupo
—
CriarGrupo
É reponsavel por criar um grupo com seus respectivos participantes. Assim como no Whatsapp Web você vai precisar adicionar ao menos um contato para conseguir criar um grupo.
Nome do Grupo, Telefone a ser adicionado, Convidar por Link caso não consiga adicionar?
Id do Grupo
Editar Grupo
É reponsavel por criar um grupo com seus respectivos participantes. Assim como no Whatsapp Web você vai precisar adicionar ao menos um contato para conseguir criar um grupo.
ID / Link do Grupo
Id do Grupo
Obter Dados do Grupo pelo Link de Convite
Obtém o ID e os dados do grupo pelo link de convite.
URL do Grupo
ID do Grupo, Nome do Grupo, Descrição do Grupo, Número de Participantes, Lista de Participantes (JSON)
Obter Dados do Grupo pelo ID
Obtém o ID e os dados do grupo pelo link de convite.
ID do Grupo
Link de convite, Nome do Grupo, Descrição do Grupo, Número de Participantes, Lista de Participantes (JSON)
Rejeitar Participantes
Por rejeitar a entrada de participantes no grupo.
ID / Link do Grupo
—
Remover Administrador
Remover um ou mais administradores de um grupo.
ID / Link do Grupo
—
Remover Participantes
Por remover lista de novos participantes ao grupo.
ID / Link do Grupo
—
Ação
O que faz
Entradas obrigatórias
Saídas
Criar Comunidade
Criar Comunidade
Nome da Comuniadade
ID da Comunidade, ID do Grupo (Criado com a Comunidade)
Desativar Comunidade
Por desativar uma comunidade.
Comunidade
—
Desvincular grupo a Comunidade
Com essa API você consegue remover um grupo de uma comunidade.
Comunidade, ID do Grupo
—
Vincular grupo a Comunidade
Com essa API você consegue adicionar outro grupo a uma comunidade.
Comunidade, ID do Grupo
—
Ação
O que faz
Entradas obrigatórias
Saídas
Apagar Mensagem para todos
Poderá apagar uma mensagem para todos (se ainda disponível)
WhatsApp do Destinatário:, Id da Mensagem (messageId)
—
Buscar ID de uma Mensagem
Busca o ID de uma mensagem pelo seu texto
Texto da Mensagem
ID da Mensagem
Enviar Áudio
Por enviar Áudios para suas conversas.
WhatsApp do Destinatário:, URL do áudio
id, zaapId, messageId
Enviar Documento
Por enviar Documentos para suas conversas.
WhatsApp do Destinatário:, URL do Documento
id, zaapId, messageId
Enviar GIF
Por enviar GIFS para suas conversas.
WhatsApp do Destinatário:, URL do GIF
id, zaapId, messageId
Enviar Imagem
Por enviar Imagens para suas conversas.
WhatsApp do Destinatário:, URL da Imagem
id, zaapId, messageId
Enviar Link Personalizado
Método responsável por enviar links personalizados para seus contatos, é usado para compartilhar links para que o usuário possa ser redirecionado para um site.
WhatsApp do Destinatário:, Mensagem, Link Url, Titulo do Link, Imagem do Link, Descrição do Link
id, zaapId, messageId
Enviar Mensagem de Texto
Poderá enviar textos simples e pode adicioná-los usando a formatação de texto e emojis
WhatsApp do Destinatário:, Mensagem
id, zaapId, messageId
Editar Mensagem de Texto
Poderá enviar textos simples e pode adicioná-los usando a formatação de texto e emojis
WhatsApp do Destinatário:, Mensagem, ID da Mensagem
id, zaapId, messageId
Enviar PTV (Mensagem de Vídeo Redondo)
Por enviar adesivos para suas conversas.
WhatsApp do Destinatário:, URL do Vídeo
id, zaapId, messageId
Enviar Sticker
Por enviar adesivos para suas conversas.
WhatsApp do Destinatário:, URL do Sticker
id, zaapId, messageId
Enviar Vídeo
Por enviar Videos para suas conversas.
WhatsApp do Destinatário:, URL do Video
id, zaapId, messageId
Enviar Card de Contato
Faz uma chamada para um número que tem o WhatsApp, seja ele seu contato ou não
WhatsApp do Destinatário:, Nome do Contato, Telefone do Contato
id, zaapId, messageId
Ação
O que faz
Entradas obrigatórias
Saídas
Atualizar Canal
Por editar um canal.
Canal
—
Criar Canal
Por criar um canal.
Nome do Canal
ID do Canal
Excluir um Canal
Por excluir um canal.
Canal
—
Obter Dados do Canal
Por obter dados de um canal.
Canal
ID do Canal, Link do Canal
Ação
O que faz
Entradas obrigatórias
Saídas
Obter Próprios Produtos
Poderá obter os produtos do seu próprio catálogo do WhatsApp Business.
—
Produtos
Obter Produtos de Terceiros
Poderá obter produtos de um catálogo do WhatsApp Business de qualquer número, seja o seu próprio catálogo ou o catálogo de outra pessoa.
Telefone para verificar produtos
Produtos
Enviar Produto (select)
Envia um produto do seu catalogo para um telefone
Telefone do Destinatário, Produto
zaapId, messageId, id
Enviar Produto (ID)
Envia um produto do seu catalogo para um telefone
Telefone do Destinatário, ID do Produto
zaapId, messageId, id
Remove Etiqueta do WhatsApp
É possível remover uma etiqueta a um chat no WhatsApp Business.
Telefone, Etiqueta
—
Adicionar Etiqueta do WhatsApp
É possível atribuir uma etiqueta a um chat no WhatsApp Business.
Telefone, Etiqueta
—
Ação
O que faz
Entradas obrigatórias
Saídas
Conectar via Código
Retorna um código que permite conectar o número de telefone à API sem a necessidade de escanear um código QR, simplesmente inserindo o código gerado
Telefone a Conectar
Código de Conexão
Conectar via Código em outra Instância
Mesmo método de conexão via código, porem para uma instância diferente da configurada no mini-app
Telefone a Conectar, ID da Instância do Z-API, Token da Instância do Z-API
Código de Conexão
Obter Dados Instancia
Por retornar informações sobre o device/celular conectado.
—
Telefone, Nome, Foto de Perfil, É WhatsApp Business?
Status
Por fornecer informações sobre a conexão de sua instância no Z-API
—
Está conectado? (Booleano)
Ação
O que faz
Entradas obrigatórias
Saídas
Ligação Falsa
Faz uma chamada para um número que tem o WhatsApp, seja ele seu contato ou não
WhatsApp do Destinatário da Ligação:
—
Ação
O que faz
Entradas obrigatórias
Saídas
Obter Foto de Perfil
Por retornar uma URL com a imagem de seus contatos atualizada.
Telefone
URL da Foto de Perfil
Marcar como Lida/Não Lida
Marcar uma conversa como Lida ou Não Lida
Telefone, Marcar como:
—
Obter Tags de um Contato
Obtem as tags de um determinado contato
Telefone do contato
IDs das Tags (JSON), Nomes das Tags (JSON), Nomes das Tags (Texto separado por virgulas)
Telefone está no WhatsApp?
Retorna se o número possui ou não o WhatsApp
Telefone
Tem WhatsApp? (booleano), Telefone
Ação
O que faz
Entradas obrigatórias
Saídas
Obter Dados do Anúncio Recebido
Obtém os dados do última mensagem de anúncio recebido no número. Exclusivo para o Z-API
—
Título do Anúncio, Corpo do Anúncio, ID de Origem (sourceId), ID do Clique (ctwaClid), URL de Origem, URL da Thumbnail, containsAutoReply, renderLargerThumbnail, showAdAttribution, Tipo de Midia
- O Z-API não é a API Oficial do WhatsApp. É uma sessão do WhatsApp Web automatizada, e o próprio fornecedor alerta que a Meta trata cada versão do WhatsApp de um jeito — envio em massa ou mensagem não solicitada por esse caminho traz risco real de bloqueio do número.
- O Z-API não armazena mensagens: elas ficam em fila e são descartadas depois da entrega. Se você precisa de histórico, guarde no NicoChat.
- Muitas ações de grupo aceitam ID ou link de convite no mesmo campo — útil quando você só tem o link que o cliente mandou.
- As ações de envio devolvem o
messageId, que é o que permite depois editar ou apagar para todos aquela mensagem. - A pasta Anúncios Facebook Ads lê os dados do anúncio que originou a conversa — título, corpo, ID do clique e URL de origem. É o caminho para atribuir campanha a um atendimento vindo de Click-to-WhatsApp.
- NicoApps (MiniApps) Nativos — a lista completa de integrações prontas