Catálogo de ações de botão

Cada tipo de ação que um botão de resposta rápida pode ter, com os parâmetros e as permissões que cada um exige.

Esta página é gerada a partir da mesma lista de tipos que GET /whatsapp/button-action-kinds filtra pelas permissões de quem pede, então traz exatamente os tipos que a API aceita hoje. Para entender onde as ações ficam guardadas e quando rodam, leia antes o guia Modelos e botões.

Como ler cada tipo

ItemO que significa
TipoO valor de kind na ação.
ParâmetrosOs campos de params que o tipo usa. Um campo que o tipo não usa, preenchido, recusa a ação com 400 button_action_params_invalid.
PermissãoO que a pessoa precisa ter, além de gerenciar modelos, para criar, mudar ou remover uma ação desse tipo. Sem ela, 403 button_action_forbidden.
SaídaUma ação de saída conta como saída do lead no modelo. Só o modelo define a saída: uma campanha não pode usar esse tipo nos desvios nem mudar um botão que tem saída (422 button_action_exit_locked).

Índice

TipoNomeParâmetrosSaída
opt_outSair das mensagensNenhum. params vai vazio.Sim
consent_grantAceitar mensagensOpcional: purpose.Sim
hand_offPassar para a equipeExatamente um entre departmentId e userId.Não
delegateDelegar a uma automaçãoExatamente um entre agentId e workflowId.Não
start_workflowIniciar um fluxoObrigatório: workflowId.Não
call_listAdicionar a uma lista de ligaçãoObrigatório: callListId.Não
classifyClassificar o leadObrigatórios: fieldKey e option.Não
create_dealCriar negociaçãoObrigatórios: pipelineId e stageId.Não

Sair das mensagens

  • Tipo: opt_out
  • Parâmetros: Nenhum. params vai vazio.
  • Permissão: Nenhuma além de gerenciar modelos.
  • Saída: Sim. Só o modelo define; uma campanha não pode usar este tipo.

Registra que o lead retirou o consentimento de receber mensagens, com o toque no botão como evidência.

Aceitar mensagens

  • Tipo: consent_grant
  • Parâmetros: Opcional: purpose.
  • Permissão: Recurso leads.consent, que exige leads:read, leads:update e leads:consent.
  • Saída: Sim. Só o modelo define; uma campanha não pode usar este tipo.

Registra que o lead deu consentimento para receber mensagens, com o toque no botão como evidência. purpose descreve a finalidade do consentimento, com até 200 caracteres.

Passar para a equipe

  • Tipo: hand_off
  • Parâmetros: Exatamente um entre departmentId e userId.
  • Permissão: Recurso leads.assign, que exige leads:read, leads:assign e members:read.
  • Saída: Não. Uma campanha pode usar este tipo nos desvios dos botões.

Passa a conversa para uma pessoa: com userId, para esse membro; com departmentId, para quem a roleta do departamento escolher.

Delegar a uma automação

  • Tipo: delegate
  • Parâmetros: Exatamente um entre agentId e workflowId.
  • Permissão: Recurso inbox.delegate, que exige conversations:read, conversations:delegate, agents:read e workflows:read.
  • Saída: Não. Uma campanha pode usar este tipo nos desvios dos botões.

Passa a conversa para um agente de IA ativo (agentId) ou para um fluxo que atende conversas (workflowId), como na delegação do atendimento, até alguém assumir.

Iniciar um fluxo

  • Tipo: start_workflow
  • Parâmetros: Obrigatório: workflowId.
  • Permissão: Recurso workflows.edit, que exige workflows:read e workflows:update.
  • Saída: Não. Uma campanha pode usar este tipo nos desvios dos botões.

Inicia o fluxo na conversa, sem passar a conversa para ele. O fluxo precisa ter um gatilho de mensagem na versão publicada. O fluxo recebe o texto e o índice do botão tocado. Se o fluxo já estiver rodando na conversa, nada muda.

Adicionar a uma lista de ligação

  • Tipo: call_list
  • Parâmetros: Obrigatório: callListId.
  • Permissão: Recurso call_lists.manage, que exige call_lists:read, call_lists:manage e leads:read.
  • Saída: Não. Uma campanha pode usar este tipo nos desvios dos botões.

Adiciona o lead à lista de ligação.

Classificar o lead

  • Tipo: classify
  • Parâmetros: Obrigatórios: fieldKey e option.
  • Permissão: Permissão leads:update.
  • Saída: Não. Uma campanha pode usar este tipo nos desvios dos botões.

Grava option no campo personalizado de seleção fieldKey do lead. A opção precisa existir no campo.

Criar negociação

  • Tipo: create_deal
  • Parâmetros: Obrigatórios: pipelineId e stageId.
  • Permissão: Recurso deals.edit, que exige conversations:read e conversations:update.
  • Saída: Não. Uma campanha pode usar este tipo nos desvios dos botões.

Cria uma negociação para a conversa no funil pipelineId, na etapa stageId. A etapa precisa ser desse funil.