Criar e acompanhar casos por API
As requisições para criar um caso, adicionar respostas, consultar o status, baixar anexos e responder à pesquisa a partir do seu sistema.
Nesta página
Com a URL para criar casos de um canal, seu servidor cria e acompanha casos na mesa. Todas as requisições vão assinadas: leia Assinar as requisições.
Nesta página, {URL} é a URL do canal, por exemplo https://api-itsm.argunis.com/api/public/cases/v1/AbC….
Criar um caso
POST {URL}/cases com este corpo JSON:
{
"externalId": "7c1e0b9a-4f1d-4a51-9a3e-2d5b8f0c1a22",
"subject": "No puedo exportar el reporte mensual",
"description": "Al presionar Exportar aparece un error.",
"kind": "incident",
"urgency": 2,
"impact": 2,
"category": "Reportes",
"requester": { "email": "ana@cliente.cl", "name": "Ana Pérez", "phone": "+56 9 1234 5678" },
"company": { "name": "Cliente SpA", "taxId": "76.123.456-7" },
"context": { "pantalla": "/reportes/mensual", "version": "4.2.1", "navegador": "Chrome 141" },
"attachments": [{ "filename": "error.png", "contentType": "image/png", "dataBase64": "iVBORw0KGgo…" }]
}Campo | Obrigatório | Uso |
|---|---|---|
| sim | O identificador do caso no seu sistema (até 100 caracteres: letras, números e |
| sim | Assunto, de 3 a 200 caracteres. |
| não | Detalhe, até 20.000 caracteres. |
| não |
|
| não | 1 alta, 2 média, 3 baixa. Se faltarem, os do canal. |
| não | Nome de uma categoria da mesa. Se não corresponder, a do canal. |
| sim | E-mail e nome de quem pede ajuda. O telefone é opcional. |
| não | Empresa do solicitante: nome e RUT. |
| não | Até 20 dados de texto que ajudam a equipe (tela, versão, navegador). São adicionados no fim da descrição. |
| não | Até 5 arquivos de 5 MB cada, em base64. São aceitos os mesmos tipos que nos tickets. |
Respostas:
Código | Significado |
|---|---|
201 | Caso criado. Traz |
200 | Já existia um caso com esse |
400 | Algum campo não é válido; |
403 | O solicitante não é permitido pelo canal. |
Gere o externalId antes de enviar e guarde-o. Se a rede falhar, tente de novo com o mesmo externalId e um webhook-id novo: o caso nunca é duplicado.
O caso que o Elion ITSM devolve
{
"case": {
"number": "INC-000123",
"externalId": "7c1e0b9a-4f1d-4a51-9a3e-2d5b8f0c1a22",
"subject": "No puedo exportar el reporte mensual",
"state": "in_progress",
"stateLabel": "En revisión",
"waitingOn": "team",
"priority": "P3",
"createdAt": "2026-10-13T14:02:11.000Z",
"updatedAt": "2026-10-13T14:20:45.000Z",
"resolvedAt": null,
"closedAt": null,
"resolution": null,
"assignee": { "name": "Carla Soto" },
"csatPending": false,
"publicMessages": [
{ "id": "981", "side": "agent", "author": "Carla Soto", "body": "Hola Ana, ¿qué formato elegiste?", "at": "2026-10-13T14:20:45.000Z", "attachments": [] }
]
}
}stateLabeljá vem escrito para o solicitante: Recebida, Em análise, Aguardando sua resposta, Resolvida, Fechada, Cancelada.waitingOndiz quem precisa agir:team(a equipe),requester(o solicitante) ounullse terminou.publicMessagestraz só a conversa com o solicitante, as últimas 200 mensagens. Nunca as notas internas da equipe.bodyé texto simples: mostre-o como texto, não como HTML.
Consultar um caso
GET {URL}/cases/{ref}, onde {ref} é o número (INC-000123) ou o seu externalId. Responde { "case": … }. Só encontra casos criados por esse canal.
Responder
POST {URL}/cases/{ref}/replies:
{ "body": "Elegí PDF.", "author": { "email": "ana@cliente.cl", "name": "Ana Pérez" }, "attachments": [] }Conta como uma resposta do solicitante: se a equipe o tinha em espera da resposta dele, o caso volta para Em andamento, e se estava Resolvido, é reaberto. Um caso Fechado responde 409: é preciso criar um novo.
Baixar um anexo
GET {URL}/cases/{ref}/attachments/{id}, com o id que vem em publicMessages. Só entrega anexos da conversa pública do caso.
Responder à pesquisa
Quando csatPending for true, POST {URL}/cases/{ref}/csat:
{ "score": 5, "comment": "Rápido y claro." }score vai de 1 a 5. Se não houver uma pesquisa pendente, responde 409.