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
| Item | O que significa |
|---|---|
| Componente da Meta | O componente do Flow JSON que o bloco gera. |
| Rótulo | O limite de label (campos) ou de text (blocos de exibição), em caracteres. Acima dele, o problema too_long. |
| Propriedades | As 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. |
| Ajuda | O que acontece com help. |
| Condições | Se a resposta do campo pode decidir visibleIf de blocos seguintes e route.branchOn da tela. |
| Resposta | O campo de cada resposta (answers.values) que guarda o valor. |
| Gravação | Onde a resposta pode ser gravada pelo binding do campo. |
Limites de cada tela e do formulário
| Limite | Valor |
|---|---|
Componentes por tela, contando o rodapé e cada pergunta (question) | 50 |
| Imagens por tela | 3 |
| Links por tela | 2 |
| Campos de aceite por tela | 5 |
| Campos de foto ou documento por tela | 1 |
Destinos diferentes de uma tela (route.next e route.branches) | 10 |
Texto do botão da tela (submitLabel) | 35 caracteres |
| Título de opção | 30 caracteres |
| Descrição de opção | 300 caracteres |
Ajuda (help) | 80 caracteres |
Pergunta (question) | 4.096 caracteres |
| Chaves de tela, bloco, campo e opção | letra 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 imagem | 307.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) | Nome | Componente da Meta | Texto (text) | Regras |
|---|---|---|---|---|
heading | Título | TextHeading | Obrigatório, até 80 caracteres | Nenhuma. |
subheading | Subtítulo | TextSubheading | Obrigatório, até 80 caracteres | Nenhuma. |
paragraph | Parágrafo | TextBody | Obrigatório, até 4.096 caracteres | Nenhuma. |
caption | Legenda | TextCaption | Obrigatório, até 4.096 caracteres | Nenhuma. |
image | Imagem | Image | Opcional, vira alt-text | mediaId obrigatório: o id de uma imagem da biblioteca de mídia do workspace, até 307.200 bytes. |
link | Link | EmbeddedLink | Obrigatório, até 25 caracteres | url 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) | Nome | Rótulo | Opções |
|---|---|---|---|
short_text | Texto curto | 20 | Não aceita |
email | 20 | Não aceita | |
phone | Telefone | 20 | Não aceita |
number | Número | 20 | Não aceita |
long_text | Texto longo | 20 | Não aceita |
single_choice_radio | Escolha única (botões) | 30 | De 1 a 20 |
single_choice_dropdown | Escolha única (lista) | 20 | De 1 a 200 |
multi_choice_checkbox | Múltipla escolha (caixas) | 30 | De 1 a 20 |
multi_choice_chips | Múltipla escolha (etiquetas) | 80 | De 2 a 20 |
date | Data | 40 | Não aceita |
date_range | Período | 40 | Não aceita |
opt_in | Aceite | 120 | Não aceita |
photo | Foto | 80 | Não aceita |
document | Documento | 80 | Não aceita |
Texto curto
- Tipo:
short_text - Componente da Meta: TextInput (
input-typetext) - Rótulo: até 20 caracteres
- Propriedades:
patternvirapattern;minviramin-chars;maxviramax-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.cityouaddress.state; em campo personalizado do tipotext.
E-mail
- Tipo:
email - Componente da Meta: TextInput (
input-typeemail) - Rótulo: até 20 caracteres
- Propriedades:
minviramin-chars;maxviramax-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 tipotext.
Telefone
- Tipo:
phone - Componente da Meta: TextInput (
input-typephone) - Rótulo: até 20 caracteres
- Propriedades:
minviramin-chars;maxviramax-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-typenumber) - Rótulo: até 20 caracteres
- Propriedades:
patternvirapattern;minviramin-chars;maxviramax-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
textounumber.
Texto longo
- Tipo:
long_text - Componente da Meta: TextArea
- Rótulo: até 20 caracteres
- Propriedades:
maxviramax-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 comidetitle(edescriptionopcional) - Propriedades: nenhuma
- Ajuda: vira
description, até 80 caracteres - Condições: decide
visibleIfde blocos seguintes, com oidde uma opção emvalue; decideroute.branchOnda própria tela, quando é obrigatório - Resposta:
optionIds, com um id - Gravação: Pode ser gravado no lead:
address.cityouaddress.state; em campo personalizado do tipotextouselect.
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 comidetitle(edescriptionopcional) - Propriedades: nenhuma
- Ajuda: não aparece no formulário
- Condições: decide
visibleIfde blocos seguintes, com oidde uma opção emvalue; decideroute.branchOnda própria tela, quando é obrigatório - Resposta:
optionIds, com um id - Gravação: Pode ser gravado no lead:
address.cityouaddress.state; em campo personalizado do tipotextouselect.
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 comidetitle(edescriptionopcional) - Propriedades:
minviramin-selected-items;maxviramax-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
textoumultiselect.
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 comidetitle(edescriptionopcional) - Propriedades:
minviramin-selected-items;maxviramax-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
textoumultiselect.
Data
- Tipo:
date - Componente da Meta: DatePicker
- Rótulo: até 40 caracteres
- Propriedades:
minDateviramin-date;maxDateviramax-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 tipotextoudate.
Período
- Tipo:
date_range - Componente da Meta: CalendarPicker (
moderange) - Rótulo: até 40 caracteres
- Propriedades:
minDateviramin-date;maxDateviramax-date - Ajuda: vira
helper-text, até 80 caracteres - Condições: não decide condições nem rotas
- Resposta:
range(starteend) - 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:
termsUrlviraon-click-action - Ajuda: não aparece no formulário
- Condições: decide
visibleIfde blocos seguintes, comtrueoufalseemvalue - Resposta:
checked - Gravação: Pode ser gravado no lead:
consent_whatsapp; em campo personalizado do tipoboolean.
Foto
- Tipo:
photo - Componente da Meta: PhotoPicker
- Rótulo: até 80 caracteres
- Propriedades:
minviramin-uploaded-photos;maxviramax-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:
minviramin-uploaded-documents;maxviramax-uploaded-documents;mimeTypesviraallowed-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.