Breadcrumbs

Gestão de Casos

Endpoints para consulta, atualização e ações de ciclo de vida sobre casos.

Todas as requisições exigem o cabeçalho Authorization veja Autenticação e Segurança.

Índice desta página


Alterar Pessoa de um Caso

Altera a pessoa associada a um caso existente, substituindo o vínculo atual por outro personId.

Request

PUT https://api.cvortex.com/v1/case/change-person

Header: Authorization

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

caseId

ID numérico do caso (easyId)

Sim

personId

UUID da nova pessoa a ser associada ao caso

Sim

Body

JSON
{
  "easyId": 10880,
  "personId": "ceeb592b-1dee-4b24-b319-7f34b945401e"
}

Campo

Tipo

Descrição

Obrigatório

easyId

int

Identificador numérico do caso (caseId)

Sim

personId

string

UUID da nova pessoa solicitante do caso

Sim

Exemplo de Requisição

PUT https://api.cvortex.com/v1/case/change-person
Authorization: Bearer {token}

{
  "easyId": 10880,
  "personId": "ceeb592b-1dee-4b24-b319-7f34b945401e"
}

Response

JSON
{
    "id": "39fd6e51-950b-4741-9a98-bde2afe8a4ad",
    "deleted": false,
    "createdAt": 1747942191554,
    "updatedAt": 1747942527072,
    "active": true,
    "createdBy": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
    "updatedBy": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
    "version": "2",
    "subject": "Caso manual criado via API",
    "caseType": "d2af060c-7251-41cd-aee3-9fda35d14c7c",
    "caseStatus": "0997b604-e549-41f5-89c4-736efd8edfea",
    "businessUnit": "24d521b8-42d5-4b5e-92a2-586a5b30bafa",
    "priority": "LOW",
    "externalId": "CVTEX-10880",
    "personRequesterId": "ceeb592b-1dee-4b24-b319-7f34b945401e",
    "currentAssignee": "9d9df418-61eb-48a2-b3b3-0312c153ebf6",
    "closed": false,
    "lastAction": "e07a30b6-f77d-4cd3-9e07-942946e1a69f",
    "caseId": 10880,
    "inProgress": true,
    "startedProgressAt": 1747942190140,
    "expired": false,
    "caseFormId": "1f5b3d6f-acfd-4faa-a5fb-066ec78e9c81",
    "chatSessionClosed": false
}

Explicação dos campos de resposta

Campo

Tipo

Descrição

id

string

UUID interno do caso

caseId

int

Identificador numérico do caso

personRequesterId

string

Novo UUID da pessoa vinculada ao caso

subject

string

Assunto/título do caso

priority

string

Prioridade do caso (LOW, MEDIUM, HIGH)

caseType

string

UUID do tipo do caso

caseStatus

string

UUID do status atual do caso

active

boolean

Indica se o caso está ativo

closed

boolean

Indica se o caso está encerrado

inProgress

boolean

Indica se o caso está em andamento


Atribuir Responsável ao Caso

Permite atribuir ou transferir a responsabilidade de um caso para outro agente (usuário).

Request

PUT https://api.cvortex.com/v1/case/assign

Header: Authorization

Body

JSON
{
  "easyId": 10880,
  "personId": "9d9df418-61eb-48a2-b3b3-0312c153ebf6"
}

Campo

Tipo

Descrição

Obrigatório

easyId

int

Identificador numérico do caso (caseId)

Sim

personId

string

UUID do agente (usuário) que será o novo responsável pelo caso

Sim

Response

204 No Content a atribuição ocorreu com sucesso. Nenhuma informação adicional é retornada no corpo da resposta.


Transferir Caso (Entrega via motor de distribuição)

Mesmo endpoint de Atribuir Responsável ao Caso, porém sem informar personId: o caso é entregue automaticamente pelo motor de distribuição da plataforma.

Request

PUT https://api.cvortex.com/v1/case/assign

Header: Authorization

Body

JSON
{
  "easyId": 10886
}

Campo

Tipo

Descrição

Obrigatório

easyId

int

Identificador numérico do caso (caseId)

Sim

Response

204 No Content a atribuição ocorreu com sucesso. Nenhuma informação adicional é retornada no corpo da resposta.


Reclassificar Caso

Permite reclassificar um caso manualmente. A reclassificação pode ser usada para recalcular regras, atualizar categorias ou acionar processos automáticos novamente com base nos dados atuais do caso.

Request

PUT https://api.cvortex.com/v1/case/reclassify

Header: Authorization

Body

JSON
{
  "easyId": 10887
}

Campo

Tipo

Descrição

Obrigatório

easyId

int

Identificador numérico do caso (caseId)

Sim

Response

204 No Content a reclassificação foi executada com sucesso. Nenhuma informação adicional é retornada no corpo da resposta.


Alterar unidade de negócio de um caso

Permite alterar a unidade de negócio ("business unit") de um caso.

Essa API apenas altera a unidade de negócio do caso. Ela não reabre casos durante a troca.

Request

PUT https://api.cvortex.com/v1/case/update-business-unit

Header: Authorization

Parâmetros de URI

Nome

Tipo

Descrição

Obrigatório

caseId

hash

ID do caso

Sim

caseType

hash

Tipo de caso da nova unidade de negócio

Sim

caseStatus

hash

Status de caso da nova unidade de negócio

Sim

businessUnit

hash

Nova unidade de negócio

Sim

caseOrigin

hash

Origem de caso da nova unidade de negócio

Não

openingReason

hash

Razão de caso (abertura) da nova unidade de negócio

Não

closingReason

hash

Razão de caso (fechamento) da nova unidade de negócio

Não

Response

Código

Descrição

200

Operação realizada com sucesso

Exemplo de request

PUT https://api.cvortex.com/v1/case/update-business-unit
JSON
{
  "caseId": "123",
  "caseType": "123",
  "caseStatus": "123",
  "businessUnit": "123",
  "caseOrigin": "123",
  "closingReason": "123",
  "openingReason": "123"
}

Exemplo de resposta

JSON
{
  "id": "123123",
  "deleted": false,
  "createdAt": 1658928025873,
  "updatedAt": 1658928025873,
  "active": true,
  "createdBy": "default-user",
  "updatedBy": "default-user",
  "version": "5",
  "tenantId": "123"
}

Atualizar Status do Caso (em lote)

Permite atualizar o status de um caso ou, usando filter, de um lote de casos que atendam a um critério, em uma única chamada.

Request

PUT https://api.cvortex.com/v1/case/change-status

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

caseStatus

hash

Novo status do caso

Sim

filter

objeto

Filtro para selecionar casos em lote (dynamicFilter/nativeFilter, cada um com entries de entityUUID, fieldUUID, operator, values)

Não

sortFields

lista

Campos para ordenação dos resultados (usado com filter; limite de 1000 casos por operação)

Não

Response

Código

Descrição

200

Operação realizada com sucesso

Exemplo de request (com filtro)

JSON
{
  "caseStatus": "string",
  "filter": {
    "dynamicEntityUUID": "string",
    "dynamicFilter": {
      "entries": [
        { "entityUUID": "string", "fieldUUID": "string", "operator": "EQUAL", "values": ["string"] }
      ]
    },
    "dynamicRelationFieldUUID": "string",
    "nativeFilter": {
      "entries": [
        { "entityUUID": "string", "fieldUUID": "string", "operator": "EQUAL", "values": ["string"] }
      ]
    }
  },
  "ids": ["string"],
  "sortFields": ["string"]
}

Exemplo de request (operação em lote)

JSON
{
  "operation": "BULK_CHANGE_STATUS"
}

Atualizar dados de um atendimento aberto

Permite atualizar um caso/atendimento que esteja aberto, alterando dados de campos nativos e personalizados do caso.

Request

PUT https://api.cvortex.com/v1/case/{ID_HASH_CASE}

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

Case Type

string

ID Hash do tipo de atendimento

Sim

Business Unit

string

ID Hash da unidade de negócio

Sim

Version

number

Versão do documento

Sim

Priority

string

Prioridade dada ao atendimento

Não

Subject

string

Título do atendimento

Não

Comment

string

Comentário adicionado ao atendimento

Não

Exemplo de request

PUT https://api.cvortex.com/v1/case/58061c35-f316-4ecd-9851-4a32e34ae717
JSON
{
  "fields": [
    { "fieldLabel": "Version", "value": "8" },
    { "fieldLabel": "Case Type", "value": "88b3d6aa-b98e-48aa-9d18-ad44e45fea3e" },
    { "fieldLabel": "Business Unit", "value": "083f959b-28a5-4df3-91df-9d891109aa63" },
    { "fieldLabel": "Comment", "value": "Teste" }
  ],
  "details": [
    { "fieldLabel": "Agente", "value": "email@empresas.com" }
  ]
}


Atualizar campos de texto de casos fechados

Permite atualizar os campos de texto dos atendimentos que já foram finalizados. Campos que podem ser atualizados: Subject, Description, Comment, External ID.

Request

PUT https://api.cvortex.com/v1/case/{CASE_ID}/update-field

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

subject

string

Título do atendimento

Não

description

string

Descrição do atendimento

Não

comment

string

Comentário adicionado ao atendimento

Não

externalId

string

Identificador externo do atendimento

Não

Exemplo de request

PUT https://api.cvortex.com/v1/case/9956/update-field
JSON
{
  "comment": "string",
  "description": "string",
  "externalId": "string",
  "subject": "string"
}

Exemplo de response

JSON
{
    "id": "c7840ee7-eef7-4007-9690-d6d932faeeae",
    "createdAt": 1749234608153,
    "updatedAt": 1749832715223,
    "active": true,
    "createdBy": "default-user",
    "updatedBy": "a866f316-1248-43de-b252-016bef245061",
    "version": "2"
}

Reabrir um atendimento

Permite reabrir atendimentos diretamente via API, garantindo que nenhum atendimento fique sem o acompanhamento necessário.

Request

POST https://api.cvortex.com/v1/case/reopen

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

caseId

string

ID Hash do caso

Não um dos dois, caseId ou easyId, deve ser informado

easyId

string

ID simplificado do caso

Não um dos dois, caseId ou easyId, deve ser informado

statusToReopenCase

string

ID Hash do status inicial do caso

Sim

Exemplo de request

JSON
{
  "easyId": 3258,
  "statusToReopenCase": "f6438d40-a58e-4338-95a8-d30ee5e9a7b8"
}

Response

204 No Content


Unificar Atendimentos

Permite que o usuário unifique dois ou mais casos em um só.

Request

POST https://api.cvortex.com/v1/case/unify

Header: Authorization

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

destinationCase

string

ID Hash do atendimento que receberá os dados da unificação

Sim

casesToUnify

array de string

ID Hash dos atendimentos que serão unificados no caso de destino

Sim

Exemplo de request

JSON
{
  "destinationCase": "123-abc",
  "casesToUnify": ["456-abc", "789-def"]
}

Response

JSON
{
  "result": [
    {
      "id": "123-abc",
      "caseId": 25,
      "unified": true,
      "unifiable": true,
      "notUnifiedReason": null
    }
  ]
}

Buscar caso por ID

Permite buscar um caso pelo seu ID único.

Request

GET https://api.cvortex.com/v1/case/{id}

Header: Authorization

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID único do caso

Sim

Response

JSON
{
  "id": "string",
  "deleted": "boolean",
  "createdAt": "integer (int64)",
  "updatedAt": "integer (int64)",
  "active": "boolean",
  "createdBy": "string",
  "updatedBy": "string",
  "version": "string",
  "subject": "string",
  "caseType": "string",
  "caseTypeName": "string",
  "caseStatus": "string",
  "caseStatusName": "string",
  "businessUnit": "string",
  "businessUnitName": "string",
  "priority": "string",
  "description": "string",
  "externalId": "string",
  "companyRequesterId": "string",
  "companyRequesterName": "string",
  "personRequesterId": "string",
  "personRequesterName": "string",
  "currentAssignee": "string",
  "currentAssigneeName": "string",
  "caseOrigin": "string",
  "caseOriginName": "string",
  "scheduleTo": "integer (int64)",
  "scheduleToPerson": "string",
  "scheduleToPersonName": "string",
  "originallyCreatedOn": "integer (int64)",
  "closed": "boolean",
  "closedAt": "integer (int64)",
  "closedBy": "string",
  "closedNameBy": "string",
  "reopenedAt": "integer (int64)",
  "reopenedBy": "string",
  "reopenedNameBy": "string",
  "lastAction": "string",
  "lastActionName": "boolean",
  "openingReason": "string",
  "openingReasonName": "string",
  "closingReason": "string",
  "closingReasonName": "string",
  "caseId": "string",
  "queueId": "string",
  "queueName": "string",
  "inProgress": "boolean",
  "startedProgressAt": "integer (int64)",
  "caseBatchId": "string",
  "caseBatchName": "string",
  "comment": "string",
  "expired": "boolean",
  "expiredAt": "integer (int64)",
  "expiration": "integer (int64)",
  "currentContactId": "string",
  "currentChannel": "string",
  "currentContact": "string",
  "currentServiceId": "string",
  "queueStatus": "string",
  "queueStatusChangedAt": "integer (int64)",
  "createdFromChannel": "string",
  "caseFormId": "string",
  "caseFormName": "string",
  "caseDetails": [
    {
      "entityUuid": "string",
      "values": [
        {
          "label": "string",
          "name": "string",
          "fieldUuid": "string",
          "value": "string"
        }
      ]
    }
  ],
  "caseHistories": [
    {
      "createdAt": "integer (int64)",
      "changeDescription": "string",
      "username": "string",
      "comment": "string",
      "caseActionName": "string",
      "change": "string",
      "questionnaireAnswerId": "string",
      "questionnaireId": "string",
      "questionnaireName": "string"
    }
  ],
  "slasMonitors": [
    {
      "caseId": "string",
      "timeLeft": "integer (int64)",
      "timeLeftFlag": "string",
      "serviceLevelAgreement": "string"
    }
  ]
}

Repare que este objeto já traz, no mesmo payload, os três blocos mencionados na Visão Geral: caseDetails (dados personalizados), caseHistories (histórico de eventos) e slasMonitors (informações de SLA).


Buscar caso por case ID

Permite buscar um caso pelo seu ID de negócio (caseId).

Request

GET https://api.cvortex.com/v1/case/business/{id}

Header: Authorization

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID de negócio do caso

Sim

Response

Estrutura de resposta idêntica à de Buscar caso por ID a única diferença é o identificador usado para localizar o caso (ID de negócio/caseId em vez do ID único interno).


Buscar casos (v1)

Permite buscar casos através dos parâmetros usados como filtro.

Request

GET https://api.cvortex.com/v1/cases/search

Header: Authorization

Parâmetros de URI

Nome

Tipo

Descrição

Obrigatório

businessUnitId

hash

Unidade de negócio

Sim

externalId

string

Identificador externo

Não

caseStatusNames

array

Nome do status do caso

Não

caseTypeNames

array

Nome do tipo do caso

Não

queueNames

array

Nome da lista de caso

Não

contact

string

Contato da pessoa solicitante do caso

Não

personRequesterName

string

Nome da pessoa solicitante do caso

Não

personRequesterEasyId

number

Identificador da pessoa solicitante do caso

Não

currentAssigneeName

string

Nome do agente atribuído ao caso

Não

period

string

Período de intervalo de tempo para busca dos casos. Valores possíveis: TODAY, YESTERDAY, SEVEN_DAYS, FIFTEEN_DAYS, THIRTY_DAYS, BETWEEN.

Sim

createdDateStart

string

Data de início da criação dos casos. Obrigatório apenas quando period=BETWEEN. Formatos: dd/mm/aaaa hh:mm (tenant pt_BR) ou mm/dd/aaaa hh:mm (tenant en_US)

Não

createdDateEnd

string

Data final da criação dos casos. Obrigatório apenas quando period=BETWEEN. Mesmos formatos de createdDateStart

Não

limit

number

Quantidade de registros por página. Valor máximo permitido: 25

Não

offset

number

Número de registros saltados no resultado da página

Não

Response

JSON
[
  {
    "personRequesterEasyId": "text",
    "personRequesterName": "text",
    "caseId": "number (int64)",
    "externalId": "string",
    "createdDate": "string",
    "closedDate": "string",
    "caseTypeName": "string",
    "caseStatusName": "string",
    "queueName": "string",
    "currentAssigneeName": "string"
  }
]

Exemplo

GET https://api.cvortex.com/v1/cases/search?businessUnitId=ced312a4-f320-4555-ab43-81a9ad77f80c&caseStatusNames=Aguardando%20Atendimento&caseStatusNames=Inicio&createdDateEnd=11%2F09%2F2023%2023%3A59&createdDateStart=01%2F01%2F2023%2000%3A00&period=BETWEEN
JSON
[
  {
    "personRequesterEasyId": "10823",
    "personRequesterName": "Nome Sobrenome",
    "caseId": 21704,
    "id": "1239-123124-2324-3434",
    "createdDate": "01/09/2023 11:27",
    "closedDate": "03/09/2023 13:45",
    "caseTypeName": "Reserva",
    "caseStatusName": "Aguardando Atendimento",
    "queueName": "Fila Atendimento 01",
    "currentAssigneeName": "Agente 01"
  }
]

Contar casos

Permite contar casos através dos parâmetros usados como filtros.

Request

GET https://api.cvortex.com/v1/cases/count

Header: Authorization

Parâmetros de URI

Mesmos parâmetros de Buscar casos (v1) (businessUnitId, caseStatusNames, caseTypeNames, queueNames, contact, personRequesterName, personRequesterEasyId, currentAssigneeName, period, createdDateStart, createdDateEnd), exceto limit e offset, que não se aplicam.

Response

number

Exemplo

GET https://api.cvortex.com/v1/cases/count?businessUnitId=ced312a4-f320-4555-ab43-81a9ad77f80c&caseStatusNames=Aguardando%20Atendimento&caseStatusNames=Inicio&createdDateEnd=11%2F09%2F2023%2023%3A59&createdDateStart=01%2F01%2F2023%2000%3A00&period=BETWEEN
40324

Buscar Casos (v2)

Permite buscar casos utilizando filtros avançados definidos no corpo da requisição (payload). Esta versão oferece um modelo de filtragem mais flexível e estruturado que a v1.

Request

POST https://api.cvortex.com/v2/cases/search?limit=25&offset=1

Header: Authorization

Parâmetros de URI

Nome

Tipo

Descrição

Obrigatório

limit

number

Quantidade de registros por página. Valor máximo permitido: 25

Não

offset

number

Número de registros saltados no resultado da página

Não

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

caseDetailEntries

array

Filtros relacionados a detalhes do caso.

Não

caseEntries

array

Lista de filtros aplicados aos atributos do caso. Cada item contém fieldUUID, operator, values.

Não

startDate

string

Data de início do intervalo (timestamp em milissegundos).

Sim

endDate

string

Data final do intervalo (timestamp em milissegundos).

Sim

Estrutura de caseDetailEntries e caseEntries

Nome

Tipo

Descrição

Obrigatório

fieldUUID

string

Identificador do campo a ser filtrado

Sim

fieldLabel

string

Rótulo do campo opcional, usado apenas para legibilidade

Não

operator

string

Operador de comparação (ex: IN, EQUALS, etc.)

Sim

values

array

Lista de valores usados no filtro

Sim

Quando fieldLabel e fieldUUID aparecem juntos, fieldLabel é opcional e serve apenas para leitura humana do filtro quem filtra de fato é fieldUUID.

Exemplo de Payload

JSON
{
  "caseDetailEntries": [],
  "caseEntries": [
    {
      "fieldUUID": "businessUnit",
      "operator": "IN",
      "values": [
        "24d521b8-42d5-4b5e-92a2-586a5b30bafa",
        "f6f90642-0d77-4ab0-8af2-bd9dc281589b"
      ]
    },
    {
      "fieldLabel": "Queue Status",
      "fieldUUID": "queueStatus",
      "operator": "IN",
      "values": ["HANGUP", "ANSWERED"]
    },
    {
      "fieldLabel": "Closing Reason",
      "fieldUUID": "closingReason",
      "operator": "IN",
      "values": ["c45a2521-aab7-416c-aad0-96f4a8bf3f84"]
    }
  ],
  "endDate": "1747267199000",
  "startDate": "1746414000000"
}

(endDate* = 13 May 2025 23:59:00; startDate = 08 May 2025 00:00:00)*

Response

Código

Descrição

200

Operação realizada com sucesso

JSON
{
    "content": [
        {
            "Case Id": 10782,
            "Business Unit": "24d521b8-42d5-4b5e-92a2-586a5b30bafa",
            "Current Contact Id": "",
            "Case Type": "2c8f5ed0-efe7-418b-98d7-4a7e83071aab",
            "Updated by": "611a4b94-ac49-4210-8aa4-f51c49417078",
            "In Progress": false,
            "Initial Current Channel": "EMAIL",
            "Closed At": 1747247542278,
            "Queue Status Changed At": 1747247540426,
            "Started Progress At": 1747247496932,
            "Originally Created On": 1746478179000,
            "chatSessionClosed": false,
            "Progress Duration": 59853,
            "Last Action": "690b5c66-dd25-42c2-9fd8-c93528348496",
            "Deleted": false,
            "Created by": "default-user",
            "Queue": "96889d01-bdfe-444b-8c4a-66e5273e44c5",
            "_version": "9",
            "Case Status": "e2f97391-b9a1-4bb3-8a97-c8f1ca725b60",
            "Person Requester Id": "f7463572-8f48-46fa-b5fd-9f6d56bbe896",
            "Account ID": "5c1469ac-3cb3-48b4-a16c-5d41d7157e7c",
            "Comment": "Passou pela integração de busca de conteúdo",
            "Account Current Key ID": "32a462bf-b3d4-412e-b650-8e39e2b2f664",
            "Current Contact": "email@empresas.com",
            "Priority": "LOW",
            "Closing Reason": "c45a2521-aab7-416c-aad0-96f4a8bf3f84",
            "active": true,
            "Expired": false,
            "Account Channel ID": "5c1469ac-3cb3-48b4-a16c-5d41d7157e7c",
            "Updated at": 1747247542581,
            "Account Key ID": "32a462bf-b3d4-412e-b650-8e39e2b2f664",
            "Queue Status": "ANSWERED",
            "Current Service Id": "",
            "Subject": "teste",
            "Current Channel": "EMAIL",
            "Closed": true,
            "Assigned At": 1746624112363,
            "_id": "fa14a939-6f75-4d47-9693-f4badb0231a8",
            "Closed By": "611a4b94-ac49-4210-8aa4-f51c49417078",
            "External Id": "<CALq7f+D2jxsRShiiBQTfnEEFgyaJj6nqGVAro_O8juzznWzGHQ@mail.empresas.com>",
            "Created at": 1746478210844
        }
    ]
}

Contar casos (v2)

Permite contar casos através dos parâmetros usados como filtros.

Request

POST https://api.cvortex.com/v2/cases/search/count

Header: Authorization

Parâmetros de body

Mesma estrutura de Buscar Casos (v2): caseDetailEntries, caseEntries, startDate (obrigatório), endDate (obrigatório).

Exemplo de Payload

JSON
{
  "caseDetailEntries": [],
  "caseEntries": [
    {
      "fieldUUID": "businessUnit",
      "operator": "IN",
      "values": [
        "24d521b8-42d5-4b5e-92a2-586a5b30bafa",
        "f6f90642-0d77-4ab0-8af2-bd9dc281589b"
      ]
    },
    {
      "fieldLabel": "Queue Status",
      "fieldUUID": "queueStatus",
      "operator": "IN",
      "values": ["HANGUP", "ANSWERED"]
    },
    {
      "fieldLabel": "Closing Reason",
      "fieldUUID": "closingReason",
      "operator": "IN",
      "values": ["c45a2521-aab7-416c-aad0-96f4a8bf3f84"]
    }
  ],
  "endDate": "1747267199000",
  "startDate": "1746414000000"
}

Response

Código

Descrição

200

Operação realizada com sucesso

1525

Anexar arquivos ao Caso

Possibilita anexar arquivos ao caso, enviando no formato multipart file.

Request

POST https://api.cvortex.com/v1/case/{easyId}/attachment

Header: Authorization

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

easyId

ID correspondente ao caso

Sim

Body

Requisição do tipo form-data:

  • Content-Type: multipart/form-data

  • Parâmetro: files[] do tipo arquivo

Lista de arquivos suportados

Tipo do arquivo

content-type

PDF

application/pdf

DOC

application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document

TXT

text/plain

XLS

application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

MP4

video/mp4

AVI

video/x-msvideo

WMV

video/x-msvideo

MOV

video/quicktime

JPEG

image/jpeg

PNG

image/png

GIF

image/gif

BMP

image/bmp

WEBP

image/webp

Lista de erros possíveis

Erro

Descrição

Falha ao carregar arquivo

Houve uma falha ao carregar o arquivo enviado, tente novamente

Tamanho de arquivo não suportado

O tamanho limite de cada arquivo deve ser 16MB

Tipo de arquivo não suportado

O tipo de arquivo enviado não é suportado veja a tabela acima

Falha ao armazenar arquivo

Houve uma falha ao tentar armazenar o arquivo em nossa base, tente novamente

Falha ao anexar o arquivo ao caso

Houve uma falha ao tentar anexar o arquivo ao caso, tente novamente

Response

JSON
{
   "files": [
       {
           "id": "SUCCESS",
           "name": "test.txt",
           "status": "SUCCESS",
           "createdAt": "1707250657492",
           "createdBy": "f9dcd879-79b2-4a25-8f91-a72ec0951a50"
       },
       {
           "name": "main.py",
           "status": "ERROR",
           "message": "Tipo de arquivo não suportado"
       }
   ]
}