Tickets

add_ticket_note

Write

Nota interna no histórico do atendimento (o cliente não vê). Para falar com o cliente, use send_message_to_contact na conversa.

Permission

tickets:write

Operation

tickets.note

Parameters

ticketIdstringrequired

messagestringrequired

assign_ticket

Write

Passa o atendimento para alguém da equipe, ou tira o responsável (userId nulo).

Permission

tickets:write

Operation

tickets.assign

Parameters

ticketIdstringrequired

userIdstringrequired

create_ticket

Write

Abre um atendimento com número de protocolo. Para um contato (ligação, presencial, e-mail fora da plataforma) ou a partir de uma conversa — nesse caso, se a conversa já tem atendimento, devolve o mesmo. Não avisa o cliente: passe o número para ele se quiser.

Permission

tickets:write

Operation

tickets.create

Parameters

contactIdstringoptional

conversationIdstringoptional

subjectstringrequired

categorystringoptional

Nome da categoria; é criada se não existir.

categoryIdstringoptional

prioritystringoptional

LOWMEDIUMHIGHURGENT

departmentstringoptional

assignedToIdstringoptional

sourcestringoptional

Por onde chegou (sem conversa). Padrão PHONE.WHATSAPPWEB_CHATEMAILINSTAGRAMMESSENGERTELEGRAMPHONEIN_PERSONINTERNAL

get_ticket

Read

Um atendimento por id ou pelo número de protocolo (aceita só a sequência, ex.: "4812"): dados, SLA, conversas ligadas, tarefas do quadro ligadas e o histórico (últimos 30 eventos, com notas internas).

Permission

tickets:read

Operation

tickets.get

Parameters

ticketIdstringoptional

numberstringoptional

Número de protocolo.

get_ticket_stats

Read

Quantos atendimentos há em cada status (abertos, esperando o cliente, resolvidos, encerrados).

Permission

tickets:read

Operation

tickets.stats

Parameters

No parameters.

list_ticket_categories

Read

Categorias de atendimento da empresa (para filtrar e classificar tickets).

Permission

tickets:read

Operation

tickets.categories.list

Parameters

No parameters.

list_tickets

Read

Atendimentos com protocolo (tickets), mais recentes primeiro: número, assunto, status, prioridade, categoria, contato, responsável e prazos de SLA. `search` acha por número de protocolo, assunto, nome ou telefone do contato.

Permission

tickets:read

Operation

tickets.list

Parameters

statusstring[]optional

Um ou mais: OPEN, WAITING_CUSTOMER (esperando o cliente), RESOLVED, CLOSED.

prioritystringoptional

LOWMEDIUMHIGHURGENT

assignedToIdstringoptional

contactIdstringoptional

categoryIdstringoptional

departmentstringoptional

searchstringoptional

limitintegeroptional

offsetintegeroptional

reopen_ticket

Write

Reabre um atendimento resolvido (volta para OPEN). Encerrado (CLOSED) não reabre: abra outro.

Permission

tickets:write

Operation

tickets.reopen

Parameters

ticketIdstringrequired

reasonstringoptional

set_ticket_status

Write

Muda o status do atendimento: OPEN, WAITING_CUSTOMER (pausa o prazo de resolução), RESOLVED ou CLOSED (encerrado não reabre). `note` entra no histórico. Ao resolver/encerrar com tarefas abertas, avisa em `warning` sem bloquear.

Permission

tickets:write

Operation

tickets.status

Parameters

ticketIdstringrequired

statusstringrequired

OPENWAITING_CUSTOMERRESOLVEDCLOSED

notestringoptional

update_ticket

Write

Edita assunto, categoria, prioridade ou departamento de um atendimento (só os campos enviados mudam). Mudança de prioridade e de departamento fica no histórico.

Permission

tickets:write

Operation

tickets.update

Parameters

ticketIdstringrequired

subjectstringoptional

categorystringoptional

categoryIdstringoptional

prioritystringoptional

LOWMEDIUMHIGHURGENT

departmentstringoptional