Documentação API WhatsApp

Endpoint

Criar Template

Headers:

Parâmetros:

Estrutura do template:

{
    "questions": [
        {
            "id": number,         // ID único da questão
            "text": string,       // Texto da pergunta
            "timeout": number,    // Tempo limite em segundos (opcional)
            "responses": [
                {
                    "matches": string[],   // Palavras/números que ativam esta resposta
                    "action": {
                        "type": string,    // "text", "api", "nextQuestion" ou "executeTemplate"
                        "message": string,  // Para type "text"
                        "url": string,     // Para type "api"
                        "method": string,  // Para type "api"
                        "nextId": number,  // Para type "nextQuestion"
                        "templateId": number // Para type "executeTemplate"
                    }
                }
            ]
        }
    ]
}

Estrutura detalhada do template:

{
    "name": string,         // Nome do fluxo do bot (ex: "Menu Completo")
    "instancia_id": number, // ID da instância do WhatsApp
    "template": {
        "questions": [      // Array de perguntas/etapas do fluxo
            {
                "id": number,       // Identificador único da pergunta
                "text": string,     // Texto que será enviado ao usuário
                "timeout": number,  // (Opcional) Tempo limite em segundos
                "responses": [      // Array de possíveis respostas
                    {
                        "matches": string[],   // Array de palavras/frases que ativam esta resposta
                                             // Use "*" para aceitar qualquer resposta
                        "action": {           // Ação a ser executada quando houver match
                            "type": string,   // Tipo da ação:
                                            // - "text": Envia uma mensagem
                                            // - "nextQuestion": Vai para próxima pergunta
                                            // - "api": Faz uma chamada API
                                            // - "executeTemplate": Executa outro template

                            // Campos específicos por tipo de ação:
                            "message": string,      // Para type "text": mensagem a ser enviada
                            "nextQuestionId": number, // Para type "nextQuestion": ID da próxima pergunta
                            "blockChat": boolean,   // (Opcional) Bloqueia novas interações
                            "blockTimeout": number, // (Opcional) Tempo do bloqueio em segundos
                            "blockMessage": string, // (Opcional) Mensagem durante bloqueio
                            "expireMessage": string, // (Opcional) Mensagem ao expirar bloqueio
                            "storeAs": string,      // (Opcional) Salva resposta com este nome
                            "url": string,         // Para type "api": URL da API
                            "method": string,      // Para type "api": Método HTTP
                            "headers": object,     // Para type "api": Headers da requisição
                            "body": object,        // Para type "api": Corpo da requisição
                            "nextMessage": string  // Para type "api": Mensagem após chamada
                        }
                    }
                ]
            }
        ]
    },
    "triggers": string[],   // Palavras-chave que iniciam o fluxo
    "active": boolean      // Status de ativação do template
}

Variáveis disponíveis:

Curl exemplo (Template Default):

curl -X POST "https://api.apifacil.com/v1/bot/template" \
    -H "Authorization: {seu-token}" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "Atendimento",
        "type": "default",
        "instancia_id": 1,
        "template": {
            "questions": [
                {
                    "id": 0,
                    "text": "Como posso ajudar?\n1 - Suporte\n2 - Vendas",
                    "timeout": 300,
                    "responses": [
                        {
                            "matches": ["1", "suporte"],
                            "action": {
                                "type": "text",
                                "message": "Você será atendido em breve"
                            }
                        }
                    ]
                }
            ]
        },
        "triggers": ["atendimento", "suporte", "ajuda"]
    }'

Curl exemplo (Template ia):

curl -X POST "https://api.apifacil.com/v1/bot/template" \
    -H "Authorization: {seu-token}" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "Atendimento IA",
        "type": "IA",
        "instancia_id": 1,
        "assistant_prompt": "Você é um assistente de atendimento que deve responder de forma cordial e profissional...",
        "triggers": ["atendimento", "suporte"]
    }'

Curl exemplo:

curl -X POST "https://api.apifacil.com/v1/bot/template" \
    -H "Authorization: {seu-token}" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "Atendimento",
        "instancia_id": 1,
        "template": {
            "questions": [
                {
                    "id": 0,
                    "text": "Como posso ajudar?\n1 - Suporte\n2 - Vendas",
                    "timeout": 300,
                    "responses": [
                        {
                            "matches": ["1", "suporte"],
                            "action": {
                                "type": "text",
                                "message": "Você será atendido em breve"
                            }
                        },
                        {
                            "matches": ["2", "vendas"],
                            "action": {
                                "type": "nextQuestion",
                                "nextId": 1
                            }
                        }
                    ]
                },
                {
                    "id": 1,
                    "text": "Qual produto você tem interesse?",
                    "responses": [
                        {
                            "matches": ["*"],
                            "action": {
                                "type": "api",
                                "url": "https://sua-api.com/vendas",
                                "method": "POST"
                            }
                        }
                    ]
                }
            ]
        },
        "triggers": ["atendimento", "suporte", "ajuda"]
    }'

Resposta:

{
    "error": false,
    "data": {
        "id": 1,
        "name": "Atendimento",
        "instancia_id": 1,
        "template": {...},
        "triggers": ["atendimento", "suporte", "ajuda"],
        "active": true,
        "created_at": "2024-01-01T00:00:00.000000Z",
        "updated_at": "2024-01-01T00:00:00.000000Z"
    }
}

Executar Template

Headers:

Parâmetros:

Curl exemplo:

curl -X POST "https://api.apifacil.com/v1/bot/template/1/execute" \
    -H "Authorization: {seu-token}" \
    -H "Content-Type: application/json" \
    -d '{
        "phone": "5511999999999",
        "instancia_id": 1
    }'