Conecta-seEntrar na plataforma

Catálogo e opções

Consultar a instância Z-API ou enviar catálogo, botões de resposta e lista de opções.

Integrações e ferramentasComunicaçãoConexão: Credencial protegida

O que faz

Z-API · Consulte a instância, envie catálogo, botões de resposta ou lista de opções.

Quando usar: Use quando o seu fluxo precisar consultar a instância Z-API ou enviar catálogo, botões de resposta e lista de opções.

Exemplo de situação: Enviar uma confirmação ao cliente ou à equipe no canal correto.

Antes de começar

Conexão necessária: Credencial protegida.

Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.

Passo a passo

  1. Adicione Catálogo e opções ao desenho a partir da aba Blocos e ligue a entrada dele à etapa anterior.
  2. Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
  3. Escolha a operação. O painel mostra só os campos que essa operação usa.
  4. Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
  5. Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
  6. Só publique depois de conferir o resultado da execução de teste.

Operações

OperaçãoO que faz
Status da instânciaExecuta a operação “Status da instância” com o bloco Catálogo e opções.
Enviar catálogoEnvia catálogo com o bloco Catálogo e opções.
Enviar botões de resposta rápidaEnvia botões de resposta rápida com o bloco Catálogo e opções.
Enviar lista de opçõesEnvia lista de opções com o bloco Catálogo e opções.

Campos

Mostrar campos de

  • Operação

    Escolhe qual ação este bloco executará.

    Opções:
    Status da instância · Enviar catálogo · Enviar botões de resposta rápida · Enviar lista de opções
    Padrão:
    Status da instância

  • Instância Z-API

    Obrigatório

    Escolha uma instância conectada.

    Exemplo:
    (escolha na lista do campo)

  • ID da instância

    ObrigatórioEm campos adicionais

    Painel Z-API → sua instância → Editar.

    Exemplo:
    id-do-recurso

  • Token da instância

    ObrigatórioEm campos adicionaisDado protegido

    Informa uma credencial secreta. Guarde-a no cofre de credenciais e nunca a exponha em texto livre.

    Padrão:
    Segredo protegido

  • Token de segurança da conta (Client-Token)

    Em campos adicionaisDado protegido

    Só se você ativou em Segurança no painel Z-API.

    Padrão:
    Segredo protegido

  • Telefone / ID do chat

    Identifica a conversa, o canal ou o telefone de destino.

    Quando aparece:
    Quando o campo “Operação” for diferente de “Status da instância” ou “update_webhook_received” ou “update_every_webhooks”
    Exemplo:
    +5511999999999

  • Mensagem

    Informa a mensagem que será enviada ou processada.

    Aparece em:
    Enviar catálogo, Enviar botões de resposta rápida, Enviar lista de opções
    Exemplo:
    Olá! Sua solicitação foi processada com sucesso.

  • Título

    Obrigatório conforme a operação

    Define o nome ou título usado para identificar o recurso.

    Aparece em:
    Enviar catálogo
    Exemplo:
    Exemplo de atendimento

  • Telefone da conta dona do catálogo

    Obrigatório conforme a operação

    Identifica a conversa, o canal ou o telefone de destino.

    Aparece em:
    Enviar catálogo
    Exemplo:
    +5511999999999

  • Descrição do catálogo

    Informa o conteúdo de texto que será enviado ou processado.

    Aparece em:
    Enviar catálogo

  • Idioma do cartão

    Escolhe uma das opções aceitas por este campo.

    Aparece em:
    Enviar catálogo
    Opções:
    Português · Inglês
    Padrão:
    Português

  • Botões de resposta rápida (JSON)

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Enviar botões de resposta rápida
    Exemplo:
    { "chave": "valor" }

  • Lista de opções (JSON)

    Informa dados estruturados ou código no formato exigido pelo campo.

    Aparece em:
    Enviar lista de opções
    Exemplo:
    { "chave": "valor" }

Saídas

Para usar um resultado deste bloco em uma etapa seguinte, digite < no campo e escolha o bloco e o campo. A referência tem o formato <catalogoeopcoes.response>: antes do ponto vai o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.

ReferênciaTipoO que contém
<catalogoeopcoes.response>jsonMensagem enviada, status da instância ou confirmação de webhook.

Exemplo de uso

Objetivo: Enviar uma confirmação ao cliente ou à equipe no canal correto.

InícioCatálogo e opçõespróxima etapa
Operação
Status da instância
Instância Z-API
(escolha na lista do campo)
Telefone / ID do chat
+5511999999999

Os valores são ilustrativos. Teste primeiro com dados fictícios ou de homologação.

Erros comuns e como resolver

O bloco não executa
Confira se existe um caminho de setas que parte do gatilho (ou do Início) até este bloco. Blocos soltos no desenho são ignorados.
Aparece “Validação do fluxo” no terminal
Há campo obrigatório vazio. Clique no aviso, abra o bloco indicado e preencha o campo marcado.
Um campo chega vazio na etapa seguinte
Confira se a referência aponta para um bloco que já executou e para um campo que existe, como <catalogoeopcoes.response>. O nome antes do ponto é o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
O campo que eu procuro não aparece
Os campos mudam conforme a operação escolhida. Escolha a operação primeiro; campos menos usados ficam em “Mostrar campos adicionais”.
Credencial ausente ou recusada
Escolha uma conexão válida do workspace. Se a senha ou a chave mudou no serviço, atualize a conexão cadastrada em vez de colar o segredo no bloco.
O serviço recusou a chamada ou devolveu erro
Leia a mensagem no terminal: ela traz o motivo informado pelo serviço. Confira IDs, limites de uso e permissões, e teste antes com um recurso de homologação.

Blocos relacionados