Default

Relatório de Atendimentos Digitais

post

API para listar os atendimentos digitais

  • filter (obrigatório) objeto com o filtro da consulta:

    • dateInitial (obrigatório) data inicial no formato DD/MM/YYYY.

    • dateFinal (obrigatório) data final no formato DD/MM/YYYY.

    • protocol (opcional) texto com o protocolo do atendimento.

    • sessionID (opcional) texto com a sessão do atendimento.

    • statusIDs (opcional) lista de valores numéricos

    • departmentIDs (opcional) lista de valores numéricos

    • userIDs (opcional) lista de valores numéricos

    • tagIDs (opcional) lista de valores numéricos

    • channelIDs (opcional) lista de valores numéricos

    • rates (opcional) lista de valores numéricos

    • sentiments (opcional) lista de valores numéricos

    • attendanceTime (opcional) objeto para selecionar os atendimentos pelo tempo de atendimento

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • waitingTime (opcional) objeto para selecionar os atendimentos pelo tempo de espera

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • firstAgentReply (opcional) objeto para selecionar os atendimentos pelo tempo da primeira resposta do agente

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • timeAgentClientReply (opcional) objeto para selecionar os atendimentos pelo tempo da resposta do agente para o cliente

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • timeClientAgentReply (opcional) objeto para selecionar os atendimentos pelo tempo da resposta do cliente para o agente

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • form (opcional) objeto para selecionar os atendimentos pelo formulário

      • key (obrigatório) texto com a chave do formulário

      • value (obrigatório) texto com o valor do formulário

    • additionalData (opcional) objeto para selecionar os atendimentos pelo formulário

      • ID (obrigatório) texto com o identificador da informação adicional

      • value (obrigatório) texto com o valor da informação adicional

  • page (obrigatório) valor numérico positivo (valores a partir de 0) que representa a página da consulta.

  • limit (opcional) valor numérico positivo (valores a partir de 1) que representa a quantidade de registros em cada consulta, caso não seja informa o valor default é 1000.

Body
objectOptional
Responses
200

Successful response

No content
post
POST /cc/listAttendancesReport HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 589

{
  "filter": {
    "additionalData": {
      "ID": "1",
      "value": "123"
    },
    "attendanceTime": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    },
    "channelIDs": [],
    "dateFinal": "30/01/2024",
    "dateInitial": "01/01/2024",
    "departmentIDs": [],
    "firstAgentReply": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    },
    "form": {
      "key": "",
      "value": "123"
    },
    "protocol": "",
    "rates": [],
    "sentiments": [],
    "sessionID": "",
    "statusIDs": [],
    "tagIDs": [],
    "timeAgentClientReply": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    },
    "timeClientAgentReply": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    },
    "userIDs": [],
    "waitingTime": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    }
  },
  "limit": 10,
  "page": 0
}
200

Successful response

No content

Lista Avaliações

post

O filtro deverá ser preechido por um intervalo de data ou número da sessão. Caso a sessão seja preechida o intervalo de data não será considerado mesmo se for preenchido.

Campos: Filtro: initialDate finalData chatbotTagIds sessionID

page limit

Body
objectOptional
Responses
200

Successful response

No content
post
POST /chatbot/listChatbotEventFeedbacksByFilter HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "filter": {
    "chatbotTagIds": [
      ""
    ],
    "finalDate": "21/05/2025",
    "initialDate": "15/05/2025",
    "sessionID": ""
  },
  "limit": 0,
  "page": 0
}
200

Successful response

No content

Relatório de Jornada detalhado

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /chatbot/listChatbotJourneyEventsDetailed HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "filter": {
    "chatbotID": "",
    "chatbotJourneyIDs": "",
    "dateFinal": "19/03/2025",
    "dateInitial": "01/03/2025"
  },
  "limit": 10,
  "page": 0
}
200

Successful response

No content

Relatório de Jornada Agrupado

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /chatbot/listChatbotJourneyEventsGrouped HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "filter": {
    "chatbotID": "",
    "chatbotJourneyIDs": "",
    "dateFinal": "19/03/2025",
    "dateInitial": "01/03/2025"
  }
}
200

Successful response

No content

Cria Atendimento Presencial

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /dl/pa/createPresentialAttendance HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 330

{
  "attendanceClassificationID": 1,
  "attendanceTypeID": [
    140
  ],
  "attendanceUnitID": 1,
  "companyID": 1,
  "contactFormFields": [
    {
      "contactFormKeyID": 19,
      "key": "EMAIL",
      "value": "[email protected]"
    },
    {
      "contactFormKeyID": 1,
      "key": "NOME",
      "value": "Severino Silva"
    },
    {
      "contactFormKeyID": 2,
      "key": "CPF_CNPJ",
      "value": "42052591079"
    }
  ],
  "contactFormID": 1,
  "userID": 1
}
200

Successful response

No content

Lista Categorias de Atendimento

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /dl/pa/listAttendanceTypeCategories HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "attendanceUnitID": 53
}
200

Successful response

No content

Lista Tipos de Atendimento

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /dl/pa/listAttendanceTypes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "attendanceTypeCategoryID": 11,
  "attendanceUnitID": 58
}
200

Successful response

No content

Lista Unidades de Atendimento por Usuário

post

Parâmetro opcional: isActive

  • isActive: 1 (ou não informado) – Retorna a lista de todas as unidades ativas associadas ao usuário.

  • isActive: 2 – Retorna a lista de todas as unidades inativas.

Observação: Para realizar essa requisição, é necessário utilizar uma API-KEY vinculada a um usuário autorizado.

Body
objectOptional
Responses
200

Successful response

No content
post
POST /dl/pa/listAttendanceUnitsByUser HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "companyID": 1,
  "isActive": 1
}
200

Successful response

No content

Lista Empresas por usuário

post

Parâmetro opcional: isActive

  • isActive: 1 (ou não informado) – Retorna a lista de todas as unidades ativas associadas ao usuário.

  • isActive: 2 – Retorna a lista de todas as unidades inativas.

Observação: Para realizar essa requisição, é necessário utilizar uma API-KEY vinculada a um usuário autorizado.

Body
objectOptional
Responses
200

Successful response

No content
post
POST /dl/pa/listCompaniesByUser HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "isActive": 1
}
200

Successful response

No content

Lista Campos do Formulário

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /dl/pa/listContactFormFields HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "attendanceTypeCategoryID": 11,
  "attendanceTypeIDs": [
    28
  ],
  "attendanceUnitID": 58
}
200

Successful response

No content

Busca por protocolo

post

body: { protocol: string (obrigatorio), platform: array de string (opcional, caso passe só será feita a busca nessas plataformas específicas, possíveis valores: digital-attendance, presential-attendance, ticket, mp }

Body
objectOptional
Responses
200

Successful response

No content
post
POST /global/searchProtocol HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "platform": [],
  "protocol": "20241106124207517"
}
200

Successful response

No content

Relatório de Campanhas

post

API para listar as informações das campanhas

  • filter (obrigatório) objeto com o filtro da consulta:

    • dateInitial (obrigatório) data inicial no formato DD/MM/YYYY.

    • dateFinal (obrigatório) data final no formato DD/MM/YYYY.

    • archived (opcional) valor numérico com o indicador se a campanha está arquivada ou não.

      • 1 - Sim

      • 2 - Não

    • departmentIDs (opicional) lista de valores numéricos

  • page (obrigatório) valor numérico positivo (valores a partir de 0) que representa a página da consulta.

  • limit (opcional) valor numérico positivo (valores a partir de 1) que representa a quantidade de registros em cada consulta, caso não seja informado o valor default é 100000.

Body
objectOptional
Responses
200

Successful response

No content
post
POST /mkt/listCampaignsReport HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "filter": {
    "archived": 2,
    "dateFinal": "30/01/2024",
    "dateInitial": "01/01/2024",
    "departmentIDs": []
  },
  "limit": 10,
  "page": 0
}
200

Successful response

No content

Relatório de Notificações Avulsas

post

StartFragmentfilter - Objeto que contém os filtros a serem passados. Campo obrigatório dateInitial - Data no formato DD/MM/YYYY. Campo obrigatório dateFinal - Data no formato DD/MM/YYYY. Campo obrigatório mktTemplateID - Ele espera um número, que seria o ID da template. Campo não obrigatório. service - Os possíveis valores são: 'sms', 'email' ou 'whatsapp'. Campo obrigatório page - Campo obrigatório. limit - Precisa ser maior que 0. Campo não obrigatório.EndFragment

Body
objectOptional
Responses
200

Successful response

No content
post
POST /mkt/listLooseNotificationsReport HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "filter": {
    "dateFinal": "01/05/2025",
    "dateInitial": "01/01/2021",
    "mktTemplateID": 1,
    "service": "whatsapp"
  },
  "limit": 10,
  "page": 0
}
200

Successful response

No content

Obter Sessão

post

Campos:

sessionID - Campo único e obrigatório

Body
objectOptional
Responses
200

Successful response

No content
post
POST /mp/getMessagingSession HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "sessionID": "6bb98847-5263-4388-bf9e-8f0d12b1790a"
}
200

Successful response

No content

Relatório de Sessões

post
Body
objectOptional
Responses
200

Successful response

No content
post
POST /mp/listMessagingSessions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 397

{
  "filter": {
    "channels": [
      "webchat",
      "whatsapp"
    ],
    "chatbotAdditionalDataID": "90a4ec7d-2522-4320-b287-66edde70ab91",
    "chatbotAdditionalDataQueryOperation": "contain",
    "chatbotAdditionalDataValue": "5518996315010",
    "chatbotTagIDs": [
      "be73803c-832a-46b3-ba67-f450e998a74c"
    ],
    "dateFinal": "19/03/2025 23:59",
    "dateInitial": "01/03/2025 00:00",
    "sessionID": "37f9b382-0c08-4fee-a00e-c541108e645b"
  },
  "limit": 500,
  "page": 0
}
200

Successful response

No content

Relatório de Atendimentos Presenciais

post

API para listar os atendimentos presenciais

  • filter (obrigatório) objeto com o filtro da consulta:

    • dateInitial (obrigatório) data inicial no formato DD/MM/YYYY.

    • dateFinal (obrigatório) data final no formato DD/MM/YYYY.

    • protocol (opcional) texto com o protocolo do atendimento.

    • attendanceCode (opcional) texto com a senha do atendimento.

    • companyIDs (opcional) lista de valores numéricos

    • attendanceUnitIDs (opcional) lista de valores numéricos

    • attendanceTypeIDs (opcional) lista de valores numéricos

    • statusIDs (opcional) lista de valores numéricos

    • userIDs (opcional) lista de valores numéricos

    • tagIDs (opcional) lista de valores numéricos

    • attendanceTime (opcional) objeto para selecionar os atendimentos pelo tempo de atendimento

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • waitingTime (opcional) objeto para selecionar os atendimentos pelo tempo de espera

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • pausedTime (opcional) objeto para selecionar os atendimentos pelo tempo da primeira resposta do agente

      • operation (obrigatório) valor numérico com a operação. 1 - Menor 2 - Menor ou igual 3 - Maior 4 - Maior ou igual 5 - Entre

      • value (obrigatório) valor numérico em minutos.

      • valueFinal (obrigatório quando o valor da operação for 5) valor numérico em minutos.

    • form (opcional) objeto para selecionar os atendimentos pelo formulário

      • key (obrigatório) texto com a chave do formulário

      • value (obrigatório) texto com o valor do formulário

    • additionalData (opcional) objeto para selecionar os atendimentos pelo formulário

      • ID (obrigatório) texto com o identificador da informação adicional

      • value (obrigatório) texto com o valor da informação adicional

  • page (obrigatório) valor numérico positivo (valores a partir de 0) que representa a página da consulta.

  • limit (opcional) valor numérico positivo (valores a partir de 1) que representa a quantidade de registros em cada consulta, caso não seja informado o valor default é 1000.

Body
objectOptional
Responses
200

Successful response

No content
post
POST /pa/listAttendancesReport HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 454

{
  "filter": {
    "additionalData": {
      "ID": "",
      "value": ""
    },
    "attendanceCode": "",
    "attendanceTime": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    },
    "attendanceTypeIDs": [],
    "attendanceUnitIDs": [],
    "companyIDs": [],
    "dateFinal": "30/01/2024",
    "dateInitial": "01/01/2024",
    "form": {
      "key": "",
      "value": ""
    },
    "pausedTime": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    },
    "protocol": "",
    "statusIDs": [],
    "tagIDs": [],
    "userIDs": [],
    "waitingTime": {
      "operation": 1,
      "value": 1,
      "valueFinal": 1
    }
  },
  "limit": 10,
  "page": 0
}
200

Successful response

No content

Relatório de Tickets

post

API para listar os tickets

  • filter (obrigatório) objeto com o filtro da consulta:

    • dateInitial (obrigatório) data inicial no formato DD/MM/YYYY.

    • dateFinal (obrigatório) data final no formato DD/MM/YYYY.

    • protocol (opcional) texto com o protocolo do atendimento.

    • statusIDs (opcional) lista de valores numéricos

    • organizationIDs (opcional) lista de valores numéricos

    • projectIDs (opcional) lista de valores numéricos

    • departmentIDs (opcional) lista de valores numéricos

    • userIDs (opcional) lista de valores numéricos

    • form (opcional) objeto para selecionar os atendimentos pelo formulário

      • key (obrigatório) texto com a chave do formulário

      • value (obrigatório) texto com o valor do formulário

  • page (obrigatório) valor numérico positivo (valores a partir de 0) que representa a página da consulta.

  • limit (opcional) valor numérico positivo (valores a partir de 1) que representa a quantidade de registros em cada consulta, caso não seja informado o valor default é 1000.

Body
objectOptional
Responses
200

Successful response

No content
post
POST /ticket/listTicketIssuesReport HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "filter": {
    "dateFinal": "30/01/2024",
    "dateInitial": "01/01/2024",
    "departmentIDs": [],
    "form": {
      "key": "",
      "value": ""
    },
    "organizationIDs": [],
    "projectIDs": [],
    "protocol": "",
    "statusIDs": [],
    "userIDs": []
  },
  "limit": 10,
  "page": 0
}
200

Successful response

No content
PreviousAPIsNextModels