Chat Pró Oratrix: API Externa — Interativo Messenger

Chatbot Pró da Oratrix
, , ,
1

Chat Pró Oratrix: API Externa — Interativo Messenger

:parrot: SERVIÇO

Serviço: Chat Pró Oratrix

:hammer_and_wrench: VOCÊ VAI PRECISAR

  • URL base: https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}.
  • Token de autenticação {token}.
  • ticketId válido quando a operação for ligada a um atendimento.

:receipt: VISÃO GERAL

A família Interativo Messenger permite enviar respostas rápidas, botões, cards, mídia interativa, recibos, tags de mensagem e formulários de feedback. Também oferece operações para texto de saudação e Personas.

:compass: PASSO A PASSO GUIADO

  1. Use https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}.
  2. Envie Authorization: Bearer {token}.
  3. Escolha a rota adequada:
Método Endpoint Finalidade
POST /sendInteractive/messenger/quickReply Quick Reply
POST /sendInteractive/messenger/buttonTemplate Template com botões
POST /sendInteractive/messenger/genericTemplate Cards genéricos
POST /sendInteractive/messenger/mediaTemplate Mídia com botões
POST /sendInteractive/messenger/receiptTemplate Recibo
POST /sendInteractive/messenger/messageTag Message Tag
POST /sendInteractive/messenger/customerFeedback NPS/CSAT
POST /messenger/greeting Consultar, definir ou remover saudação
POST /messenger/personas Listar, criar ou excluir Personas

Campos principais documentados

  • Quick Reply: ticketId, message, quickReplies.
  • Button Template: ticketId, message, buttons.
  • Generic Template: ticketId, elements.
  • Media Template: ticketId, mediaType, mediaUrl, buttons.
  • Receipt Template: ticketId, receipt.
  • Message Tag: ticketId, message, tag.
  • Customer Feedback: ticketId, title, subtitle, business_privacy_url, expires_in_days, feedback_screens.
  • Greeting: action, greetings.
  • Personas: action, name, profilePictureUrl.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: Preserve exatamente os nomes dos endpoints e campos.
  • :warning: Estruturas como buttons, elements, quickReplies e feedback_screens são arrays e devem seguir o formato documentado.
  • :warning: Não compartilhe o {token}.
  • :warning: 400 indica parâmetros inválidos ou ausentes; 401, falha de autenticação/permissão.

:gear: DICAS E BOAS PRÁTICAS

  • Teste cada tipo interativo separadamente.
  • Valide URLs de imagem e privacidade antes do envio.
  • Confirme o ticketId e o tipo de conteúdo antes da chamada.

:bar_chart: RESULTADO ESPERADO

A integração poderá enviar conteúdos interativos do Messenger e administrar saudação e Personas pela API externa.

:receipt: RESUMO FINAL

Use as rotas /sendInteractive/messenger/* e /messenger/* com a URL base oficial e Authorization: Bearer {token}.

:label: KEYWORDS

API, Messenger, interativo, Persona, Quick Reply

:robot: Peça ajuda ao ChatGPT da Oratrix

A I.A. da Oratrix no ChatGPT poderá tirar dúvidas e te guiar passo a passo no suporte.