Compatibilidade com a Blip: comandos e envelopes

Rotas

As três rotas da raiz ficam no mesmo endereço da API pública (https://http.pipebr.app). Só valem chaves de fluxo ou de roteador, com Bearer ou Key.

Passo a passo: primeiro comando

1. Monte o cabeçalho Key com o identificador do fluxo e a chave:

KEY=$(printf %s "meu-fluxo:$PIPE_CHAVE" | base64 -w0)

1. Envie um comando de consulta:

curl -s -X POST https://http.pipebr.app/commands \
  -H "Authorization: Key $KEY" \
  -H "Content-Type: application/json" \
  -d '{"id": "1", "to": "postmaster@desk.msging.net", "method": "get", "uri": "/teams"}'

1. A resposta traz o envelope completo, com status: "success" e o resource:

{
  "id": "1",
  "from": "postmaster@desk.msging.net",
  "to": "meu-fluxo@msging.net",
  "method": "get",
  "status": "success",
  "type": "application/vnd.lime.collection+json",
  "resource": { "total": 1, "items": [ { "...": "dados da equipe" } ] },
  "metadata": { "#command.uri": "lime://meu-fluxo@msging.net/teams" }
}

O conteúdo de resource segue o formato dos recursos da Blip. Quando falha, a resposta traz status: "failure" e reason com code e description, e o detalhe em português fica em metadata["#pipe.error"].

Códigos de falha

Diferenças entre /commands e /v1/commands

Mensagens e notificações

POST /messages envia texto para o ticket ativo do contato, como mensagem do sistema, ou um modelo aprovado:

curl -s -X POST https://http.pipebr.app/messages \
  -H "Authorization: Key $KEY" \
  -H "Content-Type: application/json" \
  -d '{"id": "msg-1", "to": "5511955550101%40wa.gw.msging.net@desk.msging.net", "type": "text/plain", "content": "Seu pedido saiu para entrega."}'

Modelos no formato application/json com type: "template" seguem a mesma regra de mensagens ativas. Mídia por link (media-link) é recusada com 64: use POST /v1/attachments. O id do envelope repetido com o mesmo conteúdo em 24 horas devolve a resposta guardada, sem enviar de novo.

POST /notifications aceita os eventos accepted, dispatched, received, consumed e failed. Ele não altera estado de mensagem no Pipe: o evento de uma mensagem do seu fluxo é aceito (202) e fica só nos registros.

Comandos suportados

Todos exigem comandos:executar, mais o escopo da coluna.

Escritas em cadastros (/tags, /replies, /attendance-queues, /attendants, /rules, /priority-rules) são recusadas com failure 62 e nada é gravado.

O que não existe como comando

Campanhas da Blip (activecampaign), listas de transmissão (broadcast), event-track, /buckets, /resources, túneis, rastreador de cliques, chaves da conta e os relatórios attendancetime e tags respondem failure 62 ou 1. No Pipe, campanhas têm rota própria: veja Mensagens ativas e campanhas.