Chamados

add_ticket_note

Escrita

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

Permissão

tickets:write

Operação

tickets.note

Parâmetros

ticketIdstringobrigatório

messagestringobrigatório

assign_ticket

Escrita

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

Permissão

tickets:write

Operação

tickets.assign

Parâmetros

ticketIdstringobrigatório

userIdstringobrigatório

create_ticket

Escrita

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.

Permissão

tickets:write

Operação

tickets.create

Parâmetros

contactIdstringopcional

conversationIdstringopcional

subjectstringobrigatório

categorystringopcional

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

categoryIdstringopcional

prioritystringopcional

LOWMEDIUMHIGHURGENT

departmentstringopcional

assignedToIdstringopcional

sourcestringopcional

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

get_ticket

Leitura

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).

Permissão

tickets:read

Operação

tickets.get

Parâmetros

ticketIdstringopcional

numberstringopcional

Número de protocolo.

get_ticket_stats

Leitura

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

Permissão

tickets:read

Operação

tickets.stats

Parâmetros

Sem parâmetros.

list_ticket_categories

Leitura

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

Permissão

tickets:read

Operação

tickets.categories.list

Parâmetros

Sem parâmetros.

list_tickets

Leitura

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.

Permissão

tickets:read

Operação

tickets.list

Parâmetros

statusstring[]opcional

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

prioritystringopcional

LOWMEDIUMHIGHURGENT

assignedToIdstringopcional

contactIdstringopcional

categoryIdstringopcional

departmentstringopcional

searchstringopcional

limitintegeropcional

offsetintegeropcional

reopen_ticket

Escrita

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

Permissão

tickets:write

Operação

tickets.reopen

Parâmetros

ticketIdstringobrigatório

reasonstringopcional

set_ticket_status

Escrita

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.

Permissão

tickets:write

Operação

tickets.status

Parâmetros

ticketIdstringobrigatório

statusstringobrigatório

OPENWAITING_CUSTOMERRESOLVEDCLOSED

notestringopcional

update_ticket

Escrita

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.

Permissão

tickets:write

Operação

tickets.update

Parâmetros

ticketIdstringobrigatório

subjectstringopcional

categorystringopcional

categoryIdstringopcional

prioritystringopcional

LOWMEDIUMHIGHURGENT

departmentstringopcional