1. Tickets
Khal Docs
  • Raiz
    • CRM
      • CRM — Overview
      • Genérico (data)
        • CRM - Genérico
        • Listar/filtrar registros (qualquer tabela do CRM)
        • Criar/atualizar registros (qualquer tabela do CRM)
        • Hard-delete (não permitido para tabelas company)
      • Empresas Relacionadas
        • CRM - Empresas relacionadas
        • Listar relacionamentos de uma empresa (ambas as direções)
        • Tipos de relacionamento disponíveis
        • Criar relacionamento entre duas empresas
        • Alterar o tipo do relacionamento
        • Inativar relacionamento (reversível)
        • Excluir relacionamento (hard-delete)
      • Ticket ↔ Empresa
        • CRM - Ticket <-> Empresa
        • Empresas elegíveis para o ticket
        • Vincular / trocar a empresa do ticket
      • Templates
        • CRM - Templates
        • Listar templates do tenant (apenas IDs, sem fields)
        • Detalhe completo do template (com fields)
        • Pesquisa formatada por scope (CRMSearchResult)
      • Empresas do cliente
        • Listar tipos de relacionamento
        • Listar empresas de um cliente
        • Vincular empresa ao cliente
        • Trocar a empresa principal
        • Alterar tipo de relacionamento
        • Inativar vínculo
        • Reativar vínculo
        • Excluir vínculo
    • Workflow
      • Workflow - Overview
      • Tickets
        • Workflow - Tickets
        • Criar ticket com auto-vínculo / criação de customer via contato
          POST
        • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
          GET
        • Criar ticket (básico, com integração CRM opcional)
          POST
        • Movimentar ticket entre fases (ou finalizar)
          POST
        • Atualizar dados do ticket (nome, descrição, valor)
          PUT
        • Vincular cliente CRM a um ticket existente
          PUT
        • Adicionar nota ou mensagem ao ticket
          POST
        • Atribuir ou transferir o responsável do ticket
          PUT
      • Workspaces & Workflows
        • Workflow - Workspaces & Workflows
        • Listar workspaces e workflows acessíveis ao usuário
        • Listar fases de um workflow
        • Listar tickets de uma ou mais fases (paginado)
    • Webhooks
      • Eventos
        • 📨 [Contrato] Evento entregue na sua URL
        • Catálogo de eventos disponíveis
      • Assinaturas
        • Listar webhooks cadastrados
        • Criar webhook (o secret aparece UMA única vez)
        • Testar conectividade de uma URL
        • Detalhar webhook
        • Atualizar webhook
        • Ativar/desativar webhook (toggle)
        • Remover webhook (soft delete)
      • Entregas
        • Log de entregas de uma assinatura
        • Reprocessar uma entrega
        • Reprocessar TODAS as entregas com falha
      • Integrações
        • Voz IA (ElevenLabs)
          • Criar ou atualizar a integração de Voz IA
          • Consultar a integração de Voz IA
          • Alterar a integração de Voz IA (secret, toggle, allowlist)
          • Remover a integração de Voz IA
          • Webhook pós-chamada (chamado pelo provedor de voz)
    • Configurações
      • Canais
        • WhatsApp oficial
          • Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
          • Listar números disponíveis de uma WABA
          • Criar conexão de WhatsApp oficial
          • Conectar o número oficial (ativar a conexão)
        • Telefonia
          • Anexar gravação de ligação (telefonia de terceiros)
          • Registrar CSAT de ligação
          • Consultar status da gravação enviada
      • Templates
        • WhatsApp oficial
          • Listar templates HSM (a tela Templates › WhatsApp oficial)
          • Criar template HSM (+ Novo modelo)
          • Detalhar template
          • Atualizar template
          • Excluir template
          • Sincronizar templates com a Meta
          • Upload de mídia para o header do template
        • RCS
          • Listar templates de RCS
      • Base de dados
        • Modelo de colunas do CSV
        • Importar base (CSV) para uma tabela do CRM
        • Acompanhar as importações (validar o resultado)
        • Erros de uma importação
        • Exportar os erros em planilha
    • Raiz
      • Workflow
        • Tarefas
          • Criar tarefa
          • Listar tarefas
          • Resumo de tarefas
          • Consultar tarefa
          • Editar tarefa
          • Concluir tarefa
          • Cancelar (excluir) tarefa
          • Silenciar alarme
          • Tarefas do ticket
  • Esquemas
    • LoginRequest
    • FilterOperator
    • WebhookSubscription
    • ClienteEmpresaTipo
    • LoginResponse
    • FilterCondition
    • WebhookSubscriptionResumo
    • ClienteEmpresa
    • Error
    • Pagination
    • WebhookDelivery
    • ErroRegra
    • FilterRequest
    • WebhookEventEnvelope
    • FilterResponse
    • SetMethod
    • SetRequest
    • DeleteRequest
    • SuccessEnvelope
    • ErrorEnvelope
    • Empresa
    • EmpresaResumo
    • EmpresaRelacionadaCreate
    • EmpresaRelacionada
    • TicketInfoResponse
  1. Tickets

Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)

GET
/api/v2/ticket/info/{id}
Retorna tudo sobre um ticket: dados básicos, fases elegíveis pra movimentação,
responsáveis, mensagens / atividades (messages[]), SLA, customer vinculado (CRM),
business (negociação), empresa, protocolos, tags, arquivos, etc.
Use pra:
Renderizar a tela do ticket (chat, atividades, painel lateral).
Saber qual a id_phase atual + as eligible_phases pra próximas movimentações.
Recuperar customer.id_crm antes de fazer operações no CRM relacionadas ao ticket.

Path param#

{id} = UUID do ticket (não confundir com id_seq numérico).

Campos importantes do retorno#

CampoO que é
id / id_seqUUID estável vs id numérico sequencial (visível na UI)
phase / id_phaseFase atual no workflow
super_status"Em andamento" / "Finalizado com sucesso" / "Finalizado com insucesso"
opentrue enquanto o ticket está aberto
customerBloco com id_crm + table + column apontando pro registro no CRM
businessNegociação vinculada (null quando não há)
responsibles[]Operadores designados
messages[]Atividades + mensagens (init_message, customer_added, history_ticket_phases, msg do operador/cliente…)
eligible_phases[]Fases pra onde o ticket pode ser movido agora
protocolsProtocolos de atendimento ligados ao ticket
sla_geral / sla_statusSLA do ticket

Requisição

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200OK
application/json
Envelope {ok, data, message} com o detalhe completo do ticket.
Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v2/ticket/info/' \
--header 'api-key: {{api-key}}'
Response Response Example
200 - Ticket aberto com customer, fases elegíveis, mensagens e SLA
{
    "ok": true,
    "data": {
        "id": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
        "id_seq": 484898,
        "name": "Ticket Teste",
        "description": "Descrição Teste",
        "id_father": null,
        "ticket_father": null,
        "origin": {
            "id": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
            "name": "Active",
            "url": "",
            "description": "",
            "channel": ""
        },
        "created_at": "2025-06-26 20:57:50.807581 +0000 UTC",
        "updated_at": "2025-06-26 21:21:58.650729 +0000 UTC",
        "pending_time": null,
        "last_channel_interaction": null,
        "crm_price": 0,
        "checklist": {
            "total": 0,
            "check": 0
        },
        "responsibles": [
            {
                "uid": "1f8e7d40-17c8-4ab1-9165-50e974b00f44",
                "name": "Willian Johan Wandscheer",
                "id": 8
            }
        ],
        "open": true,
        "sla_status": {},
        "sla_geral": {},
        "phase": "Sem automação",
        "id_phase": "634c07c4-51b7-400d-8b4a-b5c7d19e925f",
        "workspace": "Fluxo de Automação",
        "id_workspace": "9ed15978-a340-4ae2-a945-2b9cb704f61a",
        "workflow": "Playground",
        "average_time_interaction": "00:00:00",
        "average_time_response": "00:00:00",
        "creator": {
            "uid": "1f8e7d40-17c8-4ab1-9165-50e974b00f44",
            "name": "Willian Johan Wandscheer",
            "permission": "Editor",
            "id": 8
        },
        "messages": [
            {
                "id_ticket": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
                "id_seq": 484898,
                "user_id": 8,
                "user_name": "Willian Johan Wandscheer",
                "workspace_name": "Fluxo de Automação",
                "workflow_name": "Playground",
                "phase_name": "Sem automação",
                "created_at": "2025-06-26T20:57:50.807581Z",
                "type_message": "init_message",
                "type": "action"
            },
            {
                "id_ticket": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
                "customer_name": "Willian Johan",
                "created_at": "2025-06-26T20:57:51.143325Z",
                "type_message": "customer_added",
                "type": "action",
                "user_id": "1567199f-59fe-4e57-99cd-c7df1ddfd1b0",
                "user_name": "Automação"
            }
        ],
        "progress": 10,
        "super_status": "Em andamento",
        "eligible_phases": [
            {
                "id": "b5d7f8ab-3c76-43db-838c-73c54cc1e0f7",
                "name": "Setup",
                "icon": "",
                "id_status": 1,
                "crm_fields": null
            },
            {
                "id": "bd89ab72-0b9d-4829-ba0b-4893e1b01f4a",
                "name": "Sucesso",
                "icon": "",
                "id_status": 3,
                "crm_fields": null
            },
            {
                "id": "a8baf782-081d-4250-97d7-58dd72ba68e6",
                "name": "Insucesso",
                "icon": "",
                "id_status": 2,
                "crm_fields": null
            }
        ],
        "id_workflow": "1fa78845-92bc-4c7d-95a2-6b93d8876712",
        "customer": {
            "id": "93a878de-0fbb-4602-972d-77c793702c04",
            "id_ticket": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
            "id_crm": "1",
            "table": "cliente",
            "column": "id",
            "template": "dc6e0903-e41d-48c5-8e10-e0542a682468",
            "created_at": "2025-06-26T20:57:51.112725Z",
            "updated_at": "2025-06-26T20:57:51.112725Z"
        },
        "id_tab": "00000000-0000-0000-0000-000000000000",
        "department": 0,
        "permission_user_access": null,
        "business": null,
        "last_interaction": "2025-06-26T20:58:26.171971Z",
        "calc_crm": {
            "table": "",
            "column": ""
        },
        "reply": true,
        "protocols": {},
        "tags": [],
        "files": [],
        "history_notes": null
    },
    "message": "Ticket aberto com sucesso."
}
Modificado em 2026-11-04 02:31:07
Página anterior
Criar ticket com auto-vínculo / criação de customer via contato
Próxima página
Criar ticket (básico, com integração CRM opcional)
Built with