Preparar uma chamada controlada

  1. 1

    Acesse Configuração > API e confirme a credencial destinada à integração.

  2. 2

    Copie a URL base e o ApiID do mesmo ambiente em que está o ticket de teste.

  3. 3

    Envie o token no cabeçalho Authorization com o esquema Bearer.

  4. 4

    Nas requisições com corpo JSON, use Content-Type application/json e envie somente os campos publicados para a rota.

  5. 5

    Registre método, rota, horário e ticketId, mantendo token e conteúdo do atendimento fora dos logs de diagnóstico.

Tela de APIs do Atendeu Rápido com acesso à documentação e criação de credencial
Use o ApiID no caminho da rota e mantenha o token somente no cabeçalho de autorização.

Consultar o ticket antes de qualquer escrita

  • POST /v2/api/external/{ApiID}/showTicketById consulta um ticket conhecido.
  • ApiID é uma string obrigatória no caminho.
  • O corpo publicado é um objeto com ticketId do tipo string.
  • O schema não marca ticketId nem o próprio corpo como obrigatórios; confirme o comportamento da versão do seu ambiente antes de automatizar.
  1. 1

    Obtenha o ticketId por uma consulta anterior e não o confunda com telefone, número do contato ou ID da mensagem.

  2. 2

    Consulte o ticket e confira contato, canal, fila, responsável e estado esperado.

  3. 3

    Execute somente uma operação de escrita.

  4. 4

    Consulte novamente e confirme o resultado também na tela de atendimento.

Cabeçalho do ticket com os atalhos de ações do atendimento numerados
A interface ajuda a conferir o ticket e o efeito da operação; os ícones não substituem a validação do contrato da API.

Iniciar, consultar e encerrar uma pausa

  • POST /v2/api/external/{ApiID}/ticket/pause/start/{ticketId} inicia a pausa. ApiID e ticketId são strings obrigatórias no caminho; o corpo expõe pauseReason como string.
  • GET /v2/api/external/{ApiID}/ticket/pause/logs/{ticketId} consulta os registros de pausa. ApiID e ticketId são strings obrigatórias no caminho.
  • POST /v2/api/external/{ApiID}/ticket/pause/end/{ticketId} encerra a pausa. ApiID e ticketId são strings obrigatórias no caminho; o schema do corpo é um objeto sem propriedades.
  • Os schemas de início e encerramento não marcam o corpo nem suas propriedades como obrigatórios.
Ações do ticket na aba Gestão com a opção Pausar atendimento
Depois de iniciar ou encerrar uma pausa pela API, confirme o estado correspondente na aba Gestão do ticket.
  1. 1

    Consulte o ticket e verifique se já existe uma pausa ativa.

  2. 2

    Valide no ambiente de homologação qual valor de pauseReason corresponde ao motivo autorizado pela operação; o contrato publica apenas o tipo string.

  3. 3

    Inicie a pausa uma única vez.

  4. 4

    Consulte os registros pela rota de logs e confira o estado na interface.

  5. 5

    Encerre a pausa somente depois de confirmar que ela continua ativa.

  6. 6

    Consulte os registros novamente antes de considerar o fluxo concluído.

Listar e enviar avaliações

  • GET /v2/api/external/{ApiID}/listTicketEvaluations recebe ApiID como string obrigatória no caminho e aceita page e limit como inteiros opcionais na query.
  • POST /v2/api/external/{ApiID}/sendEvaluation recebe ApiID como string obrigatória no caminho.
  • O corpo de sendEvaluation publica ticketId como number, body como string, externalKey como string e force como boolean.
  • Nenhuma propriedade do corpo de sendEvaluation aparece marcada como obrigatória.
Aba Atendimento com os controles de protocolo e avaliação do ticket
O envio de avaliação possui controle e log próprios na interface; confira-os antes de repetir uma solicitação.

Criar e consultar um compartilhamento

  • POST /v2/api/external/{ApiID}/ticket/share recebe ApiID como string obrigatória no caminho e publica ticketId e inviteUrl como strings no corpo.
  • GET /v2/api/external/{ApiID}/ticket/share/{ticketId} recebe ApiID e ticketId como strings obrigatórias no caminho.
  • O corpo da criação não marca ticketId nem inviteUrl como obrigatórios.
  • O contrato não define formato de inviteUrl, duração, revogação, permissões nem conteúdo acessível pelo compartilhamento.
Janela de convites compartilhados no Atendeu Rápido
A lista de convites ajuda a verificar o estado visível ao usuário, sem revelar o contrato ou as permissões do compartilhamento.

Reconhecer limites e reconciliar o resultado

As rotas publicam resposta HTTP 200 com conteúdo application/json, mas não apresentam schema de resposta, exemplos de retorno, códigos de erro, limites de uso, idempotência ou regras de retentativa. O sistema consumidor precisa validar o formato realmente devolvido pela versão do ambiente.

  • Ticket não encontrado: confirme URL base, ApiID, ticketId e o tipo exigido pela rota.
  • Pausa divergente: consulte o histórico antes de iniciar ou encerrar novamente.
  • Avaliação aparentemente ausente: consulte os registros e o log da interface antes de reenviar.
  • Paginação inconsistente: page e limit não têm faixa nem base inicial publicadas; determine o comportamento com uma consulta controlada.
  • Resposta 200 inconclusiva: confira o estado funcional na consulta e na interface, sem tratar o código isolado como confirmação suficiente.