Fluxos de Atendimento, Questionários e Workflows

Endpoints para consultar ações disponíveis em um fluxo de atendimento, executá-las sobre um caso, e consultar as respostas de questionários associadas.

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

Índice desta página

Buscar Ações por status e tipo do caso

Permite buscar ações, utilizando o status e o tipo do caso como parâmetros de busca.

Request

GET https://api.cvortex.com/v1/workflow-executions/actions/{statusId}/{caseTypeId}

Header: Authorization

Parâmetros de URI

Parâmetro	Descrição	Obrigatório
`statusId`	ID da `statusFunction`, correspondente à propriedade no flow `status_status_property`	Sim
`caseTypeId`	ID do tipo do caso, correspondente à propriedade no flow `imperative_start_case_type_property`	Sim

Response

JSON

[
  {
    "workflowId": "string",
    "actions": ["string"]
  }
]

Executar uma ação de um fluxo de atendimento

Permite executar uma ação de um fluxo de atendimento a partir de um caso.

Request

POST https://api.cvortex.com/v1/workflow-executions

Header: Authorization

Dica: com "F12" no navegador, pela tela de cadastro do formulário de ação, é possível copiar os valores que precisam ser enviados dentro do formRequestList.

Body

JSON

{
   "actionId": "ID Hash da ação a ser executada",
   "caseId": "ID Hash do caso",
   "caseTypeId": "ID Hash do tipo de caso do caso em questão",
   "statusFunctionId": "ID Hash do status de caso no fluxo",
   "formRequestList": [
      { "binding": "string", "value": "string" }
   ]
}

Response

JSON

{
   "workflowExecutionsRequest": "ID Hash da requisição WF criada"
}

Observações

A ação deve estar vinculada ao status do caso dentro do fluxo de atendimento no Workflow Studio.
A ação somente será executada se o caso estiver no status informado.

Transferir para Bot

Transfere o atendimento para um outro Bot cVortex.

Para que a execução seja feita com sucesso, o atendimento precisa garantir o seguinte estado:

ter um canal de chat ativo no caso;
não estar associado a nenhum agente;
estar aberto.

Se o atendimento não estiver conforme o esperado, a API retorna erro.

Request

POST https://api.cvortex.com/v1/wos/chatbot/start

Header: Authorization

Parâmetros de body

Nome	Tipo	Descrição	Obrigatório
`caseId`	string	ID Hash do atendimento que será transferido	Sim
`workflowId`	string	ID Hash do workflow de destino	Sim

Exemplo de request

JSON

{
  "caseId": "12341123412433124",
  "workflowId": "354353342434"
}

Buscar respostas de questionários por Caso e Ação

Recupera a lista de respostas de questionários de um determinado caso e ação.

Request

GET https://api.cvortex.com/v1/questionnaire/questionnaire-answer

Header: Authorization

Parâmetros de URI

Parâmetro	Descrição	Obrigatório
`case-id`	ID Hash correspondente ao caso	Sim
`action-id`	ID correspondente à ação do caso	Sim

Response

JSON

[
  {
    "id": "a9378ad3-8730-4800-852f-e96691508103",
    "name": "Teste Cosmos",
    "createdAt": 1706301660041,
    "questions": [
      {
        "id": "40a7e004-f9ea-4f90-8445-d0f89987dd15",
        "label": "Questão 1",
        "type": "DATE",
        "required": false,
        "answer": "1706301600000",
        "options": [],
        "answered": true
      },
      {
        "id": "b1f953cf-752b-4d5f-9d5d-8787bfb3c3c1",
        "label": "Questão 1",
        "type": "TEXT",
        "required": false,
        "answer": "abc",
        "options": [],
        "answered": true
      }
    ]
  }
]