Visão geral

A Orkesio é uma API de mensagens com um contrato só para todos os canais: a mesma mensagem, os mesmos eventos e os mesmos erros, seja no WhatsApp (pelo Web ou pela API oficial), no Instagram, no Messenger ou no Telegram.

Ela roda sobre o mesmo motor da uazapi. Quem já usa a uazapi não precisa mudar nada: as rotas antigas continuam funcionando, com o mesmo token e a mesma inbox. Dá para migrar aos poucos, uma rota por vez.

O que muda em relação à uazapi

Uma mensagem, um formato. A mensagem que você envia, a que volta na busca e a que chega no evento têm o mesmo formato (OrkesioMessage): type diz o tipo e os campos do tipo vêm soltos na mensagem, com text como texto principal.
Rotas no plural, sem prefixo de versão. /messages é a Orkesio; /message/find e /send/* continuam sendo a uazapi. Cada página de rota mostra a equivalente na uazapi e o que mudou.
Eventos com nome recurso.ação (message.received, message.status) e um envelope comum (id, type, created_at, inbox, data), iguais no tempo real (GET /events) e no webhook.
Erros em {error, message}, com códigos estáveis (invalid_request, unsupported_for_channel, send_failed).
Campos em snake_case, datas ISO 8601 em UTC terminando em _at e listas paginadas por cursor.

O detalhe, campo a campo, está em O que muda da uazapi e no mapa das rotas.

Canais

Cada rota e cada evento dizem o que funciona em cada canal. A tabela completa está em O que funciona em cada canal. Quando um canal não tem um recurso, a API responde 501 com unsupported_for_channel, antes de tentar enviar.

Estado de cada rota

Selo	O que quer dizer
Disponível	Pronto para produção. O formato só cresce: campo novo pode aparecer, nenhum some nem muda de sentido.
Prévia	Já funciona, mas o formato ainda pode mudar. Hoje, só a conexão dos canais oficiais (API oficial, Instagram, Messenger e Telegram), os modelos da API oficial e as perguntas prontas.
Em breve	Desenhado, ainda não implementado.

Autenticação

Igual à uazapi: header token com o token da inbox (ou admintoken nas rotas de administração).