Skip to main content
Skip table of contents

Gestão de Casos

Abertura e Consulta

Buscar formulário de caso por ID

Permite buscar o formulário de criação de caso pelo seu ID único.

Request

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

 

Header
CODE 
Authorization

 

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID do formulário caso

Sim

Response

JSON 
{
   "name":{
      "type":"string"
   },
   "description":{
      "type":"string"
   },
   "businessUnitId":{
      "type":"string"
   },
   "assignCaseToAgent":{
      "type":"boolean"
   },
   "createIDPrefixForManualCase":{
      "type":"boolean"
   },
   "identifierPrefix":{
      "type":"string"
   },
   "fields":[
      {
         "caseFormId":{
            "type":"string"
         },
         "entityUUID":{
            "type":"string"
         },
         "fieldUUID":{
            "type":"string"
         },
         "label":{
            "type":"string"
         },
         "removed":{
            "type":"boolean"
         },
         "required":{
            "type":"boolean"
         },
         "order":{
            "type":"integer",
            "format":"int64"
         },
         "fieldType":{
            "type":"string"
         },
         "defaultValue":{
            "type":"string"
         },
         "blocked":{
            "type":"boolean"
         },
         "hidden":{
            "type":"boolean"
         }
      }
   ]
}

Criar caso por formulário (v1)

Permite criar um caso a partir do formulário.

Request

CODE 
POST https://api.cvortex.com/v1/case/forms/{id}

 

Header
CODE 
Authorization

 

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID do formulário caso

Sim

Observações.:

  • Os campos personRequesterFullName, personRequesterEmail e personRequesterDocument da request devem ser enviados quando o campo personRequesterId não estiver presente na lista de dynmicFields, ou seja, se você ainda não tem o cliente identificado no momento de criação do caso utilize o campo personRequesterFullName e uma nova pessoa será criada junto ao caso, agora se você já conhece o cliente no momento de criação do caso utilize o _id da própria pessoa dentro do campo personRequesterId.

  • O campo priority que deve ser enviado na lista de dynamicFields, caso não tenha um valor padrão configurado no cadastro de formulário de casos, tem três valores possíveis: LOW, MEDIUM e HIGH.

  • Para a correta criação do caso, os campos configurados no formulário não podem ser marcados com o parâmetro ‘Ocultar campo no formulário’.

 

Body
JSON 
{
   "personRequesterFullName":{
      "type":"string"
   },
   "personRequesterEmail":{
      "type":"string"
   },
   "personRequesterDocument":{
      "type":"string"
   },
   "dynamicFields":[
      {
         "entityUUID":{
            "type":"string"
         },
         "fieldUUID":{
            "type":"string"
         },
         "value":{
            "type":"string"
         }
      }
   ]
}

 

Response

CODE 
{
   "id":{
      "type":"string"
   },
   "caseId":{
      "type":"string"
   }
}

 

Exemplo de utilização criando uma nova pessoa a cada requisição
JSON 
{
   "personRequesterFullName":"nome do cliente",
   "personRequesterDocument":"documento do cliente",
   "personRequesterEmail":"email do cliente",
   "dynamicFields":[
      {
         "entityUUID":"case",
         "fieldUUID":"subject",
         "value":"comentário desejado"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"caseType",
         "value":"_id do registro CaseType"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"caseStatus",
         "value":"_id do registro CaseStatus"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"priority",
         "value":"LOW ou MEDIUM ou HIGH"
      },
      {
         "entityUUID":"_id de Case Detail",
         "fieldUUID":"_id do Atributo de Case Detail",
         "value":"Valor desejado para o campo"
      }
   ]
}

 

Exemplo de utilização com uma pessoa já existente
JSON 
{
   "dynamicFields":[
      {
         "entityUUID":"case",
         "fieldUUID":"subject",
         "value":"comentário desejado"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"caseType",
         "value":"_id do registro CaseType"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"caseStatus",
         "value":"_id do registro CaseStatus"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"priority",
         "value":"LOW ou MEDIUM ou HIGH"
      },
      {
         "entityUUID":"case",
         "fieldUUID":"personRequesterId",
         "value":"_id do registro Person"
      },
      {
         "entityUUID":"_id de Case Detail",
         "fieldUUID":"_id do Atributo de Case Detail",
         "value":"Valor desejado para o campo"
      }
   ]
}

Criar caso por formulário (v2)

Cria um novo caso com base em um formulário pré-configurado, permitindo a criação ou associação de uma pessoa e o preenchimento de campos dinâmicos (do caso e dos detalhes do caso).

 

Request

CODE 
POST https://api.cvortex.io/v2/case/forms/{formId}

 

Header
CODE 
Authorization

 

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

personRequest

object

Dados da pessoa associada ao caso

Sim

└─ fullName

string

Nome completo da pessoa

Sim

└─ document

string

Documento da pessoa (ex: CPF)

Sim

└─ email

string

Email principal

Não

└─ contacts

array

Lista de contatos (telefone, e-mail, etc)

Não

caseAndDetailFields

array

Lista de campos a serem preenchidos no caso (entidade case)

Sim

└─ entityUUID

string

Deve ser "case"

Sim

└─ fields

array

Lista de campos contendo fieldUUID e value

Sim

Estrutura dos campos (caseAndDetailFields[].fields)

Nome

Tipo

Descrição

Obrigatório

fieldUUID

string

UUID do campo a ser preenchido

Sim

value

string

Valor atribuído ao campo

Sim

entityUUID

string

Identificador da entidade (ex: case)

Sim

Exemplo de Payload
JSON 
{
  "personRequest": {
    "contacts": [
      {
        "channelType": "VOICE",
        "contactType": "MOBILE_PHONE",
        "value": "3123456789"
      },
      {
        "channelType": "VOICE",
        "contactType": "LANDLINE_PHONE",
        "value": "3123456789"
      },
      {
        "channelType": "EMAIL",
        "contactType": "EMAIL",
        "value": "marlene_baptista@empresa.net"
      }
    ],
    "document": "000.000.000-00",
    "email": "elias-martins@empresa.org",
    "fullName": "Elias Theo Bento Martins"
  },
  "caseAndDetailFields": [
    {
      "entityUUID": "case",
      "fields": [
        {
            "entityUUID":"case",
            "fieldUUID":"subject",
            "value":"Caso manual criado via API"
        },
        {
            "entityUUID":"case",
            "fieldUUID":"caseType",
            "value":"d2af060c-7251-41cd-aee3-9fda35d14c7c"
        },
        {
            "entityUUID":"case",
            "fieldUUID":"caseStatus",
            "value":"c3003f97-f701-40fa-9792-8fc4dbec42c6"
        },
        {
            "entityUUID":"case",
            "fieldUUID":"priority",
            "value":"LOW"
        }
      ]
    }
  ]
}

 

Response

CODE

Descrição

200

Operação realizada com sucesso

 

Exemplo de Response
JSON 
{
  "caseId": 10880
}

Buscar caso por ID

Permite buscar um caso pelo seu ID único.

Request

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

 

Header
CODE 
Authorization

 

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID único do caso

Sim

 

Response

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

Buscar caso por case ID

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

Request

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

 

Header
CODE 
Authorization

 

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

id

ID de negócio do caso

Sim

 

Response

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

Buscar casos (v1)

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

Request

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

 

Header
CODE 
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. Os possíveis valores são: TODAY, YESTERDAY, SEVEN_DAYS, FIFTEEN_DAYS, THIRTY_DAYS e BETWEEN.

Sim

createdDateStart

string

Data de início da criação dos casos, usada no filtro de período. É obrigatório somente quando o campo period é igual a BETWEEN. Possíveis formatos: 

  • dd/mm/aaaa hh:mm tenant pt_BR 

  • mm/dd/aaaa hh:mm tenant en_US

Não

createdDateEnd

string

Data final da criação dos casos, usada no filtro de período. É obrigatório somente quando o campo period é igual a BETWEEN. Possíveis formatos: 

  • dd/mm/aaaa hh:mm tenant pt_BR 

  • mm/dd/aaaa hh:mm tenant en_US

 

Não

limit

number

Quantidade de registro por página. O valor máximo permitido é 25.

Não

offset

number

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

Não

 

Response

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

 

Exemplo
CODE 
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": "Maria da Silva Souza",
    "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"
  }
]

Buscar Casos v2

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

Request

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

 

Header
CODE 
Authorization

 

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 para legibilidade)

🚫 Não

operator

string

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

Sim

values

array

Lista de valores usados no filtro

Sim

Nota:
Se fieldLabel e fieldUUID aparecem juntos, explique que fieldLabel é opcional e apenas informativo.

 

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",  //  13 May 2025 23:59:00
  "startDate": "1746414000000" //  08 May 2025 00:00:00
}

 

Response

CODE

Descrição

200

Operação realizada com sucesso

Exemplo de Response
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": "weverton@empresa.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.gmail.com>",
            "Created at": 1746478210844
        }
    ]
}

Contar casos

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

Request

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

 

Header
CODE 
Authorization

 

Parâmetros de URI

Nome

Tipo

Descrição

Obrigatório

businessUnitId

hash

Unidade de negócio

Sim

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. Os possíveis valores são: TODAY, YESTERDAY, SEVEN_DAYS, FIFTEEN_DAYS, THIRTY_DAYS e BETWEEN.

Sim

createdDateStart

string

Data de início da criação dos casos, usada no filtro de período. É obrigatório somente quando o campo period é igual a BETWEEN. Possíveis formatos: 

  • dd/mm/aaaa hh:mm tenant pt_BR 

  • mm/dd/aaaa hh:mm tenant en_US

Não

createdDateEnd

string

Data final da criação dos casos, usada no filtro de período. É obrigatório somente quando o campo period é igual a BETWEEN. Possíveis formatos: 

  • dd/mm/aaaa hh:mm tenant pt_BR 

  • mm/dd/aaaa hh:mm tenant en_US

 

Não

Response

CODE 
number

Exemplo
CODE 
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
CODE 
40324

Ações e Atualizações

Atualizar dados de um atendimento aberto

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

Request

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

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

Titulo do atendimento

Não

Comment

string

Comentário adicionado ao atendimento

Não

Exemplo de request
CODE 
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": "agente_api7@hotmail.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

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

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

Subject

string

ID Hash do tipo de atendimento

Não

Description

string

ID Hash da unidade de negócio

Não

Comment

string

Versão do documento

Não

externalId

string

Prioridade dada ao atendimento

Não

Exemplo de request
CODE 
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"
}

Atualizar Status do Caso

Permite atualizar o status de um caso.

Request

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

 

Header
CODE 
Authorization

 

Parâmetros de body

Nome

Tipo

Descrição

Obrigatório

caseStatus

hash

Novo status do caso

Sim

filter

objeto

Filtro para selecionar casos (detalhes abaixo)

Não

sortFields

lista

Campos para ordenação dos resultados (usado com filtro, limite de 1000)

Não

Response

CODE

Descrição

200

Operação realizada com sucesso

 

Exemplo de request
CODE 
https://api.cvortex.com/v1/case/change-status\
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 request
CODE 
https://api.cvortex.com/v1/case/change-status
JSON 
{
  "operation": "BULK_CHANGE_STATUS"
}

Alterar Pessoa de um Caso

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

Request

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

 

Header
CODE 
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
JSON 
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

Alterar unidade de negócio de um caso

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

Request

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

 

Header
CODE 
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

CODE

Descrição

200

Operação realizada com sucesso

 

Exemplo de request
CODE 
https://api.cvortex.com/v1/cases/update-business-unit
JSON 
{
  "caseId": "123",
  "caseType": "123",
  "caseStatus": "123",
  "businessUnit": "123",
  "caseOrigin": "123",
  "closingReason": "123",
  "openingReason": "123"
}
Exemplo de resposta
CODE 
https://api.cvortex.com/v1/cases/update-business-unit
JSON 
{
  "id": "123123",
  "deleted": false,
  "createdAt": 1658928025873,
  "updatedAt": 1658928025873,
  "active": true,
  "createdBy": "default-user",
  "updatedBy": "default-user",
  "version": "5",
  "tenantId": "123"
}

Reabrir um atendimento

É possível reabrir atendimentos diretamente via API, garantindo que nenhum atendimento fique sem o acompanhamento necessário.

Request

CODE 
POST https://api.cvortex.com/v1/case/reopen
Parâmetros de Body

Nome

Tipo

Descrição

Obrigatório

caseId

string

ID Hash do caso

Não (OU o campo caseID deve ser informado ou o campo easyId deve ser informado

easyId

string

ID simplificado do caso

Não (OU o campo caseID deve ser informado ou o campo easyId deve ser informado

statusToReopenCase

string

ID Hash da Status Inicial do Caso

Sim

Exemplos de request
CODE 
POST https://api.cvortex.com/v1/case/reopen
JSON 
{
  "easyId": 3258,
  "statusToReopenCase": "f6438d40-a58e-4338-95a8-d30ee5e9a7b8"
}

Response

CODE 
204 No Content

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

CODE 
PUT https://api.cvortex.com/v1/case/{id}/reclassify

 

Header
CODE 
Authorization

 

Body
CODE 
{
  "easyId": 10887
}

Campo

Tipo

Descrição

Obrigatório

easyId

int

Identificador numérico do caso (caseId)

Sim

 

Response

CODE 
204 No Content

  • A reclassificação foi executada com sucesso.

  • Nenhuma informação adicional é retornada no corpo da resposta.

Anexar arquivos ao Caso

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

Request

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

 

Header
CODE 
Authorization

 

Parâmetros de URI

Parâmetro

Descrição

Obrigatório

case-id

ID correspondente ao caso

Sim

 

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, segue abaixo tabela de tipos aceitos

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

 

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


Body
CODE 
Requisição do tipo: form-data
Content-Type: multipart/form-data;
Parâmetro: files[] do tipo arquivo

 

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"
       }
   ]
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close