Consultar etiquetas, respostas, regras e modelos

Rotas

Etiquetas

curl -s "https://http.pipebr.app/v1/labels?scope=conversa" \
  -H "Authorization: Bearer $PIPE_CHAVE"

{
  "data": [
    {
      "id": "b3a1c9de-0000-4000-8000-000000000500",
      "name": "Reclamação",
      "color": "#E5484D",
      "scope": "conversa",
      "requiredInClosure": false,
      "flowId": null
    }
  ]
}

requiredInClosure: true significa que o ticket só encerra com essa etiqueta aplicada. flowId: null indica etiqueta da organização. Para aplicar, veja Conversas e tickets e Contatos. Pela tela, veja Usar etiquetas.

Respostas rápidas

GET /v1/quick-replies traz as respostas do fluxo da chave mais as da organização. Se uma resposta do fluxo tem o mesmo atalho de uma da organização, a do fluxo vale. Cada item traz id, shortcut, title, body, category, active e flowId. Para usar uma no envio, passe o id em resposta_pronta_id em Enviar mensagens. Para cadastrar, veja Criar resposta pronta.

Modelos de mensagem

curl -s "https://http.pipebr.app/v1/channels/b3a1c9de-0000-4000-8000-000000000700/templates" \
  -H "Authorization: Bearer $PIPE_CHAVE"

{
  "channelId": "b3a1c9de-0000-4000-8000-000000000700",
  "data": [
    {
      "id": "b3a1c9de-0000-4000-8000-000000000400",
      "name": "lembrete_consulta",
      "language": "pt_BR",
      "category": "utilidade",
      "status": "aprovado",
      "body": "Olá {{1}}, sua consulta é amanhã.",
      "variables": ["nome"],
      "headerType": "nenhum",
      "buttons": [],
      "active": true,
      "updatedAt": "2026-10-10T12:00:00.000Z"
    }
  ]
}

Por padrão, só entram modelos aprovado e ativos. Use status=pendente, rejeitado, pausado ou all para ver os demais. Criar ou excluir modelos não é possível por chave, porque envolve revisão da Meta. Veja Modelos de mensagem.

Regras de atendimento

GET /v1/rules devolve, por fluxo, cada regra com name, order, combiner, active, a fila de destino em queue e as conditions (field, operator, value). GET /v1/rules/priority devolve name, level, scope, condition e active. Ambas aceitam flowId para estreitar. Para entender as regras, veja Regras de atendimento.