Criar e gerenciar flows
As API's de flows permitem executar uma variedade de operações.
Ciclo de vida
 |
|---|
| Ciclo de Vida - Flows |
Criar flow
Os novos flows são criados no status DRAFT. Você poderá fazer alterações no fluxo carregando um arquivo JSON atualizado. Pode-se, também, clonar um flow já existente.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows
Método: POST
Parâmetros
| Parâmetro | Descrição | Opcional |
|---|---|---|
| name string |
Nome do flow | |
| categories array |
Uma lista de categorias de fluxo. Vários valores são possíveis, mas pelo menos um é obrigatório. Escolha os valores que representam seu caso de uso de negócios. Os valores podem ser: SIGN_UP SIGN_IN APPOINTMENT_BOOKING LEAD_GENERATION CONTACT_US CUSTOMER_SUPPORT SURVEY OTHER |
|
| clone_flow_id string |
ID do fluxo de origem a ser clonado. Você deve ter permissão para acessar o fluxo especificado. | ✓ |
| endpoint_uri string |
A URL do ponto final do fluxo WA. A partir do Flow JSON versão 3.0, essa propriedade deve ser especificada somente por meio da API. Não forneça esse campo se você estiver clonando um Flow com uma versão JSON do Flow inferior a 3.0. | ✓ |
Recuperar lista de flows
Recupera os fluxos pertencentes a uma Waba.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows
Método: GET
Recuperar detalhes do flow
Esta solicitação retornará os detalhes de um único flow. Por padrão ele retornará os campos id, name, status, categories, endpoint_uri, preview e validation_errors.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}
Método: GET
Parâmetros
| Parâmetro | Descrição |
|---|---|
| id string |
O ID exclusivo do fluxo. |
| name string |
O nome definido pelo usuário do flow que não é visível para os usuários. |
| status string |
DRAFT: Este é o status inicial. O flow ainda está em desenvolvimento. O Flow só pode ser enviado "mode": "draft" para teste. PUBLISHED: O Flow foi marcado como publicado pelo desenvolvedor e agora pode ser enviado aos clientes. Este fluxo não pode ser excluído ou atualizado posteriormente. DEPRECATED: o desenvolvedor marcou o Flow como obsoleto (já que ele não pode ser excluído após a publicação). Isso evita o envio e a abertura do Flow, para permitir que o desenvolvedor retire seu endpoint. Fluxos obsoletos não podem ser excluídos ou descontinuados. BLOCKED: o monitoramento detectou que o endpoint não está íntegro e definiu o status como Bloqueado. O Flow não pode ser enviado ou aberto neste estado; o desenvolvedor precisa corrigir o endpoint para que ele retorne ao estado Publicado. THROTTLED: o monitoramento detectou que o endpoint não está íntegro. Fluxos com status limitado podem ser abertos, porém apenas 10 mensagens do Fluxo podem ser enviadas por hora. O desenvolvedor precisa corrigir o endpoint para que ele volte ao estado PUBLISHED. |
| categories array |
Uma lista de categorias de fluxo. |
| endpoint_uri string |
A URL do WA Flow Endpoint especificada pelo desenvolvedor via API ou na UI do Builder. |
| preview object |
A URL da página de visualização da Web para visualizar o fluxo e seu prazo de validade. |
| validation_errors array |
Uma lista de erros no Flow. Todos os erros devem ser corrigidos antes que o fluxo possa ser publicado. |
Atualizar detalhes do flow
Depois de criar seu fluxo, você poderá atualizar o nome ou as categorias usando a solicitação de atualização.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}
Método: PUT
Parâmetros
| Parâmetro | Descrição | Opcional |
|---|---|---|
| name string |
Nome do fluxo | ✓ |
| categories array |
Uma lista de categorias de fluxo. O valor ausente manterá as categorias existentes. Se fornecido, pelo menos um valor será obrigatório. | ✓ |
| endpoint_uri string |
A URL do ponto final do fluxo WA. A partir do Flow JSON versão 3.0, essa propriedade deve ser especificada por meio da API ou da IU do Builder. Não forneça esse campo se você estiver atualizando um Flow com a versão JSON do Flow inferior a 3.0. | ✓ |
| application_id string |
O ID do aplicativo Meta que será conectado ao Flow. Todos os fluxos com endpoints precisam ter um Aplicativo conectado a eles. | ✓ |
Deletar flow
Enquanto um fluxo estiver no status DRAFT, ele poderá ser excluído.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}
Método: DELETE
Recuperar o JSON de um flow
Recupera o Flow JSON para um flow específico.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}/json-asset
Método: GET
Atualizar o JSON de um flow
Para atualizar o Flow JSON para um flow específico, use a seguinte solicitação.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}/json-asset
Método: PUT
Parâmetros
| Parâmetro | Descrição | Opcional |
|---|---|---|
| name string |
Nome do ativo de fluxo. O valor deve ser flow.json. | |
| asset_type string |
Tipo de ativo. O valor deve ser FLOW_JSON. | |
| file json |
Arquivo com o conteúdo JSON. O tamanho é limitado a 10 MB |
Publicar flow
Esta solicitação atualiza o status do Flow para "PUBLISHED" e é uma ação irreversível, ou seja, o flow e seus ativos tornam-se imutáveis uma vez publicados. Para atualizar o Flow depois disso, você deve criar um novo flow, especificando o ID do fluxo existente no parâmetro clone_flow_id ao criar para copiar o fluxo existente.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}/publish
Método: POST
Você poderá publicar seu fluxo depois de garantir que:
- Todos os erros de validação e verificações de publicação foram resolvidos.
- O flow atende aos princípios de design do WhatsApp Flows
- O flow está em conformidade com os Termos de Serviço do WhatsApp, a Política de Mensagens do WhatsApp Business e, se aplicável, a Política Comercial do WhatsApp.
Descontinuar flow
Depois que um fluxo é publicado, ele não pode ser modificado ou excluído, mas pode ser marcado como obsoleto.
URI
URI: https://api.whatsapp.serpro.gov.br/waba/{wabaId}/flows/{flowId}/deprecate
Método: POST