Chat Pró Oratrix: API Externa — Tickets

Chatbot Pró da Oratrix
, , ,
1

Chat Pró Oratrix: API Externa — Tickets

: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}.
  • Cliente HTTP.

:receipt: VISÃO GERAL

A família Tickets reúne operações para criar tickets, consultar informações e mensagens, adicionar ou remover tags, criar notas, atualizar fila, canal e dados do ticket, além de enviar estados de presença.

:compass: PASSO A PASSO GUIADO

  1. Use a base https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}.
  2. Envie Authorization: Bearer {token}.
  3. Use JSON ou multipart/form-data conforme o endpoint.
  4. Escolha a operação:
Método Endpoint Uso
POST /addTag Adicionar tag ao ticket
POST /addTagContact Adicionar tag ao contato
POST /removeTagContact Remover tag do contato
POST /createNotes Criar nota
POST /createTicket Criar ticket; suporta JSON, arquivo e Webmail
GET /listNotes Listar notas
POST /removeTag Remover tag do ticket
POST /sendPresence Enviar typing, paused ou recording
POST /updatequeue Alterar fila
POST /updatetag Definir tag
POST /updateticketinfo Atualizar dados e status do ticket
POST /showAllMessages Listar mensagens do ticket
POST /showallticket Consultar tickets pelo número
POST /showticket Consultar ticket pelo número
POST /showticketchatbot Consultar ticket no contexto de chatbot
POST /updateNote Atualizar nota
POST /updateTicketChannel Alterar canal do ticket

CreateTicket

O endpoint https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/createTicket possui variantes documentadas para ticket comum, envio com arquivo e Webmail. Preserve campos como body, number, externalKey, userId, status, channelId, email, name e validateNumber conforme o formato utilizado.

Atualização de ticket

/updateticketinfo aceita campos documentados como ticketId, userId, status, queueId, typebotStatus, chatgptStatus, dialogflowStatus, difyStatus, n8nStatus e chatFlowId.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: Preserve endpoints, campos e valores técnicos exatamente como documentados.
  • :warning: validateNumber=false usa o número exatamente como enviado e é documentado como opção útil para evitar normalização do 9º dígito em determinados cenários WABA.
  • :warning: Não exponha o {token}.
  • :warning: 400 indica parâmetros inválidos ou ausentes; 401, problema de autenticação/permissão.

:gear: DICAS E BOAS PRÁTICAS

  • Gere externalKey único quando o endpoint exigir controle de idempotência.
  • Valide IDs de ticket, fila, usuário, tag e canal antes de atualizar.
  • Teste em homologação antes de automatizar ações em produção.

:bar_chart: RESULTADO ESPERADO

A integração poderá criar, consultar e atualizar tickets e seus elementos relacionados pela API externa.

:receipt: RESUMO FINAL

Use as rotas da família Tickets a partir de https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID} com Authorization: Bearer {token}.

:label: KEYWORDS

API, Tickets, tags, notas, 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.