Listar fluxos
GET /chatbot/flows
Lista os fluxos da inbox em ordem de nome. Cada item é um resumo, sem o desenho: ele vem em GET /chatbot/flows/{flow_id}.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Parâmetros
[
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"default": 50
},
"description": "Itens por página (1 a 200; padrão 50)."
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "O `next_cursor` da página anterior. Sem ele, vem a primeira página."
}
]
Respostas
{
"200": {
"description": "Página da lista.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"flows"
],
"properties": {
"flows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowSummary"
}
},
"next_cursor": {
"type": "string",
"description": "Cursor da próxima página: mande em `cursor`. Ausente na última página."
}
}
},
"example": {
"flows": [
{
"id": "rw1b2c3d4e5f6a7",
"name": "Boas-vindas",
"version": 3,
"published_at": "2026-10-17T12:00:00.000Z",
"has_unpublished_changes": false,
"webhook_key": "",
"created_at": "2026-10-17T12:00:00.000Z",
"updated_at": "2026-10-17T12:00:00.000Z"
}
]
}
}
}
},
"400": {
"description": "`invalid_request`: `limit` fora do permitido ou `cursor` inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "invalid_request",
"message": "`limit` fora de 1 a 200."
}
}
}
},
"401": {
"description": "Token ausente ou inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"409": {
"description": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "inbox_not_paired",
"message": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`)."
}
}
}
},
"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."
}
}
}
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Sim | |
| Sim | ||
| Messenger | Sim | |
| Telegram | Sim |
Eventos que esta rota gera
Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.
Antes e depois (uazapi → Orkesio)
Na uazapi: GET /chatbot/flows.
- Mesmo caminho e mesmas funções; muda o formato: campos em
snake_case, datas em ISO 8601 (_at) e erros em{error, message}. - Lista com cursor:
limit+cursor→{ flows: [...], next_cursor }(antesoffseteitems+pagination). - Campos renomeados:
createdAt→created_at,hasUnpublishedChanges→has_unpublished_changes,publishedAt→published_at,updatedAt→updated_at,webhookKey→webhook_key.
#/components/schemas/FlowSummary
{
"type": "object",
"description": "Resumo do fluxo na lista, sem o documento (`groups`, `start_group_id`, `cancel_on_reply`, `send_window`): o documento vem no `GET /chatbot/flows/{flow_id}`.",
"required": [
"id",
"name",
"version",
"has_unpublished_changes",
"webhook_key",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "ID do fluxo, gerado pela api."
},
"name": {
"type": "string",
"description": "Nome do fluxo, para achar na lista; o contato não vê."
},
"version": {
"type": "integer",
"readOnly": true,
"description": "Última versão publicada; 0 se nunca foi publicado."
},
"published_at": {
"readOnly": true,
"description": "Última publicação. ISO 8601 em UTC com milissegundos. Ausente enquanto o fluxo nunca foi publicado (`version` 0).",
"type": "string",
"format": "date-time"
},
"has_unpublished_changes": {
"type": "boolean",
"readOnly": true,
"description": "O rascunho difere da versão publicada (ou o fluxo nunca foi publicado)."
},
"webhook_key": {
"type": "string",
"description": "Chave do webhook público (48 caracteres hexadecimais); a URL é `POST /chatbot/flows/hook/{webhook_key}`. Vazia quando desligado. Quem tem a chave começa o fluxo sem token: trate como senha.",
"pattern": "^([a-f0-9]{48})?quot;
},
"created_at": {
"description": "Criação. ISO 8601 em UTC com milissegundos.",
"readOnly": true,
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "Última alteração. ISO 8601 em UTC com milissegundos.",
"readOnly": true,
"type": "string",
"format": "date-time"
}
}
}
#/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