Obter configuração de conversa

GET

/v1/flows/{flowId}/phases/{phaseId}/conversation-config

Retorna a configuração de conversa (conversation-config) atualmente definida em uma fase — a estrutura de mensagens de WhatsApp usada para capturar, diretamente por mensagem, as respostas de quem participa de uma etapa de aprovação ou validação, sem que essa pessoa precise acessar o AgFlow.

Se a fase ainda não possui uma configuração de conversa, a chamada retorna erro 404. Esse é o comportamento esperado quando a fase simplesmente não foi configurada, e não deve ser interpretado como falha da API.

Esta consulta é o ponto de partida recomendado antes de qualquer atualização: como não existe um endpoint de atualização (PUT) dedicado para conversation-config, o identificador retornado no campo id é necessário para remover a configuração atual antes de criar uma nova com o payload atualizado.

Requisição

Parâmetros de Caminho

Respostas

🟢200Configuração de conversa encontrada

application/json

A fase possui uma configuração de conversa ativa.

Bodyapplication/json

🟠404Configuração de conversa inexistente

Response Example

200 - Exemplo 1

{
    "id": "string",
    "rules": [
        {
            "setup": {
                "phoneId": "string"
            },
            "conditions": [
                "string"
            ],
            "conversation": {
                "title": "string",
                "templates": [
                    "string"
                ]
            }
        }
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Conversa — Visão Geral

Próxima página

Criar configuração de conversa