Chat Pró Oratrix: API Externa — Envio por Ticket

Chatbot Pró da Oratrix
, , ,
1

Chat Pró Oratrix: API Externa — Envio por Ticket

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

:receipt: VISÃO GERAL

O endpoint SendMessageByTicket envia mensagens diretamente para um ticket existente.

A coleção oficial documenta quatro formatos de payload: SendMessageByTicketText, SendMessageByTicketFile, SendMessageByTicketMediaUrl e SendMessageByTicketBase64.

:compass: PASSO A PASSO GUIADO

  1. Use POST https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/sendMessageByTicket.
  2. Envie Authorization: Bearer {token}.
  3. Escolha o formato de payload adequado.
  4. Para texto, envie ticketId e body.
  5. Quando necessário, use externalKey, reopen e isClosed.
  6. Para arquivo, utilize multipart/form-data com o campo media.

Campos documentados

  • ticketId — ID do ticket que receberá a mensagem.
  • body — texto da mensagem; obrigatório quando não há mídia.
  • externalKey — chave única para idempotência.
  • reopen — reabre ticket fechado antes do envio.
  • isClosed — fecha o ticket após o envio.

:warning: Sem reopen, o envio para ticket fechado pode retornar 409.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: Preserve o nome técnico /sendMessageByTicket.
  • :warning: Não compartilhe o {token}.
  • :warning: Use externalKey único quando precisar evitar duplicidade.
  • :warning: 400 indica parâmetros inválidos ou ausentes; 401, falha de autenticação/permissão.

:gear: DICAS E BOAS PRÁTICAS

  • Confirme o ticketId antes do envio.
  • Defina explicitamente se o ticket deve ser reaberto ou fechado.
  • Teste cada formato de mídia separadamente antes de automatizar.

:bar_chart: RESULTADO ESPERADO

A integração poderá enviar texto ou mídia diretamente em um ticket existente.

:receipt: RESUMO FINAL

Use https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/sendMessageByTicket com Authorization: Bearer {token} e o payload correspondente ao tipo de conteúdo.

:label: KEYWORDS

API, ticket, mensagem, mídia, integração

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