Chat Pró Oratrix: API Externa — Mensagens

Chat Pró Oratrix: API Externa — Mensagens

: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}.
  • Número do destinatário e conteúdo da mensagem conforme a rota utilizada.

:receipt: VISÃO GERAL

A família Mensagens permite consultar uma mensagem por messageId e enviar texto, arquivo, mídia por URL, conteúdo em Base64 ou áudio pela API externa.

:compass: PASSO A PASSO GUIADO

Use https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID} com Authorization: Bearer {token}.

Método Endpoint Finalidade
GET /getMessageByMessageId Consultar mensagem por messageId
POST /v2/api/external/{ApiID} Enviar texto ou arquivo
POST /url Enviar arquivo por URL
POST /base64 Enviar arquivo em Base64
POST /voice Enviar áudio por URL
GET /params/ Enviar por parâmetros de query conforme coleção documentada

Campos principais

No envio padrão, a documentação apresenta body, number, externalKey, isClosed e validateNumber; no formato multipart, o arquivo vai em media.

/url utiliza mediaUrl, body, number, externalKey, isClosed e validateNumber.

/base64 utiliza body, number, base64Data, mimeType, fileName, isClosed e validateNumber.

/voice utiliza audio, number, externalKey e isClosed.

/getMessageByMessageId recebe messageId em query, incluindo IDs retornados pela Meta como wamid.xxxxx.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: Preserve exatamente os nomes técnicos dos campos e endpoints.
  • :warning: externalKey deve ser único quando utilizado para controle do envio.
  • :warning: validateNumber=false usa o número exatamente como enviado, sem normalização do 9º dígito brasileiro.
  • :warning: A rota /params/ documenta bearertoken como parâmetro de query; preserve esse comportamento somente quando utilizar essa rota específica.
  • :warning: Não exponha {token} em logs públicos ou capturas de tela.

:gear: DICAS E BOAS PRÁTICAS

  • Use o endpoint adequado ao tipo de mídia.
  • Confirme mimeType e fileName em envios Base64.
  • Teste texto e mídia separadamente antes de automatizar.

:bar_chart: RESULTADO ESPERADO

A integração poderá consultar mensagens e enviar diferentes tipos de conteúdo pela API externa.

:receipt: RESUMO FINAL

Use a URL base oficial https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID} com Authorization: Bearer {token} e as rotas específicas para cada tipo de conteúdo.

:label: KEYWORDS

API, mensagens, mídia, Base64, WhatsApp

: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.