🎫 Tickets API

API completa para gestão de tickets de suporte, categorização, priorização e acompanhamento de solicitações.

✨ Sistema Completo de Suporte

Crie, gerencie e acompanhe tickets com SLA, prioridades e categorias customizadas.

Introdução

O módulo de Tickets permite gerenciar todo o ciclo de vida de solicitações de suporte:

  • Criar e gerenciar tickets de suporte
  • Organizar por categorias e prioridades
  • Adicionar interações e acompanhamento
  • Vincular contatos e usuários responsáveis
  • Fixar tickets importantes
  • Anexar arquivos e documentos

Gestão de Tickets

Endpoints para CRUD completo de tickets.

GET

/v1/tickets

Listar tickets

POST

/v1/create-ticket

Criar novo ticket

GET

/v1/tickets/{id}

Obter detalhes do ticket

PATCH

/v1/tickets/{id}

Atualizar ticket

POST

/v1/pin-ticket

Fixar ticket

Exemplo: Criar ticket 
const response = await fetch(
  'https://api.atys.pro/v1/create-ticket',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      title: 'Problema com login',
      description: 'Usuário não consegue fazer login no sistema',
      category_id: 2,
      priority_id: 3, // Alta
      contact_id: 456,
      status_id: 1, // Aberto
      metadata: {
        browser: 'Chrome 120',
        os: 'Windows 11'
      }
    })
  }
);

const ticket = await response.json();
console.log('Ticket criado:', ticket.data.id);
Resposta 
{
  "success": true,
  "data": {
    "id": 789,
    "code": "TICK-2025-000789",
    "title": "Problema com login",
    "description": "Usuário não consegue fazer login no sistema",
    "category": {
      "id": 2,
      "name": "Suporte Técnico"
    },
    "priority": {
      "id": 3,
      "name": "Alta",
      "color": "#f59e0b"
    },
    "status": {
      "id": 1,
      "name": "Aberto"
    },
    "contact": {
      "id": 456,
      "name": "João Silva",
      "email": "joao@example.com"
    },
    "created_at": "2025-11-09T14:30:00Z",
    "updated_at": "2025-11-09T14:30:00Z"
  }
}

Categorias

Organize tickets por categorias customizadas.

GET

/v1/categories

Listar categorias

POST

/v1/categories

Criar categoria

Prioridades

Defina níveis de prioridade para seus tickets.

GET

/v1/priorities

Listar prioridades

POST

/v1/priorities

Criar prioridade

Interações

Adicione comentários, atualizações e acompanhamento aos tickets.

GET

/v1/ticket-interactions

Listar interações

POST

/v1/user-create-ticket-interaction

Criar interação

Exemplo: Adicionar comentário 
const response = await fetch(
  'https://api.atys.pro/v1/user-create-ticket-interaction',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      ticket_id: 789,
      content: 'Realizamos a redefinição da senha. Por favor, tente novamente.',
      is_internal: false, // Visível para o cliente
      interaction_type: 'comment'
    })
  }
);

Tags

Organize tickets com tags personalizadas.

GET

/v1/tickets-tags

Listar tags de tickets

Webhooks Disponíveis

  • ticket.created - Ticket criado
  • ticket.updated - Ticket atualizado
  • ticket.assigned - Ticket atribuído
  • ticket.resolved - Ticket resolvido
  • ticket.sla_breach - SLA violado

Esta página foi útil?

← Omnichat API
Contatos API →