Começar fluxo

POST /chatbot/flows/start

Começa o fluxo publicado por API (seu sistema, n8n) e responde 202 na hora com o run_id. O fluxo roda logo depois; acompanhe em GET /chatbot/flows/runs/{run_id}.

  • Com to: o número é conferido no WhatsApp antes da resposta, e a execução substitui a que o contato tiver.
  • Sem to: o fluxo roda sem contato; um bloco set_contact escolhe com quem conversar antes de mandar mensagem ou perguntar.
  • O chatbot da inbox precisa estar ligado.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FlowStartInput"
      },
      "example": {
        "flow_id": "rw1b2c3d4e5f6a7",
        "to": "5511999999999",
        "variables": {
          "pedido": "1234"
        }
      }
    }
  }
}

Respostas

{
  "202": {
    "description": "Execução começada",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/FlowStartResult"
        },
        "example": {
          "run_id": "rr1b2c3d4e5f6a7",
          "chat_id": "5511999999999@s.whatsapp.net",
          "status": "started"
        }
      }
    }
  },
  "400": {
    "description": "`invalid_request`: JSON malformado ou campo desconhecido; ou `variables` ou `payload` fora do limite. `number_invalid`: `to` não é telefone com DDI. `number_not_on_whatsapp`: o número não está no WhatsApp.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "number_not_on_whatsapp",
          "message": "O número não está no WhatsApp."
        }
      }
    }
  },
  "401": {
    "description": "Token ausente ou inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "404": {
    "description": "Nenhum fluxo com esse `flow_id` nesta inbox.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "not_found",
          "message": "Nenhum recurso com esse `id` nesta inbox."
        }
      }
    }
  },
  "409": {
    "description": "`flow_not_published`: publique o fluxo antes. `chatbot_disabled`: ligue o chatbot da inbox (desligado, o fluxo não fala e a resposta do contato não volta para ele). `inbox_not_connected`: com `to`, a inbox precisa estar conectada para conferir o número. `inbox_not_paired`: conecte a inbox ao WhatsApp antes.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "flow_not_published",
          "message": "Publique o fluxo antes de começar."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "description": "Falha inesperada ao gravar ou ler os dados.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "internal_error",
          "message": "Erro interno; tente de novo."
        }
      }
    }
  },
  "502": {
    "description": "`whatsapp_lookup_failed`: não deu para conferir o número no WhatsApp agora; tente de novo.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "whatsapp_lookup_failed",
          "message": "não deu para conferir o número no WhatsApp agora; tente de novo."
        }
      }
    }
  }
}

Estado: Disponível

Compatibilidade de canais

CanalCompatívelObservação
WhatsApp (Web)Sim
WhatsApp (API oficial)Sim
InstagramSim
MessengerSim
TelegramSim

Eventos que esta rota gera

O que chega no seu webhook (ou em GET /events) depois desta rota.

message.sent: cada mensagem que o fluxo envia (sent_by: automation, automation.flow_id)

{
  "id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H",
  "type": "message.sent",
  "created_at": "2026-10-17T12:00:00.000Z",
  "inbox": {
    "id": "r0269625d29bfbd",
    "name": "loja",
    "phone": "5511888888888",
    "channel": "whatsapp_web"
  },
  "data": {
    "message": {
      "id": "3EB05DCE1D4036FCE241C6",
      "chat_id": "5511999999999@s.whatsapp.net",
      "author": {
        "id": "5511888888888@s.whatsapp.net",
        "name": "Loja"
      },
      "direction": "out",
      "sent_by": "automation",
      "sent_at": "2026-10-17T12:00:00.000Z",
      "category": "conversation",
      "type": "text",
      "text": "Oi, Maria! Como posso ajudar?",
      "automation": {
        "flow_id": "rw1b2c3d4e5f6a7"
      }
    },
    "chat": {
      "id": "5511999999999@s.whatsapp.net",
      "lid": "123456789012345@lid",
      "type": "direct"
    }
  }
}

Antes e depois (uazapi → Orkesio)

Na uazapi: POST /chatbot/flows/{id}/start.

  • Mesmas funções; o id vai no corpo, em flow_id (antes {id} no caminho); muda o formato: campos em snake_case, datas em ISO 8601 (_at) e erros em {error, message}.
  • Campos renomeados: chatid → chat_id, number → to.

#/components/schemas/FlowStartInput

{
  "type": "object",
  "additionalProperties": false,
  "description": "Começa o fluxo publicado. Com `to`, a execução é da conversa com esse contato e substitui a que ele tiver. Sem `to`, roda sem contato: chamada de API, condição e variáveis funcionam, e um bloco `set_contact` escolhe com quem conversar; mensagem ou pergunta antes dele é erro no log.",
  "properties": {
    "flow_id": {
      "type": "string",
      "description": "ID do fluxo (`id` em `GET /chatbot/flows`)."
    },
    "to": {
      "type": "string",
      "description": "Contato: telefone com DDI (grupo e canal não valem). Conferido no WhatsApp antes de começar.",
      "example": "5511999999999"
    },
    "variables": {
      "type": "object",
      "maxProperties": 50,
      "additionalProperties": {
        "type": "string",
        "maxLength": 4096
      },
      "description": "Variáveis com que o fluxo começa (`{{pedido}}`…): até 50; nome com letras, números e `_` (até 40); valor até 4 KB."
    },
    "payload": {
      "description": "Qualquer JSON (o corpo que o outro sistema mandou), até 64 KB. Fica em `{{webhook}}`; leia um campo com o ajuste `json` do `set`."
    }
  },
  "required": [
    "flow_id"
  ]
}

#/components/schemas/FlowStartResult

{
  "type": "object",
  "required": [
    "run_id",
    "status"
  ],
  "properties": {
    "run_id": {
      "type": "string",
      "description": "Id da execução; o andamento fica em `GET /chatbot/flows/runs/{run_id}`."
    },
    "chat_id": {
      "type": "string",
      "description": "Conversa da execução; vazio quando começou sem `to`. Só no `POST /chatbot/flows/start`: o webhook público não devolve."
    },
    "status": {
      "type": "string",
      "enum": [
        "started"
      ],
      "description": "Sempre `started`: a execução foi aceita e roda em seguida."
    }
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi