# Testar chamada de API do fluxo

POST /chatbot/flows/test-request

Faz uma vez a chamada de um bloco `request`, com valores de exemplo, e devolve a resposta como veio, para escolher o que guardar em `request.save` (que aqui não é aplicado). A chamada é real: um POST cria o que a API de destino criaria. Resposta fora de 2xx e falha de rede também voltam `200`: veja `status` e `error`.

## Autenticação

```json
[
  {
    "token": []
  }
]
```

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

## Corpo da requisição

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/FlowRequestTest"
      },
      "example": {
        "request": {
          "method": "GET",
          "url": "https://api.exemplo.com/clientes?telefone={{phone}}"
        },
        "variables": {
          "phone": "5511999999999"
        }
      }
    }
  }
}
```

## Respostas

```json
{
  "200": {
    "description": "Resultado da chamada",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/FlowRequestResult"
        },
        "example": {
          "status": 200,
          "duration_seconds": 0.182,
          "content_type": "application/json",
          "body": "{\"status\":\"enviado\"}"
        }
      }
    }
  },
  "400": {
    "description": "`invalid_request`: JSON malformado ou campo desconhecido; ou a chamada é inválida (método, URL que não é http/https, variável no host, corpo que não é JSON).",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "JSON malformado ou campo desconhecido."
        }
      }
    }
  },
  "401": {
    "description": "Token ausente ou inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "409": {
    "description": "`inbox_not_paired`: conecte a inbox ao WhatsApp antes.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "inbox_not_paired",
          "message": "Conecte a inbox ao WhatsApp antes."
        }
      }
    }
  },
  "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 |  |
| Instagram | 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: `POST /chatbot/flows/request-test`.

- Mesmo caminho e mesmas funções; muda o formato: campos em `snake_case`, datas em ISO 8601 (`_at`) e erros em `{error, message}`.
- Campos renomeados: `contentType` → `content_type`, `durationMs` → `duration_ms`.

## #/components/schemas/FlowRequestTest

```json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "request"
  ],
  "properties": {
    "request": {
      "$ref": "#/components/schemas/FlowRequest"
    },
    "variables": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Valor de exemplo de cada `{{variável}}` usada na chamada (inclusive `phone` e os do lead)."
    }
  }
}
```

## #/components/schemas/FlowRequest

```json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "method",
    "url"
  ],
  "description": "Chamada do bloco `request`. Em `url`, `headers` e `body`, `{{variável}}` é trocado pela variável do fluxo, por `{{phone}}` (número do contato) ou pelos placeholders do lead (`{{name}}`, `{{lead_*}}`…); desconhecido fica vazio. Na URL o valor é escapado; no corpo, entra como texto JSON. O host da URL é fixo (sem variável, para os cabeçalhos não irem para outro servidor), e variável com um trecho `.` ou `..` no caminho (como `../admin`) faz a chamada falhar. Tempo limite de 15 s; resposta de até 1 MB.",
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
      ]
    },
    "url": {
      "type": "string",
      "description": "http:// ou https://, com `{{variável}}` no caminho ou na query.",
      "example": "https://api.exemplo.com/clientes?telefone={{phone}}"
    },
    "headers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FlowRequestHeader"
      },
      "description": "Cabeçalhos da chamada (ex.: a chave da API de destino); `{{variável}}` vale no valor."
    },
    "body": {
      "type": "string",
      "description": "Corpo em JSON (ignorado no GET), enviado com `Content-Type: application/json`. `{{variável}}` vale como valor (`{\"id\": {{id}}}`) ou dentro de texto (`\"{{name}}\"`).",
      "example": "{\"nome\": \"{{name}}\", \"telefone\": \"{{phone}}\"}"
    },
    "save": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "$ref": "#/components/schemas/FlowRequestSave"
      },
      "description": "Campos da resposta guardados em variáveis quando ela vem com 2xx."
    }
  }
}
```

## #/components/schemas/FlowRequestHeader

```json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Authorization"
    },
    "value": {
      "type": "string",
      "example": "Bearer {{token_api}}"
    }
  }
}
```

## #/components/schemas/FlowRequestSave

```json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "path",
    "to"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Caminho no JSON da resposta, com ponto entre as chaves e o índice da lista como número (`cliente.nome`, `pedidos.0.id`). Vazio guarda a resposta inteira. Texto vai sem aspas; objeto e lista, em JSON; o que não existe, vazio.",
      "example": "cliente.nome"
    },
    "to": {
      "type": "string",
      "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,39}$",
      "description": "Variável do fluxo que recebe o valor (até 4 KB; o resto é cortado).",
      "example": "nome_cliente"
    }
  }
}
```

## #/components/schemas/FlowRequestResult

```json
{
  "type": "object",
  "required": [
    "status",
    "duration_seconds",
    "body"
  ],
  "description": "O que a API devolveu. `error` é falha antes da resposta (endereço recusado, tempo esgotado); aí `status` é 0.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "Status HTTP da resposta; 0 quando não houve resposta (veja `error`)."
    },
    "duration_seconds": {
      "type": "number",
      "description": "Tempo da chamada, em segundos (com decimais: `0.182`)."
    },
    "duration_ms": {
      "type": "integer",
      "deprecated": true,
      "description": "Obsoleto: a mesma duração em milissegundos. Use `duration_seconds`; sai numa versão próxima."
    },
    "content_type": {
      "type": "string",
      "description": "`Content-Type` da resposta."
    },
    "body": {
      "type": "string",
      "description": "Corpo como veio (até 1 MB)."
    },
    "error": {
      "type": "string",
      "description": "Por que a chamada falhou antes da resposta (endereço não público, tempo esgotado, rede). Ausente quando houve resposta."
    }
  }
}
```

## #/components/schemas/OrkesioError

```json
{
  "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

```json
{
  "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](/docs/overview) · [O que funciona em cada canal](/docs/canais) · [O que muda da uazapi](/docs/o-que-muda)