Catálogo de campos de formulário

Cada bloco de exibição e cada tipo de campo de um formulário do WhatsApp, com os limites, as propriedades aceitas e onde a resposta pode ser gravada.

Esta página é gerada a partir das mesmas regras que conferem o documento do formulário (POST /whatsapp/forms/check) e dos mesmos limites que GET /whatsapp/forms/options devolve, então traz exatamente o que a API aceita hoje. Para entender o documento como um todo (telas, rotas e condições), leia antes o guia Formulários.

Como ler cada tipo

ItemO que significa
Componente da MetaO componente do Flow JSON que o bloco gera.
RótuloO limite de label (campos) ou de text (blocos de exibição), em caracteres. Acima dele, o problema too_long.
PropriedadesAs propriedades opcionais que o tipo aceita e no que cada uma vira no Flow JSON. Uma propriedade que o tipo não aceita volta como problema not_allowed.
AjudaO que acontece com help.
CondiçõesSe a resposta do campo pode decidir visibleIf de blocos seguintes e route.branchOn da tela.
RespostaO campo de cada resposta (answers.values) que guarda o valor.
GravaçãoOnde a resposta pode ser gravada pelo binding do campo.

Limites de cada tela e do formulário

LimiteValor
Componentes por tela, contando o rodapé e cada pergunta (question)50
Imagens por tela3
Links por tela2
Campos de aceite por tela5
Campos de foto ou documento por tela1
Destinos diferentes de uma tela (route.next e route.branches)10
Texto do botão da tela (submitLabel)35 caracteres
Título de opção30 caracteres
Descrição de opção300 caracteres
Ajuda (help)80 caracteres
Pergunta (question)4.096 caracteres
Chaves de tela, bloco, campo e opçãoletra minúscula seguida de letras minúsculas, números ou _, até 40 caracteres
Arquivos por campo de foto ou documento (max)30
Imagem de um bloco de imagem307.200 bytes

Tipos de arquivo que mimeTypes aceita num campo de documento: application/gzip, application/zip, application/x-7z-compressed, application/pdf, application/msword, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.oasis.opendocument.text, application/vnd.oasis.opendocument.spreadsheet, application/vnd.oasis.opendocument.presentation, image/avif, image/gif, image/heic, image/heif, image/jpeg, image/png, image/tiff, image/webp, text/plain, video/mp4 e video/mpeg.

Blocos de exibição

Um bloco de exibição leva display com kind e não guarda resposta.

Tipo (kind)NomeComponente da MetaTexto (text)Regras
headingTítuloTextHeadingObrigatório, até 80 caracteresNenhuma.
subheadingSubtítuloTextSubheadingObrigatório, até 80 caracteresNenhuma.
paragraphParágrafoTextBodyObrigatório, até 4.096 caracteresNenhuma.
captionLegendaTextCaptionObrigatório, até 4.096 caracteresNenhuma.
imageImagemImageOpcional, vira alt-textmediaId obrigatório: o id de uma imagem da biblioteca de mídia do workspace, até 307.200 bytes.
linkLinkEmbeddedLinkObrigatório, até 25 caracteresurl obrigatório, com https. O toque abre o endereço.

Campos

Um campo leva field com key, kind e label, e guarda a resposta da pessoa em key. required torna a resposta obrigatória; sensitive esconde a resposta de quem não tem a permissão de ver respostas sensíveis.

Tipo (kind)NomeRótuloOpções
short_textTexto curto20Não aceita
emailE-mail20Não aceita
phoneTelefone20Não aceita
numberNúmero20Não aceita
long_textTexto longo20Não aceita
single_choice_radioEscolha única (botões)30De 1 a 20
single_choice_dropdownEscolha única (lista)20De 1 a 200
multi_choice_checkboxMúltipla escolha (caixas)30De 1 a 20
multi_choice_chipsMúltipla escolha (etiquetas)80De 2 a 20
dateData40Não aceita
date_rangePeríodo40Não aceita
opt_inAceite120Não aceita
photoFoto80Não aceita
documentDocumento80Não aceita

Texto curto

  • Tipo: short_text
  • Componente da Meta: TextInput (input-type text)
  • Rótulo: até 20 caracteres
  • Propriedades: pattern vira pattern; min vira min-chars; max vira max-chars
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: text
  • Gravação: Pode ser gravado no lead: name, address.zip, address.city ou address.state; em campo personalizado do tipo text.

E-mail

  • Tipo: email
  • Componente da Meta: TextInput (input-type email)
  • Rótulo: até 20 caracteres
  • Propriedades: min vira min-chars; max vira max-chars
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: text
  • Gravação: Pode ser gravado no lead: email; em campo personalizado do tipo text.

Telefone

  • Tipo: phone
  • Componente da Meta: TextInput (input-type phone)
  • Rótulo: até 20 caracteres
  • Propriedades: min vira min-chars; max vira max-chars
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: text
  • Gravação: Pode ser gravado em campo personalizado do tipo text.

Número

  • Tipo: number
  • Componente da Meta: TextInput (input-type number)
  • Rótulo: até 20 caracteres
  • Propriedades: pattern vira pattern; min vira min-chars; max vira max-chars
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: text
  • Gravação: Pode ser gravado em campo personalizado do tipo text ou number.

Texto longo

  • Tipo: long_text
  • Componente da Meta: TextArea
  • Rótulo: até 20 caracteres
  • Propriedades: max vira max-length
  • Aceitas sem efeito: min (passam na conferência, mas não mudam o formulário)
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: text
  • Gravação: Pode ser gravado em campo personalizado do tipo text.

Escolha única (botões)

  • Tipo: single_choice_radio
  • Componente da Meta: RadioButtonsGroup
  • Rótulo: até 30 caracteres
  • Opções: de 1 a 20 em options, cada uma com id e title (e description opcional)
  • Propriedades: nenhuma
  • Ajuda: vira description, até 80 caracteres
  • Condições: decide visibleIf de blocos seguintes, com o id de uma opção em value; decide route.branchOn da própria tela, quando é obrigatório
  • Resposta: optionIds, com um id
  • Gravação: Pode ser gravado no lead: address.city ou address.state; em campo personalizado do tipo text ou select.

Escolha única (lista)

  • Tipo: single_choice_dropdown
  • Componente da Meta: Dropdown
  • Rótulo: até 20 caracteres
  • Opções: de 1 a 200 em options, cada uma com id e title (e description opcional)
  • Propriedades: nenhuma
  • Ajuda: não aparece no formulário
  • Condições: decide visibleIf de blocos seguintes, com o id de uma opção em value; decide route.branchOn da própria tela, quando é obrigatório
  • Resposta: optionIds, com um id
  • Gravação: Pode ser gravado no lead: address.city ou address.state; em campo personalizado do tipo text ou select.

Múltipla escolha (caixas)

  • Tipo: multi_choice_checkbox
  • Componente da Meta: CheckboxGroup
  • Rótulo: até 30 caracteres
  • Opções: de 1 a 20 em options, cada uma com id e title (e description opcional)
  • Propriedades: min vira min-selected-items; max vira max-selected-items
  • Ajuda: vira description, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: optionIds, com os ids marcados
  • Gravação: Pode ser gravado em campo personalizado do tipo text ou multiselect.

Múltipla escolha (etiquetas)

  • Tipo: multi_choice_chips
  • Componente da Meta: ChipsSelector
  • Rótulo: até 80 caracteres
  • Opções: de 2 a 20 em options, cada uma com id e title (e description opcional)
  • Propriedades: min vira min-selected-items; max vira max-selected-items
  • Ajuda: vira description, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: optionIds, com os ids marcados
  • Gravação: Pode ser gravado em campo personalizado do tipo text ou multiselect.

Data

  • Tipo: date
  • Componente da Meta: DatePicker
  • Rótulo: até 40 caracteres
  • Propriedades: minDate vira min-date; maxDate vira max-date
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: text
  • Gravação: Pode ser gravado no lead: birth_date; em campo personalizado do tipo text ou date.

Período

  • Tipo: date_range
  • Componente da Meta: CalendarPicker (mode range)
  • Rótulo: até 40 caracteres
  • Propriedades: minDate vira min-date; maxDate vira max-date
  • Ajuda: vira helper-text, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: range (start e end)
  • Gravação: Pode ser gravado em campo personalizado do tipo text.

Aceite

  • Tipo: opt_in
  • Componente da Meta: OptIn
  • Rótulo: até 120 caracteres
  • Propriedades: termsUrl vira on-click-action
  • Ajuda: não aparece no formulário
  • Condições: decide visibleIf de blocos seguintes, com true ou false em value
  • Resposta: checked
  • Gravação: Pode ser gravado no lead: consent_whatsapp; em campo personalizado do tipo boolean.

Foto

  • Tipo: photo
  • Componente da Meta: PhotoPicker
  • Rótulo: até 80 caracteres
  • Propriedades: min vira min-uploaded-photos; max vira max-uploaded-photos
  • Ajuda: vira description, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: files (id, name, mimeType, sha256)
  • Sensível: sempre, mesmo sem sensitive
  • Gravação: Não pode ser gravado no lead.

Documento

  • Tipo: document
  • Componente da Meta: DocumentPicker
  • Rótulo: até 80 caracteres
  • Propriedades: min vira min-uploaded-documents; max vira max-uploaded-documents; mimeTypes vira allowed-mime-types
  • Ajuda: vira description, até 80 caracteres
  • Condições: não decide condições nem rotas
  • Resposta: files (id, name, mimeType, sha256)
  • Sensível: sempre, mesmo sem sensitive
  • Gravação: Não pode ser gravado no lead.