Tatodesk API

Consumo de APIs da tatodesk.

Clique em um tópico abaixo para acessar diretamente a documentação detalhada de cada item:

Atendimento Presencial:

• Lista Empresas por usuário;

• Lista Unidades de Atendimento por Usuário;

• Lista Classificações de Atendimento;

• Lista Categorias de Atendimento;

• Lista Tipos de Atendimento;

• Lista Campos do Formulário;

• Cria Atendimento Presencial;

• Listar Empresas do Link Personalizado;

• Listar Categorias para Agendamento;

• Listar Categorias do Link Personalizado;

• Listar Tipos de Atendimento para Agendamento;

• Listar Regiões para Agendamento;

• Listar Unidades de Atendimento para Agendamento;

• Listar Datas para Agendamento;

• Listar Períodos para Agendamento;

• Listas Horários para Agendamento;

• Criar Agendamento;

• Consultar Agendamento;

• Obter Atendimento Presencial;

• Adicionar Anexos;

Marketing:

• Enviar Notificação via E-mail;

WhatsApp:

• Adicionar Anexos;

• Envia Notificação via WhatsApp;

• Envia Notificação via WhatsApp - Usando Upload de Mídia;

SMS:

• Envia notificação via SMS;

Data API:

• Relatório de Atendimentos Digitais;

• Relatório de Campanhas;

• Relatório de Atendimentos Presenciais;

• Relatório de Tickets;

• Busca por Protocolo;

• Relatório de Sessões;

• Relatório de Jornada Agrupado;

• Relatório de Jornada detalhado;

• Relatório de Notificações Avulsas;

• Obter Sessão;

• Lista Avaliações;

CRM:

• Lista Objetos;

• Cria Objeto;

• Edita Objeto;

• Deleta Objeto;

Contact Center:

• Listar Departamentos;

• Listar Grupo de Atendimentos;

• Listar Especialidades;

• Listar Subspecialidades;

• Listar Áreas;

• Listar Subáreas;

• Listar Horários de Atendimento;

• Listar Exceções do Horário de Atendimento;

Pulse:

• Criar Sessão de Aplicativo;

• Registrar Evento;

• Listar Jornadas;

• Obter Formulário;

• Registrar Respostas de Formulário.

Atendimento Presencial

Post Listar empresas por usuário

https://api.tatodesk.com/dl/pa/listCompaniesByUser

É necessário utilizar uma API-KEY vinculada a um usuário autorizado para realizar a requisição.

Exemplo de Request

curl --location 'https://api.tatodesk.com/dl/pa/listCompaniesByUser' \
--data '{
    "isActive": 1
}'

Exemplo de Response

{
  "companies": [
    {
      "ID": 1,
      "name": "Tatodesk",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2022-01-28T13:33:20.264Z",
      "updatedAt": "2022-06-20T17:36:35.945Z"
    },
    {
      "ID": 13,
      "name": "Tatodesk 2",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2022-11-17T18:28:07.607Z",
      "updatedAt": "2022-11-17T18:28:07.608Z"
    },
    {
      "ID": 41,
      "name": "TechSoluções",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:00.238Z",
      "updatedAt": "2024-01-03T14:11:00.238Z"
    }
  ],
  "error": null
}

Post Lista Unidades de Atendimento por Usuário

https://api.tatodesk.com/dl/pa/listAttendanceUnitsByUser

É necessário utilizar uma API-KEY vinculada a um usuário autorizado para realizar a requisição.

Exemplo de Request

curl --location 'https://api.tatodesk.com/dl/pa/listAttendanceUnitsByUser' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "companyID": 1,
    "isActive": 1
}'

Exemplo de Response

{
  "attendanceUnits": [
    {
      "ID": 1,
      "name": "Unidade Recife Antigo",
      "address": "Rua Marquês de Olinda, 123",
      "companyID": 1,
      "companyName": "Tatodesk"
    },
    {
      "ID": 83,
      "name": "Unidade Central",
      "address": null,
      "companyID": 1,
      "companyName": "Tatodesk"
    },
    {
      "ID": 36,
      "name": "Unidade Madalena",
      "address": "Rua Madalena, 223",
      "companyID": 1,
      "companyName": "Tatodesk"
    },
    {
      "ID": 288,
      "name": "Unidade Central Limoeiro",
      "address": "Rua C Bairro João Ernesto",
      "companyID": 1,
      "companyName": "Tatodesk"
    }
  ],
  "error": null
}

Post Lista Classificações de Atendimento

https://api.tatodesk.com/dl/pa/listAttendanceClassifications

Exemplo de Request

curl --location --request POST 'https://api.tatodesk.com/dl/pa/listAttendanceClassifications' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data ''

Exemplo de Response

{
  "attendanceClassifications": [
    {
      "ID": 1,
      "name": "Comum",
      "accountID": 1,
      "isActive": 1,
      "isDeleted": 2,
      "abbreviation": "CM",
      "isHighPriority": 2,
      "createdAt": "2022-01-28T17:17:48.016Z",
      "updatedAt": "2022-07-21T14:34:43.757Z"
    },
    {
      "ID": 4,
      "name": "Gestante",
      "accountID": 1,
      "isActive": 1,
      "isDeleted": 2,
      "abbreviation": "G",
      "isHighPriority": 2,
      "createdAt": "2022-02-17T19:16:54.135Z",
      "updatedAt": "2024-01-12T13:21:57.998Z"
    },
    {
      "ID": 2,
      "name": "Preferencial",
      "accountID": 1,
      "isActive": 1,
      "isDeleted": 2,
      "abbreviation": "PRL",
      "isHighPriority": 2,
      "createdAt": "2022-01-28T17:17:59.806Z",
      "updatedAt": "2022-01-28T17:17:59.806Z"
    }
  ],
  "error": null
}

Post Lista Categorias de Atendimento

https://api.tatodesk.com/dl/pa/listAttendanceTypeCategories

Exemplo de Request

curl --location 'https://api.tatodesk.com/dl/pa/listAttendanceTypeCategories' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceUnitID": 53
}'

Exemplo de Response

{
  "attendanceTypeCategories": [
    {
      "ID": 11,
      "name": "2ª Via",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 22,
      "name": "Aferição",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 25,
      "name": "Atualização Cadastral",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 18,
      "name": "Cavalete",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 21,
      "name": "Corte a Pedido do Cliente",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 48,
      "name": "Falta de abastecimento",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 1
    },
    {
      "ID": 34,
      "name": "Fiscalização de Ligação",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 1
    },
    {
      "ID": 14,
      "name": "Ligação Nova de Água/Esgoto",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 28,
      "name": "Medição de Pressão",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 49,
      "name": "Micromedição ",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 1
    },
    {
      "ID": 19,
      "name": "Outros",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 31,
      "name": "Parcelamento",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 26,
      "name": "Refaturamento",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 33,
      "name": "Religação",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 1
    },
    {
      "ID": 20,
      "name": "Remanejamento de cavalete",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 24,
      "name": "Revisão Cadastral",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 29,
      "name": "Substituição de Hidrômetro",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 30,
      "name": "Tarifa Social",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 16,
      "name": "Troca de Titularidade",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    },
    {
      "ID": 17,
      "name": "Vazamentos",
      "isActive": 1,
      "isDeleted": 2,
      "accountID": 58,
      "contactFormID": 19,
      "allowSchedule": 2
    }
  ],
  "error": null
}

Post Lista Tipos de Atendimento

https://api.tatodesk.com/dl/pa/listAttendanceTypes

Exemplo de Request

curl --location 'https://api.tatodesk.com/dl/pa/listAttendanceTypes' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceUnitID": 58,
    "attendanceTypeCategoryID": 11
}'

Exemplo de Response

{
  "attendanceTypes": [
    {
      "ID": 28,
      "name": "Emissão 2ª via"
    }
  ],
  "error": null
}

Post Lista Campos do Formulário

https://api.tatodesk.com/dl/pa/listContactFormFields

Exemplo de Request

curl --location 'https://api.tatodesk.com/dl/pa/listContactFormFields' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceTypeCategoryID":11,
    "attendanceTypeIDs": [28],
    "attendanceUnitID": 58
}'

Exemplo de Response

{
  "contactFormFields": [
    {
      "ID": 115,
      "contactFormID": 19,
      "contactFormKeyID": 22,
      "contactFormKeyName": "NOME",
      "key": "Nome",
      "keyTypeID": 1,
      "isRequired": 1,
      "isActive": 1,
      "sort": 1
    },
    {
      "ID": 114,
      "contactFormID": 19,
      "contactFormKeyID": 24,
      "contactFormKeyName": "TELEFONE",
      "key": "Tel",
      "keyTypeID": 5,
      "isRequired": 1,
      "isActive": 1,
      "sort": 2
    }
  ],
  "error": null
}

Post Cria Atendimento Presencial

https://api.tatodesk.com/dl/pa/createPresentialAttendance

Exemplo de Request

curl --location 'https://api.tatodesk.com/dl/pa/createPresentialAttendance' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data-raw '{
    "attendanceClassificationID": 1,
    "companyID": 1,
    "attendanceUnitID": 1,
    "attendanceTypeID": [140],
    "contactFormFields": [
        {
            "contactFormKeyID": 19,
            "key": "EMAIL",
            "value": "[email protected]"
        },
        {
            "contactFormKeyID": 1,
            "key": "NOME",
            "value": "Severino Silva"
        },
        {
            "contactFormKeyID": 2,
            "key": "CPF_CNPJ",
            "value": "42052591079"
        }
    ],
    "userID": 1,
    "contactFormID": 1
}'

Exemplo de Response

{
  "attendance": {
    "ID": 1783056,
    "protocol": "20250408093423710",
    "date": "2025-04-08T12:34:23.705Z",
    "attendanceClassificationID": 1,
    "sequence": 2,
    "companyID": 1,
    "attendanceUnitID": 1,
    "statusID": 2,
    "sequential": null,
    "ticketWindowPeriodID": null,
    "createdAt": "2025-04-08T12:34:23.705Z",
    "updatedAt": "2025-04-08T12:34:23.705Z",
    "accountID": 1,
    "userID": null,
    "allowServiceDelay": 2,
    "reasonCancellationID": null,
    "presentialAttendancePipelineID": null,
    "pipelineStep": null,
    "attendanceTime": null,
    "waitingTime": null,
    "lastTimeWaiting": "2025-04-08T12:34:23.705Z",
    "lastTimeStarted": null,
    "attendanceCode": "CM2",
    "expiredAt": null,
    "reasonBreakAttendanceID": null,
    "displacementTime": null,
    "pausedTime": null,
    "nps": null,
    "npsObservation": null,
    "remoteAttendance": null,
    "ticketWindowType": null
  },
  "attendanceLinks": {
    "rateLink": "https://arate.tatodesk.com/fb?p=20250408093423710&plt=pa&a=1",
    "documentSubmissionLinks": [
      {
        "name": "Atendimento VIP em Lojas de Moda",
        "formName": "formulario sergio",
        "link": "https://attendance-document.tatodesk.com/ds?p=20250408093423710&plt=presential-attendance&atdfid=2d7784e8-2a5f-4116-9df5-f4d551882905"
      }
    ]
  },
  "error": null
}

Post Listar Empresas do Link Personalizado

https://api.tatodesk.com/pa/listCustomCompanies

Exemplo de Request

curl --location 'https://api.tatodesk.com/pa/listCustomCompanies' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "token": "{{token}}"
}
'

Exemplo de Response

{
  "companies": [
    {
      "ID": 1,
      "name": "Tatodesk",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2022-01-28T13:33:20.264Z",
      "updatedAt": "2022-06-20T17:36:35.945Z"
    },
    {
      "ID": 13,
      "name": "Tatodesk 2",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2022-11-17T18:28:07.607Z",
      "updatedAt": "2022-11-17T18:28:07.608Z"
    },
    {
      "ID": 41,
      "name": "TechSoluções",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:00.238Z",
      "updatedAt": "2024-01-03T14:11:00.238Z"
    },
    {
      "ID": 42,
      "name": "EcoVida Energia Sustentável",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:38.609Z",
      "updatedAt": "2024-01-03T14:11:38.609Z"
    },
    {
      "ID": 43,
      "name": "FashionTrends\t",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:47.727Z",
      "updatedAt": "2024-01-03T14:11:47.727Z"
    },
    {
      "ID": 44,
      "name": "BioPharma Solutions",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:59.119Z",
      "updatedAt": "2024-01-03T14:11:59.119Z"
    },
    {
      "ID": 45,
      "name": "SkyConnect Telecom",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:09.873Z",
      "updatedAt": "2024-01-03T14:12:09.873Z"
    },
    {
      "ID": 46,
      "name": "GreenHarvest Organic Foods",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:22.889Z",
      "updatedAt": "2024-01-03T14:12:22.889Z"
    },
    {
      "ID": 47,
      "name": "InovaTech Consultoria",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:32.785Z",
      "updatedAt": "2024-01-03T14:12:32.785Z"
    },
    {
      "ID": 48,
      "name": "RoboGenius Automatio",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:44.758Z",
      "updatedAt": "2025-06-13T13:52:27.540Z"
    }
  ],
  "error": null
}

Post Listar Categorias para Agendamento

https://api.tatodesk.com/pa/listAttendanceTypeCategoriesForAppointment

Descrição: Retorna todas as categorias de atendimento disponíveis para agendamento em uma empresa específica.

Exemplo de Request

curl --location 'https://api.tatodesk.com/pa/listAttendanceTypeCategoriesForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "companyID": 1
}
'

Exemplo de Response

{
  "attendanceTypeCategories": [
    {
      "ID": 1,
      "name": "Negociação de Débitos",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2022-01-28T17:16:52.497Z",
      "updatedAt": "2022-06-22T19:26:12.152Z",
      "accountID": 1,
      "contactFormID": 2,
      "companyID": 1
    },
    {
      "ID": 2,
      "name": "Registrar denúncia",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2022-01-28T17:09:42.696Z",
      "updatedAt": "2024-05-21T18:47:24.065Z",
      "accountID": 1,
      "contactFormID": 30,
      "companyID": 1
    },
    {
      "ID": 8,
      "name": "Outros",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2022-04-01T14:21:44.664Z",
      "updatedAt": "2024-05-21T18:55:27.159Z",
      "accountID": 1,
      "contactFormID": 34,
      "companyID": 1
    },
    {
      "ID": 74,
      "name": "Suporte Técnico",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2024-01-03T18:55:09.495Z",
      "updatedAt": "2024-01-03T18:55:09.495Z",
      "accountID": 1,
      "contactFormID": 30,
      "companyID": 1
    },
    {
      "ID": 75,
      "name": "Desenvolvimento de Software",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2024-01-03T18:55:29.979Z",
      "updatedAt": "2024-01-03T18:55:29.979Z",
      "accountID": 1,
      "contactFormID": 30,
      "companyID": 1
    },
    {
      "ID": 76,
      "name": "Consultoria em TI",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2024-01-03T18:59:56.745Z",
      "updatedAt": "2024-01-03T18:59:56.745Z",
      "accountID": 1,
      "contactFormID": 30,
      "companyID": 1
    },
    {
      "ID": 83,
      "name": "Desenvolvimento de Medicamentos",
      "isActive": 1,
      "isDeleted": 2,
      "allowSchedule": 1,
      "createdAt": "2024-01-03T19:02:04.101Z",
      "updatedAt": "2024-01-03T19:02:04.101Z",
      "accountID": 1,
      "contactFormID": 31,
      "companyID": 1
    }
  ],
  "error": null
}

Post Listar Categorias do Link Personalizado

https://api.tatodesk.com/pa/listCustomAttendanceTypeCategories

Descrição: Retorna as categorias associadas a um link personalizado de agendamento, identificado por um token.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/listCustomAttendanceTypeCategories' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "token": "{{token}}"
}
'

Exemplo de Response:

{
  "companies": [
    {
      "ID": 1,
      "name": "Tatodesk",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2022-01-28T13:33:20.264Z",
      "updatedAt": "2022-06-20T17:36:35.945Z"
    },
    {
      "ID": 13,
      "name": "Tatodesk 2",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2022-11-17T18:28:07.607Z",
      "updatedAt": "2022-11-17T18:28:07.608Z"
    },
    {
      "ID": 41,
      "name": "TechSoluções",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:00.238Z",
      "updatedAt": "2024-01-03T14:11:00.238Z"
    },
    {
      "ID": 42,
      "name": "EcoVida Energia Sustentável",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:38.609Z",
      "updatedAt": "2024-01-03T14:11:38.609Z"
    },
    {
      "ID": 43,
      "name": "FashionTrends\t",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:47.727Z",
      "updatedAt": "2024-01-03T14:11:47.727Z"
    },
    {
      "ID": 44,
      "name": "BioPharma Solutions",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:11:59.119Z",
      "updatedAt": "2024-01-03T14:11:59.119Z"
    },
    {
      "ID": 45,
      "name": "SkyConnect Telecom",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:09.873Z",
      "updatedAt": "2024-01-03T14:12:09.873Z"
    },
    {
      "ID": 46,
      "name": "GreenHarvest Organic Foods",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:22.889Z",
      "updatedAt": "2024-01-03T14:12:22.889Z"
    },
    {
      "ID": 47,
      "name": "InovaTech Consultoria",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:32.785Z",
      "updatedAt": "2024-01-03T14:12:32.785Z"
    },
    {
      "ID": 48,
      "name": "RoboGenius Automatio",
      "accountID": 1,
      "isActive": 1,
      "isDelete": 2,
      "createdAt": "2024-01-03T14:12:44.758Z",
      "updatedAt": "2025-06-13T13:52:27.540Z"
    }
  ],
  "error": null
}

Post Listar Tipos de Atendimento para Agendamento

https://api.tatodesk.com/pa/listAttendanceTypesForAppointment

Descrição: Retorna os tipos de atendimento disponíveis dentro de uma categoria específica, utilizada na etapa seguinte do agendamento.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/listAttendanceTypesForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "categoryID": 1
}
'

Exemplo de Response:

{
  "attendanceTypes": [
    {
      "ID": 1,
      "name": "Parcelamento de Dívidas",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2022-01-28T17:17:29.254Z",
      "updatedAt": "2023-12-20T17:05:55.953Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 2,
      "documentGroupID": 5,
      "allowSchedule": 1,
      "color": "#af2c86",
      "price": "1.200.011.111,11",
      "limitDatesGenerateGrid": 7,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 27,
      "name": "Parcelamento de Dívidas acima de mil reais",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2022-06-28T13:45:13.200Z",
      "updatedAt": "2023-11-16T20:01:52.482Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 1,
      "documentGroupID": 5,
      "allowSchedule": 1,
      "color": "#efafaf",
      "price": "$111,111,111,111.00",
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 145,
      "name": "adauto teste",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2024-01-23T20:02:01.937Z",
      "updatedAt": "2025-05-06T12:16:30.745Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": null,
      "documentGroupID": null,
      "allowSchedule": 1,
      "color": "#38ba36",
      "price": "0,00",
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": "8dac9611-eea7-4507-bb82-e046ebbec1e0"
    },
    {
      "ID": 149,
      "name": "teste adauto tipo atendimento",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2024-02-28T19:17:21.469Z",
      "updatedAt": "2024-02-28T19:17:21.469Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 1,
      "documentGroupID": 5,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 150,
      "name": "Teste adauto 0703",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2024-03-07T19:22:53.565Z",
      "updatedAt": "2024-03-07T19:22:53.565Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": null,
      "documentGroupID": null,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 173,
      "name": "Atendimento Especializado",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2024-11-21T17:40:59.129Z",
      "updatedAt": "2024-11-21T17:43:24.072Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 30,
      "documentGroupID": 9,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 180,
      "name": "Teste adauto 040225",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2025-02-04T19:51:12.014Z",
      "updatedAt": "2025-02-04T19:51:12.014Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 31,
      "documentGroupID": 5,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 183,
      "name": "teste sergio 4",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2025-03-19T22:08:47.860Z",
      "updatedAt": "2025-03-19T22:08:47.860Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 42,
      "documentGroupID": 5,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 184,
      "name": "TESTE FORM ID",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2025-03-19T22:11:42.467Z",
      "updatedAt": "2025-03-19T22:11:42.467Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": 31,
      "documentGroupID": 5,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 185,
      "name": "teste create com dados adicionais sergio",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2025-03-26T02:01:01.979Z",
      "updatedAt": "2025-03-26T02:08:14.310Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": null,
      "documentGroupID": null,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    },
    {
      "ID": 188,
      "name": "criando sem info adicional",
      "isActive": 1,
      "isDeleted": 2,
      "createdAt": "2025-03-26T02:12:18.348Z",
      "updatedAt": "2025-03-26T02:12:18.348Z",
      "attendanceTypeCategoryID": 1,
      "contactFormID": null,
      "documentGroupID": null,
      "allowSchedule": 1,
      "color": "#375ABB",
      "price": null,
      "limitDatesGenerateGrid": null,
      "minimalTimeToAppointment": null,
      "serviceTime": null,
      "attendanceTime": null,
      "accountID": 1,
      "attendanceDocumentFormID": null
    }
  ],
  "error": null
}

Post Listar Regiões para Agendamento

https://api.tatodesk.com/pa/listRegionsForAppointment

Descrição: Retorna a lista de regiões disponíveis para agendamento, com base nos tipos de atendimento informados. Esse endpoint é utilizado após a seleção do tipo de atendimento, para identificar onde ele pode ser realizado.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/listRegionsForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceTypes": [1]
}
'

Exemplo de Response:

{
  "regions": [
    {
      "ID": 53,
      "name": "Paulista"
    },
    {
      "ID": 57,
      "name": "Belo Horizonte"
    },
    {
      "ID": 62,
      "name": "Proto Alegre"
    }
  ],
  "error": null
}

Post Listar Unidades de Atendimento para Agendamento

https://api.tatodesk.com/pa/listAttendanceUnitsForAppointment

Descrição: Retorna a lista de unidades de atendimento disponíveis para um determinado tipo de atendimento e região. Esse endpoint é utilizado após a seleção da região, permitindo que o usuário escolha onde será realizado o atendimento.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/listAttendanceUnitsForAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceTypes": [1],
    "regionID": 53
}'

Exemplo de Response:

{
  "attendanceUnits": [
    {
      "ID": 288,
      "name": "Unidade Central Limoeiro",
      "address": "Rua C Bairro João Ernesto"
    }
  ],
  "error": null
}

Post Listar Datas para Agendamento

https://api.tatodesk.com/pa/listDates

Descrição: Retorna a lista de datas disponíveis para realizar o agendamento em uma unidade e tipo de atendimento específicos.

Exemplo de Request

curl --location 'https://api.tatodesk.com/pa/listDates' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "companyID": 1,
    "attendanceUnitID": 288,
    "attendanceTypeIDs": [1]
}'

Exemplo de Response

{
  "dates": [
    "25/06/2025",
    "26/06/2025",
    "27/06/2025",
    "30/06/2025",
    "01/07/2025",
    "02/07/2025",
    "03/07/2025"
  ],
  "error": null
}

Post Listar Períodos para Agendamento

https://api.tatodesk.com/pa/listPeriods

Descrição: Retorna os períodos disponíveis (ex: manhã, tarde, noite) para o agendamento em uma determinada data, unidade e tipo de atendimento.

Exemplo de Request

curl --location 'https://api.tatodesk.com/pa/listPeriods' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "companyID": 1,
    "attendanceUnitID": 288,
    "attendanceTypeIDs": [1],
    "date": "25/06/2025"
}'

Exemplo de Responde

{
  "periods": [
    {
      "ID": 2,
      "name": "Tarde",
      "createdAt": "2022-02-17T12:00:59.948Z",
      "updatedAt": "2022-02-17T12:00:59.948Z"
    },
    {
      "ID": 3,
      "name": "Noite",
      "createdAt": "2022-03-12T00:23:20.475Z",
      "updatedAt": "2022-03-12T00:23:20.475Z"
    }
  ],
  "error": null
}

Post Listar Horários para Agendamento

https://api.tatodesk.com/pa/listHours

Descrição: Retorna a lista de horários disponíveis dentro de um determinado período (manhã, tarde, noite) para o agendamento.

Exemplo de Request

curl --location 'https://api.tatodesk.com/pa/listHours' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "companyID": 1,
    "attendanceUnitID": 288,
    "attendanceTypeIDs": [1],
    "date": "25/06/2025",
    "period": 2
}'

Exemplo de Response

{
  "hours": [
    "15:35",
    "15:40",
    "15:45",
    "15:50",
    "15:55",
    "16:00",
    "16:05",
    "16:10",
    "16:15",
    "16:20",
    "16:25",
    "16:30",
    "16:35",
    "16:40",
    "16:45",
    "16:50",
    "16:55",
    "17:00",
    "17:05",
    "17:10",
    "17:15",
    "17:20",
    "17:25",
    "17:30",
    "17:35",
    "17:40",
    "17:45",
    "17:50",
    "17:55"
  ],
  "error": null
}

Post Criar Agendamento

https://api.tatodesk.com/pa/createAppointment

Descrição: Cria um novo agendamento no sistema Tatodesk, com base nas informações de empresa, unidade, tipo e data selecionadas.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/createAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "companyID": 1,
    "attendanceUnitID": 288,
    "categoryID": 1,
    "attendanceTypes": [1],
    "date": "25/06/2025",
    "periodID": 2,
    "hour": "15:40",
    "channelID": 1,
    "contactForms": [{
        "key": "NOME",
        "value": "Joãozinho"
    }]

}'

Exemplo de Response:

{
  "ID": 10238,
  "protocol": "20250625153656345",
  "documents": [
    "Documento de identificação com foto",
    "Comprovante de residência"
  ],
  "error": null
}

Post Consultar Agendamento

https://api.tatodesk.com/pa/getAppointment

Descrição: Consulta os detalhes completos de um agendamento já criado, utilizando o protocolo de atendimento retornado no momento da criação.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/getAppointment' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "protocol": "20250625153656345"
}'

Exemplo de Responde:

{
  "appointment": {
    "ID": 10238,
    "protocol": "20250625153656345",
    "company": "Tatodesk",
    "attendanceType": "Parcelamento de Dívidas",
    "attendanceUnitID": 288,
    "attendanceUnit": "Unidade Central Limoeiro",
    "attendanceUnitAddress": "Rua C Bairro João Ernesto",
    "date": "2025-06-25",
    "hour": "15:40:00",
    "nick": "tato",
    "profileID": 20,
    "statusID": 5,
    "status": "CANC. NÃO COMPARECIMENTO",
    "guiche": "Guichê 1",
    "documents": null,
    "userID": null,
    "userName": null,
    "additionalDatas": [],
    "contactForms": [
      {
        "ID": 33911,
        "key": "NOME",
        "value": "Joãozinho",
        "keyTypeID": 1
      }
    ]
  },
  "error": null
}

Post Obter Atendimento Presencial

https://api.tatodesk.com/pa/getPresentialAttendance

Descrição: Recupera informações detalhadas sobre um atendimento presencial realizado ou agendado, a partir do ID do atendimento.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pa/getPresentialAttendance' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "ID": 2361485
}'

Exemplo de Responde:

{
  "presentialAttendance": {
    "ID": 2361485,
    "protocol": "20250711161330715",
    "date": "11/07/2025 16:13:30",
    "sequence": 12,
    "companyID": 1,
    "companyName": "Tatodesk",
    "statusName": "CANCELADO NÃO COMPARECIMENTO",
    "statusID": 6,
    "allowServiceDelay": 2,
    "attendanceUnitID": 288,
    "attendanceUnitName": "Unidade Central Limoeiro",
    "attendanceClassificationID": 1,
    "attendanceClassificationName": "Comum",
    "attendanceClassificationAbbreviation": "CM",
    "pipelineStepName": null,
    "userID": 25,
    "userName": "Victor Ferreira",
    "waitingTime": "00:00:09",
    "attendanceTime": "",
    "attendanceSequentialCode": "Guichê 1",
    "attendanceCode": "CM12",
    "ticketNumber": "CM12",
    "lastTramitDate": "11/07/2025 16:13",
    "accountID": 1
  },
  "attendanceLinks": {
    "rateLink": "https://arate.tatodesk.com/fb?p=20250711161330715&plt=pa&a=1",
    "documentSubmissionLinks": [
      {
        "name": "Suporte Remoto via Chat",
        "formName": "Tadeu Copel",
        "link": "https://attendance-document.tatodesk.com/ds?p=20250711161330715&plt=pa&atdfid=8dac9611-eea7-4507-bb82-e046ebbec1e0"
      }
    ]
  },
  "error": null
}

Post Adicionar Anexos

https://api-v2.tatodesk.com/pa/createAttachments

Descrição: Permite associar anexos (arquivos) a um atendimento existente, utilizando o protocolo do agendamento. Os anexos são enviados por meio de URLs previamente armazenadas no servidor da Tatodesk.

Exemplo de Request:

curl --location 'https://api-v2.tatodesk.com/pa/createAttachments' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "protocol": "20250917095431787",
    "urls": ["https://message-file.tatodesk.net/file?fileID=74ea87fd-7dc5-41bc-a071-ac85726ad9da"]
}'

Exemplo de Response:

{
  "error": null
}

Marketing

Post Enviar notificações via E-mail

https://api.tatodesk.com/dl/v1/email/messages

Descrição: Permite enviar notificações por e-mail utilizando um template configurado no Tatodesk. Suporta o envio de anexos e parâmetros dinâmicos dentro do corpo da mensagem.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/dl/v1/email/messages' \
--data-raw '{
    "appID": "",
    "templateID": "",
    "email": {
        "type": "template",
        "to": "[email protected]",
        "templatePayload": {
            "body": {
                "params": [""],
                "attachments":[{ "filename": "exemple.txt", "base64": "base64" }]
            }
        }
    }
}'

WhatsApp

Post Adicionar Anexos

https://media-api.tatodesk.com/dl/v1/whatsapp/media

Descrição: Realiza o upload de arquivos de mídia (imagens, áudios, vídeos, documentos etc.) para o servidor do WhatsApp via Tatodesk, gerando um mediaID que pode ser usado posteriormente no envio de mensagens.

Exemplo de Request:

curl --location 'https://media-api.tatodesk.com/dl/v1/whatsapp/media' \
--header 'TATODESK-API-KEY: 0be4ebdc-6042-4042-8b48-374c07ec26c4' \
--form 'media=@"/C:/Users/consenso/Desktop/IMGS/logo_tatodesk.jpg"' \
--form 'appID="b23cbcd0-f2c3-4f8b-bb54-68a2e9197cdc"'

Exemplo de Response:

{
  "media": {
    "mediaID": "1051023410284838"
  },
  "error": null
}

Post Envia Notificação via WhatsApp

https://api.tatodesk.com/dl/v1/whatsapp/messages

Descrição: Envia uma mensagem de template via WhatsApp para um número específico, utilizando um modelo previamente aprovado pelo WhatsApp Business API. Permite incluir imagens, parâmetros dinâmicos e metadados para rastreamento de campanhas.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/dl/v1/whatsapp/messages' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "appID": ,
    "templateID": {{templateID}},
    "whatsapp": {
        "type": "template",
        "to": "5581999998888",
        "templatePayload": {
            "header": {
                "params": [
                    {
                        "type": "image",
                        "image": {
                            "link": "https://tatodesk.consensotec.com.br/dist/assets/img/logo_tatodesk.jpg"
                        }
                    }
                ]
            },
            "body": {
                "params": [
                    {
                        "type": "TEXT",
                        "text": "Roberto"
                    },
                     {
                        "type": "TEXT",
                        "text": "30/07/2024"
                    }
                ]
            }
        }
    },
    "webhookID": "123",
    "metadatas": {
        "CAMPANHA": "teste-123"
    }
}
'

Post Envia Notificação via WhatsApp - Usando Upload de Mídia

https://api.tatodesk.com/dl/v1/whatsapp/messages

Descrição: Suba um arquivo no serviço 'upload de media' e, em caso de sucesso (código de status 200), receba um UUID na resposta. Utilize este UUID no campo "id" dentro de templatePayload -> header, conforme ilustrado no exemplo abaixo.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/dl/v1/whatsapp/messages' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "appID": ,
    "templateID": {{templateID}},
    "whatsapp": {
        "type": "template",
        "to": "5581999998888",
        "templatePayload": {
            "header": {
                "params": [
                    {
                        "type": "image",
                        "image": {
                            "id": "8c2bb4c0-819c-4ca6-a6e4-a809f2849933"
                        }
                    }
                ]
            },
            "body": {
                "params": [
                    {
                        "type": "TEXT",
                        "text": "Roberto"
                    },
                     {
                        "type": "TEXT",
                        "text": "30/07/2024"
                    }
                ]
            }
        }
    },
    "webhookID": "123",
    "metadatas": {
        "CAMPANHA": "teste-123"
    }
}
'

SMS

Post Envia notificação via SMS

https://api.tatodesk.com/dl/v1/sms/messages

Descrição: Permite o envio de mensagens SMS baseadas em templates, utilizando parâmetros dinâmicos e metadados personalizados. Ideal para notificações automáticas, lembretes e campanhas.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/dl/v1/sms/messages' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "appID": ,
    "templateID": {{templateID}},
    "sms": {
        "type": "template",
        "to": "5581999998888",
        "template": {
            "params": ["Robeto", "01/28/2024"]
        }
    },
    "webhookID": "123",
    "metadatas": {
        "CAMPANHA": "teste-123"
    }
}'

Data API

Post Relatório de Atendimentos Digitais

https://data.tatodesk.com/cc/listAttendancesReport

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.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/cc/listAttendancesReport' \
--header 'TATODESK-API-KEY: {{API-KEY-REPORT}}' \
--data '{
    "filter": {
        "dateInitial": "01/01/2024",
        "dateFinal": "30/01/2025",
        "protocol": "",
        "sessionID": "",
        "statusIDs": [],
        "departmentIDs": [],
        "userIDs": [],
        "tagIDs": [],
        "channelIDs": [],
        "rates": [],
        "sentiments": [],
        "attendanceTime": {
            "operation": 1,
            "value": 1,
            "valueFinal": 1
        }

    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "count": "66",
  "attendances": [
    {
      "ID": 3495525,
      "protocol": "20241211133413753",
      "session": "9a2221e7-93ef-411f-9266-da0b1d8e6028",
      "date": "2024-12-11T13:34:13.753Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": "Excelente",
      "attendanceTime": "00:00:06",
      "waitingTime": "00:00:11",
      "firstAgentReply": "",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "",
      "sentiment": null,
      "metadatas": "NOME:Tadeu | EMAIL:[email protected] | TELEFONE:558199998888",
      "additionalData": null
    },
    {
      "ID": 3481079,
      "protocol": "20241209105656686",
      "session": "fade4dc6-3dd6-4979-a4f5-afe62b95a5ab",
      "date": "2024-12-09T10:56:56.686Z",
      "status": "Concluído",
      "channel": "Webchat",
      "department": "Suporte N1",
      "userName": "Suporte tatodesk",
      "rate": "Excelente",
      "attendanceTime": "00:00:19",
      "waitingTime": "00:00:11",
      "firstAgentReply": "00:00:07",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "00:00:05",
      "sentiment": null,
      "metadatas": "NOME:Moises | EMAIL:[email protected] | TELEFONE:8188889999",
      "additionalData": null
    },
    {
      "ID": 3413027,
      "protocol": "20241122141630976",
      "session": "960ac15b-2c71-4e69-99a1-de0a8f7c595c",
      "date": "2024-11-22T14:16:30.976Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": "Muito ruim",
      "attendanceTime": "00:00:06",
      "waitingTime": "00:00:14",
      "firstAgentReply": "",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "",
      "sentiment": null,
      "metadatas": "NOME:Tadeu | EMAIL:[email protected] | TELEFONE:558199998888",
      "additionalData": "NUMERO_WHATSAPP:[phone]"
    },
    {
      "ID": 3412676,
      "protocol": "20241122133039349",
      "session": "8021e542-daf0-49a6-a644-d6e9c9582905",
      "date": "2024-11-22T13:30:39.349Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": "Excelente",
      "attendanceTime": "00:00:07",
      "waitingTime": "00:16:33",
      "firstAgentReply": "",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "",
      "sentiment": null,
      "metadatas": "NOME:Tadeu | EMAIL:[email protected] | TELEFONE:558199998888",
      "additionalData": "NUMERO_WHATSAPP:[phone]"
    },
    {
      "ID": 3336861,
      "protocol": "20241105110228168",
      "session": "07c1d585-5c78-42de-9fc0-9fd22fdb425c",
      "date": "2024-11-05T11:02:28.168Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": "Excelente",
      "attendanceTime": "00:00:20",
      "waitingTime": "00:00:15",
      "firstAgentReply": "00:00:06",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "00:00:06",
      "sentiment": null,
      "metadatas": "NOME:Tadeu | EMAIL:[email protected] | TELEFONE:558199998888",
      "additionalData": "NUMERO_WHATSAPP:[phone]"
    },
    {
      "ID": 3322636,
      "protocol": "20241101114624894",
      "session": "5e6ddb3c-57e9-4e17-a352-7500ed118cad",
      "date": "2024-11-01T11:46:24.894Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Suporte tatodesk",
      "rate": null,
      "attendanceTime": "00:00:57",
      "waitingTime": "00:00:14",
      "firstAgentReply": "00:00:19",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "",
      "sentiment": null,
      "metadatas": "NOME:Moises | EMAIL:[email protected] | TELEFONE:558198888999",
      "additionalData": "NUMERO_WHATSAPP:[phone]"
    },
    {
      "ID": 3300296,
      "protocol": "20241028145931622",
      "session": "8706b28f-cf1e-4841-9aea-ce6a5581a0b1",
      "date": "2024-10-28T14:59:31.622Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": "Excelente",
      "attendanceTime": "00:00:55",
      "waitingTime": "00:00:08",
      "firstAgentReply": "",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "00:00:31",
      "sentiment": null,
      "metadatas": "NOME:Tadeu | EMAIL:[email protected] | TELEFONE:558199998888",
      "additionalData": "NUMERO_WHATSAPP:[phone]"
    },
    {
      "ID": 3299950,
      "protocol": "20241028140848305",
      "session": "769bf318-40a8-4834-98f2-d7a799c63602",
      "date": "2024-10-28T14:08:48.305Z",
      "status": "Concluído",
      "channel": "WhatsApp",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": null,
      "attendanceTime": "00:00:13",
      "waitingTime": "00:01:00",
      "firstAgentReply": "",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "",
      "sentiment": null,
      "metadatas": "NOME:Tadeu | EMAIL:[email protected] | TELEFONE:558199998888",
      "additionalData": "NUMERO_WHATSAPP:[phone]"
    },
    {
      "ID": 3242326,
      "protocol": "20241015093248120",
      "session": "97d3235f-03a3-4d8c-8515-d62af0b385c1",
      "date": "2024-10-15T09:32:48.120Z",
      "status": "Concluído",
      "channel": "Webchat",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": null,
      "attendanceTime": "00:00:31",
      "waitingTime": "00:00:08",
      "firstAgentReply": "",
      "timeClientAgentReply": "00:00:03",
      "timeAgentClientReply": "",
      "sentiment": 1,
      "metadatas": "NOME:Tadei Teste | EMAIL:[email protected] | TELEFONE:03136537816",
      "additionalData": null
    },
    {
      "ID": 3211755,
      "protocol": "20241008081401928",
      "session": "01a7c700-0213-4ffe-8bc7-9250bb45c036",
      "date": "2024-10-08T08:14:01.928Z",
      "status": "Cliente não responde",
      "channel": "Webchat",
      "department": "Suporte N1",
      "userName": "Tadeu Suporte",
      "rate": null,
      "attendanceTime": "",
      "waitingTime": "00:27:50",
      "firstAgentReply": "",
      "timeClientAgentReply": "",
      "timeAgentClientReply": "",
      "sentiment": 2,
      "metadatas": "NOME:Pablo | EMAIL:[email protected] | TELEFONE:44991613335",
      "additionalData": null
    }
  ],
  "error": null
}

Post Relatório de Campanhas

https://data.tatodesk.com/mkt/listCampaignsReport

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.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/mkt/listCampaignsReport' \
--header 'TATODESK-API-KEY: 6954e347-be4b-4cfc-94f3-b9f0f9f1713a' \
--data '{
    "filter": {
        "dateInitial": "01/01/2024",
        "dateFinal": "30/06/2025"
       
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "count": "15",
  "campaignItems": [
    {
      "campaignID": 1003392,
      "targetAudienceID": 25696020,
      "name": "campanha_teste_sefin",
      "campaignType": "whatsapp",
      "department": null,
      "template": "tmpl_grp_tematico_2",
      "date": "2024-08-27T17:03:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "grupo_sefin",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": "SEFIN",
      "error": null,
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1003392,
      "targetAudienceID": 25696021,
      "name": "campanha_teste_sefin",
      "campaignType": "whatsapp",
      "department": null,
      "template": "tmpl_grp_tematico_2",
      "date": "2024-08-27T17:03:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "grupo_sefin",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": "SEFIN",
      "error": null,
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1004873,
      "targetAudienceID": 28296433,
      "name": "campanha apresentacao modelo 01",
      "campaignType": "whatsapp",
      "department": null,
      "template": null,
      "date": "2024-11-21T16:38:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "pa-campanha apresentacao modelo 01",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": "nova ligação",
      "error": null,
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1005199,
      "targetAudienceID": 28644547,
      "name": "teste_otp",
      "campaignType": "whatsapp",
      "department": null,
      "template": "teste_otp",
      "date": "2024-12-04T13:55:00.000Z",
      "campaignStatus": "Error",
      "targetAudience": "pa-teste_otp",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Error",
      "parameters": "4321",
      "error": "(#131008) Required parameter is missing. buttons: Button at index 0 of type Url requires a parameter",
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Não",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1005199,
      "targetAudienceID": 28644548,
      "name": "teste_otp",
      "campaignType": "whatsapp",
      "department": null,
      "template": "teste_otp",
      "date": "2024-12-04T13:55:00.000Z",
      "campaignStatus": "Error",
      "targetAudience": "pa-teste_otp",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Error",
      "parameters": "1234",
      "error": "(#131008) Required parameter is missing. buttons: Button at index 0 of type Url requires a parameter",
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Não",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1008327,
      "targetAudienceID": 30287359,
      "name": "Campanha de teste de metadatas",
      "campaignType": "whatsapp",
      "department": null,
      "template": "modelo_template_completo",
      "date": "2025-04-10T10:19:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "pa-Campanha de teste de metadatas",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": "roberto",
      "error": null,
      "interaction": "Sim",
      "user": "Atendimento Apresentação",
      "sessionID": "8f2130a7-567e-4a09-9979-232a375d68f8",
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1008328,
      "targetAudienceID": 30287360,
      "name": "Campanha modelo para metro - usando público alvo",
      "campaignType": "whatsapp",
      "department": null,
      "template": "modelo_template_completo",
      "date": "2025-04-10T10:25:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "modelo para template completo - metro",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": "roberto",
      "error": null,
      "interaction": "Sim",
      "user": "Atendimento Apresentação",
      "sessionID": "8f2130a7-567e-4a09-9979-232a375d68f8",
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1008356,
      "targetAudienceID": 30290289,
      "name": "Campanha teste sem parametros",
      "campaignType": "whatsapp",
      "department": null,
      "template": "template_teste_pula_linha",
      "date": "2025-04-10T16:05:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "pa-Campanha teste sem parametros",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": null,
      "error": null,
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1008371,
      "targetAudienceID": 30296302,
      "name": "Apresentação",
      "campaignType": "whatsapp",
      "department": null,
      "template": "modelo_template_completo",
      "date": "2025-04-11T10:27:00.000Z",
      "campaignStatus": "Error",
      "targetAudience": "pa-Apresentação",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Error",
      "parameters": null,
      "error": "(#132000) Number of parameters does not match the expected number of params. body: number of localizable_params (0) does not match the expected number of params (1)",
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Não",
      "whatsappBillable": null,
      "whatsappPricingModel": null,
      "whatsappCategory": null,
      "conversion": null
    },
    {
      "campaignID": 1008802,
      "targetAudienceID": 30500291,
      "name": "Apresentação Teste 01 - 05052025",
      "campaignType": "whatsapp",
      "department": null,
      "template": "apresentacao_tatodesk",
      "date": "2025-05-05T15:35:00.000Z",
      "campaignStatus": "Finalizada",
      "targetAudience": "pa-Apresentação Teste 01 - 05052025",
      "targetAudienceType": "Telefone",
      "key": "5581988887777",
      "status": "Concluido",
      "parameters": "Roberto",
      "error": null,
      "interaction": "Não",
      "user": "Atendimento Apresentação",
      "sessionID": null,
      "read": "Não",
      "delivered": "Sim",
      "whatsappBillable": 1,
      "whatsappPricingModel": "CBP",
      "whatsappCategory": "marketing",
      "conversion": null
    }
  ],
  "error": null
}

POST Relatório de Atendimentos Presenciais

https://data.tatodesk.com/pa/listAttendancesReport

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.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/pa/listAttendancesReport' \
--header 'TATODESK-API-KEY: {{DATA-API-PA}}' \
--data '{
    "filter": {
        "dateInitial": "01/01/2024",
        "dateFinal": "30/01/2024",
        "protocol": "",
        "attendanceCode": "",
        "companyIDs": [],
        "attendanceUnitIDs": [],
        "attendanceTypeIDs": [],
        "statusIDs": [],
        "userIDs": [],
        "tagIDs": [],
        "attendanceTime": {
            "operation": 1,
            "value": 1,
            "valueFinal": 1
        },
        "waitingTime": {
            "operation": 1,
            "value": 1,
            "valueFinal": 1
        },
        "pausedTime": {
            "operation": 1,
            "value": 1,
            "valueFinal": 1
        },
        "form": {
            "key": "",
            "value": ""
        },
        "additionalData": {
            "ID": "",
            "value": ""
        }
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "count": "25",
  "attendances": [
    {
      "protocol": "20240122112732490",
      "attendanceCode": "CM1",
      "classification": "Comum",
      "status": "CANCELADO NÃO COMPARECIMENTO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-22T11:27:32.490Z",
      "dateCall": "2024-01-22T11:28:19.257Z",
      "startAttendance": null,
      "waitingTime": "00:00:47",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "NOME:José Emanuel"
    },
    {
      "protocol": "20240119155943608",
      "attendanceCode": "CM2",
      "classification": "Comum",
      "status": "CONCLUÍDO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-19T15:59:43.608Z",
      "dateCall": "2024-01-19T16:00:36.736Z",
      "startAttendance": "2024-01-19T16:00:58.156Z",
      "waitingTime": "00:00:53",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "00:00:53",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:Jonathan"
    },
    {
      "protocol": "20240117172536554",
      "attendanceCode": "CM1",
      "classification": "Comum",
      "status": "CANCELADO POR EXPIRAÇÃO",
      "company": "Tatodesk 2",
      "region": "Belo Horizonte",
      "attendanceUnit": "Unidade Central",
      "attendanceType": "Parcelamento de Dívidas",
      "ticketWindowType": null,
      "agent": null,
      "date": "2024-01-17T17:25:36.554Z",
      "dateCall": null,
      "startAttendance": null,
      "waitingTime": "",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "NOME:Moises"
    },
    {
      "protocol": "20240117165737390",
      "attendanceCode": "CM13",
      "classification": "Comum",
      "status": "CONCLUÍDO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": null,
      "agent": "Victor Ferreira",
      "date": "2024-01-17T16:57:37.389Z",
      "dateCall": null,
      "startAttendance": "2024-01-17T16:57:54.607Z",
      "waitingTime": "00:00:17",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "00:00:16",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:Jonathan"
    },
    {
      "protocol": "20240117152350617",
      "attendanceCode": "CM6",
      "classification": "Comum",
      "status": "CANCELADO NÃO COMPARECIMENTO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-17T15:23:50.617Z",
      "dateCall": "2024-01-17T15:24:13.906Z",
      "startAttendance": null,
      "waitingTime": "00:00:23",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:José Emanuel"
    },
    {
      "protocol": "20240117135720803",
      "attendanceCode": "CM1",
      "classification": "Comum",
      "status": "CANCELADO NÃO COMPARECIMENTO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-17T13:57:20.803Z",
      "dateCall": "2024-01-17T13:57:52.499Z",
      "startAttendance": "2024-01-17T13:58:37.254Z",
      "waitingTime": "00:00:32",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:José Emanuel"
    },
    {
      "protocol": "20240112113654903",
      "attendanceCode": "CM1",
      "classification": "Comum",
      "status": "CONCLUÍDO",
      "company": "Tatodesk",
      "region": "Fortaleza",
      "attendanceUnit": "Unidade Madalena",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Tadeu Copel",
      "date": "2024-01-12T11:36:54.903Z",
      "dateCall": "2024-01-12T11:52:42.610Z",
      "startAttendance": "2024-01-12T11:52:47.822Z",
      "waitingTime": "00:00:05",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "00:00:08",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:TADEU | CPF_CNPJ:36742676086"
    },
    {
      "protocol": "20240112102035479",
      "attendanceCode": "CM1",
      "classification": "Comum",
      "status": "CANCELADO NÃO COMPARECIMENTO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Nova denúncia",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-12T10:20:35.479Z",
      "dateCall": "2024-01-12T10:31:56.935Z",
      "startAttendance": null,
      "waitingTime": "",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "NOME:AAAAA"
    },
    {
      "protocol": "20240110233121306",
      "attendanceCode": "CM5",
      "classification": "Comum",
      "status": "CANCELADO NÃO COMPARECIMENTO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-10T23:31:21.306Z",
      "dateCall": "2024-01-12T12:15:04.511Z",
      "startAttendance": null,
      "waitingTime": "",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:José Emanuel | CPF_CNPJ:11382391439"
    },
    {
      "protocol": "20240109224458346",
      "attendanceCode": "CM6",
      "classification": "Comum",
      "status": "CANCELADO NÃO COMPARECIMENTO",
      "company": "Tatodesk",
      "region": "Grande Recife",
      "attendanceUnit": "Unidade Recife Antigo",
      "attendanceType": "Novo outros",
      "ticketWindowType": "presential",
      "agent": "Victor Ferreira",
      "date": "2024-01-09T22:44:58.346Z",
      "dateCall": "2024-01-09T22:47:00.917Z",
      "startAttendance": null,
      "waitingTime": "",
      "displacementTime": "",
      "pausedTime": "",
      "attendanceTime": "",
      "remoteAttendance": "Não",
      "additionalData": null,
      "contactForms": "EMAIL:[email protected] | NOME:José Emanuel | CPF_CNPJ:11382391439"
    }
  ],
  "error": null
}

POST Relatório de Tickets

https://data.tatodesk.com/ticket/listTicketIssuesReport

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.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/ticket/listTicketIssuesReport' \
--header 'TATODESK-API-KEY: {{API-KEY-REPORT}}' \
--data '{
    "filter": {
        "dateInitial": "01/01/2025",
        "dateFinal": "30/01/2025",
        "protocol": "",
        "statusIDs": [],
        "organizationIDs": [],
        "projectIDs": [],
        "departmentIDs": [],
        "userIDs": [],
        "form": {
            "key": "",
            "value": ""
        }
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "count": "8",
  "attendances": [
    {
      "protocol": "20250129103237613",
      "date": "2025-01-29T10:32:37.613Z",
      "finishedDate": "2025-01-30T11:08:06.096Z",
      "status": "Resolvido",
      "department": "Suporte",
      "attendanceType": "Atendimento Digital - Geral",
      "origin": "e-mail",
      "email": "[email protected]",
      "subject": "Re: Encaminhamento do Ticket - 20250129102133224",
      "user": "Tadeu Suporte",
      "additionalData": null,
      "threads": null
    },
    {
      "protocol": "20250129102133224",
      "date": "2025-01-29T10:21:33.224Z",
      "finishedDate": "2025-01-30T11:08:22.589Z",
      "status": "Resolvido",
      "department": "Sugestão de melhorias",
      "attendanceType": "Sugestão de melhorias",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Tadeu Suporte",
      "additionalData": null,
      "threads": "ASSUNTO:Encaminhamento do Ticket - 20250129102133224#EMAILS:[email protected], [email protected]"
    },
    {
      "protocol": "20250128162948396",
      "date": "2025-01-28T16:29:48.396Z",
      "finishedDate": "2025-02-09T17:32:00.208Z",
      "status": "Resolvido",
      "department": "Sugestão de melhorias",
      "attendanceType": "Sugestão de melhorias",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Tadeu Suporte",
      "additionalData": null,
      "threads": "ASSUNTO:Encaminhamento do Ticket - 20250128162948396#EMAILS:[email protected], [email protected]; [email protected] | ASSUNTO:Encaminhamento do Ticket - 20250128162948396#EMAILS:[email protected], [email protected], [email protected]"
    },
    {
      "protocol": "20250125101453943",
      "date": "2025-01-25T10:14:53.943Z",
      "finishedDate": "2025-01-27T09:08:01.233Z",
      "status": "Resolvido",
      "department": "Suporte",
      "attendanceType": "Atendimento Digital - Geral",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Tadeu Suporte",
      "additionalData": null,
      "threads": null
    },
    {
      "protocol": "20250110180216211",
      "date": "2025-01-10T18:02:16.211Z",
      "finishedDate": null,
      "status": "Aguardando Resposta",
      "department": "Suporte",
      "attendanceType": "Atendimento Digital - Geral",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Kamila Suporte",
      "additionalData": null,
      "threads": null
    },
    {
      "protocol": "20250110131737731",
      "date": "2025-01-10T13:17:37.731Z",
      "finishedDate": null,
      "status": "Respondido",
      "department": "Suporte",
      "attendanceType": "Atendimento Digital - Geral",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Kamila Suporte",
      "additionalData": null,
      "threads": null
    },
    {
      "protocol": "20250108112623024",
      "date": "2025-01-08T11:26:23.024Z",
      "finishedDate": "2025-01-08T15:10:29.052Z",
      "status": "Resolvido",
      "department": "Suporte",
      "attendanceType": "Atendimento Digital - Geral",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Kamila Suporte",
      "additionalData": null,
      "threads": null
    },
    {
      "protocol": "20250106143710195",
      "date": "2025-01-06T14:37:10.195Z",
      "finishedDate": "2025-01-14T08:06:18.222Z",
      "status": "Resolvido",
      "department": "Suporte",
      "attendanceType": "Permissões de Acesso",
      "origin": "tatodesk",
      "email": "[email protected]",
      "subject": "Seu ticket foi criado",
      "user": "Kamila Suporte",
      "additionalData": null,
      "threads": null
    }
  ],
  "error": null
}

Post Busca por protocolo

https://data.tatodesk.com/global/searchProtocol

Descrição: Permite buscar informações detalhadas de um protocolo em múltiplas plataformas Tatodesk, como atendimento digital, presencial, tickets ou MP. Ideal para consultar status, datas e dados de registros já criados.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/global/searchProtocol' \
--header 'TATODESK-API-KEY: {{TATODESK-MODELO-GERAL}}' \
--data '{
"protocol": "20241106124207517",
"platform": []
}'

Exemplo de Response:

{
  "result": [
    {
      "protocol": "20241106124207517",
      "platform": "ticket",
      "data": {
        "ID": 151444,
        "protocol": "20241106124207517",
        "statusID": 6,
        "status": "Resolvido",
        "date": "2024-11-06T15:42:07.517Z",
        "departmentID": 24,
        "department": "Suporte",
        "userID": 1,
        "userName": "Consenso Tecnologia",
        "forms": [],
        "additionalDatas": []
      }
    }
  ],
  "error": null
}

Post Relatório de Sessões

https://data.tatodesk.com/mp/listMessagingSessions

Descrição: Este endpoint permite consultar relatórios de sessões de mensagens (webchat, WhatsApp, etc.) dentro de um período específico. É útil para auditorias, métricas de atendimento e rastreamento de interações de usuários em múltiplos canais.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/mp/listMessagingSessions' \
--header 'TATODESK-API-KEY: {{TATODESK-MODELO-GERAL}}' \
--data '{
"filter": {
"dateInitial": "01/03/2025 00:00",
"dateFinal": "19/03/2025 23:59"

},
"page": 0,
"limit": 500
}'

Exemplo de Response:

{
  "sessions": [
    {
      "sessionID": "d6fd15ae-168c-473b-9576-582e3e2669b3",
      "date": "2025-03-19T17:08:57.003Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T17:08:57.003Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "8aff8ec2-6c35-4ba9-bd8c-c9d848978d9d",
      "date": "2025-03-19T17:05:59.161Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T17:05:59.161Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "abe1e68c-5bfc-4b26-882e-3ab245d18146",
      "date": "2025-03-19T17:03:44.338Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T17:03:44.338Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "3dd4f051-66b9-4b22-811e-01e2d0edd334",
      "date": "2025-03-19T17:01:27.995Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T17:01:27.995Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "675ae898-577e-4ffa-949a-e56cdae52730",
      "date": "2025-03-19T16:21:43.984Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T16:21:43.984Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "398cf32d-4e14-4200-8382-444042df2665",
      "date": "2025-03-19T16:19:32.600Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T16:19:32.600Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "05a8397c-6bd9-4552-8d20-8c589ea1540d",
      "date": "2025-03-19T16:16:30.843Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T16:16:30.843Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "d944c0ad-704b-4836-9645-f988e48f088d",
      "date": "2025-03-19T16:05:51.705Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T16:05:51.705Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "91445f46-2a30-4a31-96f9-3e281ed89647",
      "date": "2025-03-19T16:03:29.357Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T16:03:29.357Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "3877358f-7f7f-4c58-8b7e-fdfea70a41d7",
      "date": "2025-03-19T16:01:12.071Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T16:01:12.071Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "14af80ce-4906-4559-841d-064487e0fe5f",
      "date": "2025-03-19T15:15:03.309Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T15:15:03.309Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "084ae008-3292-4aa1-97ee-038eb8c7eaef",
      "date": "2025-03-19T15:00:38.834Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T15:00:38.834Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "e922907c-14de-40f0-aeec-662595b6f338",
      "date": "2025-03-19T14:56:52.304Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T14:56:52.304Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "0f86499a-be58-46d6-9d55-a96c4197553f",
      "date": "2025-03-19T11:30:09.858Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-19T11:30:09.858Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "090fcbc6-8467-4ee7-809d-4caf3fc5532f",
      "date": "2025-03-18T15:53:58.096Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T15:53:58.096Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "652d813f-d20a-4fdb-a89d-a87325a68202",
      "date": "2025-03-18T15:52:15.822Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T15:52:15.822Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "9e64f52d-6ab7-48f2-bd57-3275e0089624",
      "date": "2025-03-18T15:01:13.048Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T15:01:13.048Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "c67dc161-3f66-4da4-856f-c01449be3a32",
      "date": "2025-03-18T14:51:09.842Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T14:51:09.842Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "7a66b5fb-5889-4189-b273-848d1e347570",
      "date": "2025-03-18T14:48:49.382Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T14:48:49.382Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "790f6530-71b2-4eab-bff8-7a8f2a21d939",
      "date": "2025-03-18T14:45:39.854Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T14:45:39.854Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "035f930b-e50b-41bf-a669-69aa4c3ef978",
      "date": "2025-03-18T14:44:52.108Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-18T14:44:52.108Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "5cb20230-7539-4348-95aa-4c506af8de88",
      "date": "2025-03-18T14:43:19.908Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-18T14:43:19.908Z",
      "updatedAt": "2025-03-19T16:12:38.286Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "cb63a914-668c-4010-a29a-a0a402fdd352",
      "date": "2025-03-14T16:12:04.738Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-14T16:12:04.738Z",
      "updatedAt": "2025-03-14T16:12:04.738Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "d2419e0f-93af-4c15-a6e9-bd447c06212e",
      "date": "2025-03-14T16:02:27.400Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-14T16:02:27.400Z",
      "updatedAt": "2025-03-14T16:02:27.400Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "ebe9ef96-3d06-4b00-b904-4aa576ace5f2",
      "date": "2025-03-14T14:33:08.243Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-14T14:33:08.243Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "37f9b382-0c08-4fee-a00e-c541108e645b",
      "date": "2025-03-14T14:15:34.788Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-14T14:15:34.788Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "a39eee3a-2098-4be0-86c3-b9202382862e",
      "date": "2025-03-14T10:07:24.892Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-14T10:07:24.892Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "fce63789-9cbe-48ed-8092-247cf2dc5f9c",
      "date": "2025-03-13T23:08:02.842Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-13T23:08:02.842Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "44932b15-1ad5-47fa-9fd8-c6c29012579f",
      "date": "2025-03-13T20:54:21.351Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Hevandro Ferreira",
        "whatsappID": "5518991233540"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-13T20:54:21.351Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "931c3071-6131-430b-aca1-11b3b7df325b",
      "date": "2025-03-13T13:20:59.110Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-13T13:20:59.110Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "9d357854-6d2f-4cae-881a-0316b6d67c13",
      "date": "2025-03-13T08:54:53.673Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-13T08:54:53.673Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "3a94fbf9-713d-4fba-9a51-10c870468c70",
      "date": "2025-03-13T08:19:26.751Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-13T08:19:26.751Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "187a8949-2340-40be-af99-c2030a98eed9",
      "date": "2025-03-13T08:12:48.701Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-13T08:12:48.701Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "11c5a445-bf09-4f0d-a7f7-8bbc312f30ae",
      "date": "2025-03-13T08:05:56.532Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-13T08:05:56.532Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "5377090b-3b68-43f5-b078-40aaefdd74b9",
      "date": "2025-03-12T19:47:27.096Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T19:47:27.096Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "1d95d8ca-7d7f-411e-9514-a7a66f52de5e",
      "date": "2025-03-12T17:23:17.742Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T17:23:17.742Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "8fd6bc60-e4fb-4e9d-803c-0fbb03e4c3bf",
      "date": "2025-03-12T17:09:27.153Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T17:09:27.153Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "af99eb19-0dd0-45bd-9a4b-f5ffe3ea99a1",
      "date": "2025-03-12T17:03:35.598Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T17:03:35.598Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "ddc38088-5e67-4e06-a69c-3284589c900b",
      "date": "2025-03-12T17:01:03.861Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Moisés Simões",
        "whatsappID": "558195492882"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T17:01:03.861Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "deec00db-bf8e-4e68-8c0d-35208678f000",
      "date": "2025-03-12T16:41:22.146Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T16:41:22.146Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "5dd3a46d-30fd-442e-868a-ab7ba30cd180",
      "date": "2025-03-12T16:31:53.753Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T16:31:53.753Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "2128e562-626e-4ee4-801e-e67527f3bbd3",
      "date": "2025-03-12T15:37:35.266Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T15:37:35.266Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "45b35347-57db-4ae5-b5d6-8cafd3c73540",
      "date": "2025-03-12T15:13:53.885Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T15:13:53.885Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "fbd06934-f3ea-46b6-b4c0-93b12e28c145",
      "date": "2025-03-12T14:44:27.526Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T14:44:27.526Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "a8f91a21-7dc3-4065-8540-3d1af902a3bc",
      "date": "2025-03-12T14:39:17.794Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T14:39:17.794Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "9dd205c1-e0a3-4d3d-b78e-0a1732c79028",
      "date": "2025-03-12T14:32:08.036Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T14:32:08.036Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "925ef2f7-3bbe-4076-9f74-6b295437f966",
      "date": "2025-03-12T14:15:16.000Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T14:15:16.000Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "1f59ec99-e1b5-49b8-b83a-b4beb30f8a53",
      "date": "2025-03-12T12:57:43.755Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Vinicius Manzini",
        "whatsappID": "5518981219436"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T12:57:43.755Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "a3374aeb-b109-4ce2-bd3e-7f3c4f8d5e11",
      "date": "2025-03-12T12:57:03.085Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T12:57:03.085Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "ae1d9f26-d9d7-45b1-b38c-2b6bb629bf43",
      "date": "2025-03-12T12:49:26.534Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T12:49:26.534Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "10309d6d-f7b9-4764-a2cc-aab230b55631",
      "date": "2025-03-12T12:46:40.752Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T12:46:40.752Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "9b1d7848-ba87-4bc9-9c9b-3bec2cb328ea",
      "date": "2025-03-12T12:31:45.724Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T12:31:45.724Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "cc1948da-9ec3-49fd-9905-4d05e5008378",
      "date": "2025-03-12T12:26:53.112Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T12:26:53.112Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "fb2ff5c7-d22c-4ffb-b257-c290377a17a1",
      "date": "2025-03-12T12:17:09.086Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T12:17:09.086Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "f89eb51f-eded-42fc-8f26-ce3e300f6b19",
      "date": "2025-03-12T11:11:05.134Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T11:11:05.134Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "1a39c7e5-8ddf-428e-bc67-4ab0cd28fdd8",
      "date": "2025-03-12T11:02:06.416Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T11:02:06.416Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "ebc76b6c-5f9d-4822-971f-3529ff554782",
      "date": "2025-03-12T10:39:49.864Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T10:39:49.864Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "9137b2f9-270b-4f87-9473-75aa6efd7a1b",
      "date": "2025-03-12T10:22:20.937Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T10:22:20.937Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "6171443b-a30a-4c91-bc37-be7256915f8b",
      "date": "2025-03-12T09:19:55.752Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T09:19:55.752Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "82eb026e-1c7c-42b5-bc85-4bcc0fce87e3",
      "date": "2025-03-12T09:17:01.046Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-12T09:17:01.046Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "2eeeb688-2a4f-4347-aab2-e2ad30944244",
      "date": "2025-03-12T09:13:13.375Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-12T09:13:13.375Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "11dd4fe5-edc6-4117-bd15-0e4dcb1b3f8c",
      "date": "2025-03-11T16:29:27.776Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T16:29:27.776Z",
      "updatedAt": "2025-04-06T20:00:00.000Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "7505e213-f0e2-4163-ad39-2c54329d2730",
      "date": "2025-03-11T14:53:13.941Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T14:53:13.941Z",
      "updatedAt": "2025-03-11T14:53:14.268Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "05c4244a-b902-4264-bb90-fb9bdcdd5292",
      "date": "2025-03-11T14:49:50.832Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T14:49:50.832Z",
      "updatedAt": "2025-03-11T14:49:51.128Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "e92236f0-0482-4daf-b859-04f29f90df20",
      "date": "2025-03-11T14:43:23.590Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Beto Rosa Borges",
        "whatsappID": "558196354429"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-11T14:43:23.590Z",
      "updatedAt": "2025-03-11T14:43:23.590Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "ca9402bc-2cc1-4f1d-9cbd-d67194bf7543",
      "date": "2025-03-11T14:33:47.552Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T14:33:47.552Z",
      "updatedAt": "2025-03-11T14:33:47.863Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "d12ab7b0-e236-4eba-9441-39f79b28185c",
      "date": "2025-03-11T14:28:27.206Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T14:28:27.206Z",
      "updatedAt": "2025-03-11T14:28:27.483Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "6e74faee-4a7b-4382-a784-6fdd697ac729",
      "date": "2025-03-11T14:20:40.393Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T14:20:40.393Z",
      "updatedAt": "2025-03-11T14:20:40.717Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "4b7bf8d8-1ae7-4485-a973-0e9d5d210c01",
      "date": "2025-03-11T14:19:55.678Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T14:19:55.678Z",
      "updatedAt": "2025-03-11T14:19:56.029Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "ed5dc4f6-e5e5-49b4-87cd-460311deb332",
      "date": "2025-03-11T13:40:21.493Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T13:40:21.493Z",
      "updatedAt": "2025-03-11T13:40:21.804Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "e6a949e7-f438-4525-9658-2d40db85abf1",
      "date": "2025-03-11T13:39:38.112Z",
      "messagingStatus": "running",
      "contact": {
        "name": "Almir Silvério Fonseca",
        "whatsappID": "5518996315010"
      },
      "channel": "whatsapp",
      "createdAt": "2025-03-11T13:39:38.112Z",
      "updatedAt": "2025-03-11T13:41:35.481Z",
      "appIntegrationID": "18f023c3-a608-4c45-86f4-56d47d7704ef",
      "accountID": 241
    },
    {
      "sessionID": "35923620-d284-47d7-b4ae-5f4830c97bcf",
      "date": "2025-03-11T13:33:50.478Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T13:33:50.478Z",
      "updatedAt": "2025-03-11T13:33:50.797Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "2f4e7ac0-8cba-451d-9f68-0666cfc3bcf2",
      "date": "2025-03-11T10:59:45.140Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T10:59:45.140Z",
      "updatedAt": "2025-03-11T10:59:45.569Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "b5121ed7-d293-4d97-98ad-e33e899585e2",
      "date": "2025-03-11T10:55:43.666Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-11T10:55:43.666Z",
      "updatedAt": "2025-03-11T10:55:44.045Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "68cca655-3313-463e-9605-a24f4cd47f69",
      "date": "2025-03-10T15:22:52.923Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-10T15:22:52.923Z",
      "updatedAt": "2025-03-10T15:22:53.319Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    },
    {
      "sessionID": "a620ba3c-e8e0-4904-ab95-142a8a4c64ae",
      "date": "2025-03-10T09:08:59.409Z",
      "messagingStatus": "running",
      "contact": {
        "ip": "10.0.5.168"
      },
      "channel": "webchat",
      "createdAt": "2025-03-10T09:08:59.409Z",
      "updatedAt": "2025-03-10T09:08:59.990Z",
      "appIntegrationID": "ba426214-3044-4a45-bf2f-929a22c2ea8e",
      "accountID": 241
    }
  ],
  "count": "76",
  "error": null
}

POST Relatório de Jornada Agrupado

https://data.tatodesk.com/chatbot/listChatbotJourneyEventsGrouped

Descrição: Retorna eventos de jornada de chatbot agrupados por nível e tag, dentro de um período definido. Ideal para relatórios de fluxo de usuários e análise de desempenho de jornadas automatizadas.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/chatbot/listChatbotJourneyEventsGrouped' \
--header 'TATODESK-API-KEY: {{TATODESK-MODELO-GERAL}}' \
--data '{
    "filter": {
        "dateInitial": "01/03/2025",
        "dateFinal": "19/03/2025",
        "chatbotID": "",
        "chatbotJourneyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb"
    }
}'

Exemplo de Response:

{
  "events": [
    {
      "journeyID": "1f89759b-deba-4495-98d2-cc1f14023ce2",
      "journeyName": "Teste Adauto 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
      "levelID": "b9ae080e-7b0b-44bc-8e2b-f07a6cfc2849",
      "levelDescription": "teste 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    },
    {
      "journeyID": "688a1139-af13-4b95-b41d-c63109c53003",
      "journeyName": "21",
      "levelID": "f218879f-4990-490d-82eb-27e84552878c",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    },
    {
      "journeyID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
      "journeyName": "2 jornada",
      "levelID": "faabbbc3-f9f5-452b-8a60-2ec2a4bcf3b8",
      "levelDescription": "Nível 3",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    },
    {
      "journeyID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
      "journeyName": "2 jornada",
      "levelID": "d9b733cc-2006-47b8-bc41-8aa5c19876c6",
      "levelDescription": "Nível 2",
      "level": 2,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    },
    {
      "journeyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb",
      "journeyName": "jornada victor",
      "levelID": "c9cb433e-48e6-4023-8448-e54dac6706b1",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    },
    {
      "journeyID": "df459aa5-9fb9-4e4e-ae9f-ff9bfff41bb8",
      "journeyName": "jornada nova",
      "levelID": "63ffb9df-f21d-46f5-bba3-94218e289a52",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    },
    {
      "journeyID": "df459aa5-9fb9-4e4e-ae9f-ff9bfff41bb8",
      "journeyName": "jornada nova",
      "levelID": "63ffb9df-f21d-46f5-bba3-94218e289a52",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "count": "1"
    }
  ],
  "error": null
}

POST Relatório de Jornada detalhado

https://data.tatodesk.com/chatbot/listChatbotJourneyEventsDetailed

Descrição: Retorna todos os eventos individuais de uma jornada de chatbot dentro de um período, com informações detalhadas de cada interação, sessão e etapa percorrida pelo usuário.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/chatbot/listChatbotJourneyEventsDetailed' \
--header 'TATODESK-API-KEY: {{TATODESK-MODELO-GERAL}}' \
--data '{
    "filter": {
        "dateInitial": "01/03/2025",
        "dateFinal": "19/03/2025",
        "chatbotID": "",
        "chatbotJourneyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb"
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "count": "1",
  "events": [
    {
      "journeyID": "1f89759b-deba-4495-98d2-cc1f14023ce2",
      "journeyName": "Teste Adauto 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
      "levelID": "b9ae080e-7b0b-44bc-8e2b-f07a6cfc2849",
      "levelDescription": "teste 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "date": "2025-03-13T17:38:24.081Z",
      "sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
      "appStoreType": "webchat"
    },
    {
      "journeyID": "688a1139-af13-4b95-b41d-c63109c53003",
      "journeyName": "21",
      "levelID": "f218879f-4990-490d-82eb-27e84552878c",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "date": "2025-03-13T17:38:24.081Z",
      "sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
      "appStoreType": "webchat"
    },
    {
      "journeyID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
      "journeyName": "2 jornada",
      "levelID": "faabbbc3-f9f5-452b-8a60-2ec2a4bcf3b8",
      "levelDescription": "Nível 3",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "date": "2025-03-13T17:38:24.081Z",
      "sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
      "appStoreType": "webchat"
    },
    {
      "journeyID": "9f4ee55d-4084-48cc-bbab-362205f82ffb",
      "journeyName": "jornada victor",
      "levelID": "c9cb433e-48e6-4023-8448-e54dac6706b1",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "date": "2025-03-13T17:38:24.081Z",
      "sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
      "appStoreType": "webchat"
    },
    {
      "journeyID": "df459aa5-9fb9-4e4e-ae9f-ff9bfff41bb8",
      "journeyName": "jornada nova",
      "levelID": "63ffb9df-f21d-46f5-bba3-94218e289a52",
      "levelDescription": "Nível 1",
      "level": 1,
      "chatbotEventTagName": "PRIMEIRO_ACESSO",
      "date": "2025-03-13T17:38:24.081Z",
      "sessionID": "fdfb1379-4e3d-493f-9054-8dc15d47765d",
      "appStoreType": "webchat"
    }
  ],
  "error": null
}

POST Relatório de Notificações Avulsas

https://data.tatodesk.com/mkt/listLooseNotificationsReport

Descrição: Retorna um relatório detalhado das notificações avulsas (SMS, e-mail ou WhatsApp) enviadas manualmente ou via API, permitindo filtrar por período, serviço, usuário, chave de API ou template. Ideal para auditoria, controle de disparos e acompanhamento de status.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/mkt/listLooseNotificationsReport' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "filter": {
        "dateInitial": "01/01/2021",
        "dateFinal": "01/05/2025",
        "mktTemplateIDs": [],
        "userIDs": [25],
        "apiKeyIDs": [],
        "service": "whatsapp"
    },
    "page": 0,
    "limit": 10
}'

POST Obter Sessão

https://data.tatodesk.com/mp/getMessagingSession

Descrição: Retorna os detalhes completos de uma sessão de mensagens (por exemplo, de WhatsApp), incluindo status, contato associado, canal e horários de criação e atualização. É útil para consultar informações de uma conversa específica, validar status de atendimento ou integrar dados de sessão em relatórios.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/chatbot/listChatbotEventFeedbacksByFilter' \
--header 'TATODESK-API-KEY: {{API_KEY_MODEL}}' \
--data '{
    "filter": {
        "initialDate": "15/05/2025",
        "finalDate": "21/05/2025",
        "chatbotTagIds": [""],
        "sessionID": ""
    },
    "page": 0,
    "limit": 0
}'

Exemplo de Response:

{
  "conversations": [
    {
      "chatbotEventFeedbackID": "46a7e47a-edcb-4f2b-90ed-a0bccf41ac20",
      "rate": null,
      "observation": "oi",
      "isSolvedProblem": null,
      "chatbotEventTagID": null,
      "chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
      "sessionID": "174a196b-fb1b-4be6-ac21-8c9e0014fdea",
      "accountID": 241,
      "createdAt": "2025-05-19T09:25:36.497Z",
      "updatedAt": "2025-05-19T09:25:36.497Z"
    },
    {
      "chatbotEventFeedbackID": "50af9fd8-e076-42c9-91aa-b982725eaeb8",
      "rate": 1,
      "observation": "Nada",
      "isSolvedProblem": null,
      "chatbotEventTagID": null,
      "chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
      "sessionID": "229c8ff5-eb6c-48e1-9114-32cefb714c95",
      "accountID": 241,
      "createdAt": "2025-05-16T17:33:32.293Z",
      "updatedAt": "2025-05-16T17:33:32.293Z"
    }
  ],
  "count": "2",
  "error": null
}

POST Lista Avaliações

https://data.tatodesk.com/chatbot/listChatbotEventFeedbacksByFilter

Descrição: Retorna a lista de feedbacks (avaliações e observações) enviados pelos usuários em interações com o chatbot. Permite filtrar os registros por intervalo de datas ou por número de sessão específica, além de possibilitar a paginação dos resultados.

Exemplo de Request:

curl --location 'https://data.tatodesk.com/chatbot/listChatbotEventFeedbacksByFilter' \
--header 'TATODESK-API-KEY: {{API_KEY_MODEL}}' \
--data '{
    "filter": {
        "initialDate": "15/05/2025",
        "finalDate": "21/05/2025",
        "chatbotTagIds": [""],
        "sessionID": ""
    },
    "page": 0,
    "limit": 0
}'

Exemplo de Response:

{
  "conversations": [
    {
      "chatbotEventFeedbackID": "46a7e47a-edcb-4f2b-90ed-a0bccf41ac20",
      "rate": null,
      "observation": "oi",
      "isSolvedProblem": null,
      "chatbotEventTagID": null,
      "chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
      "sessionID": "174a196b-fb1b-4be6-ac21-8c9e0014fdea",
      "accountID": 241,
      "createdAt": "2025-05-19T09:25:36.497Z",
      "updatedAt": "2025-05-19T09:25:36.497Z"
    },
    {
      "chatbotEventFeedbackID": "50af9fd8-e076-42c9-91aa-b982725eaeb8",
      "rate": 1,
      "observation": "Nada",
      "isSolvedProblem": null,
      "chatbotEventTagID": null,
      "chatbotID": "ca94fe34-7581-4268-84bc-7f3383e9ab08",
      "sessionID": "229c8ff5-eb6c-48e1-9114-32cefb714c95",
      "accountID": 241,
      "createdAt": "2025-05-16T17:33:32.293Z",
      "updatedAt": "2025-05-16T17:33:32.293Z"
    }
  ],
  "count": "2",
  "error": null
}

CRM

POST Lista Objetos

https://api-v2.tatodesk.com/crm/v1/listObject

Descrição: Retorna os registros de um objeto personalizado criado no módulo CRM (ex: “Vendas”, “Clientes”, “Pedidos”). Permite aplicar filtros, ordenações e seleção de campos específicos, tornando possível montar relatórios e consultas dinâmicas.

Exemplo de Request:

curl --location 'https://api-v2.tatodesk.com/crm/v1/listObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'

Exemplo de Response:

{
  "dataObject": {
    "tableName": "Vendas",
    "tableColumns": [
      {
        "name": "Produto",
        "type": "text",
        "values": null
      },
      {
        "name": "Valor",
        "type": "numeric",
        "values": null
      },
      {
        "name": "Data",
        "type": "timestamp",
        "values": null
      },
      {
        "name": "Status",
        "type": "type",
        "values": [
          {
            "name": "Em processamento",
            "color": "#e70d0d"
          },
          {
            "name": "Pago",
            "color": "#504e4e"
          },
          {
            "name": "Entregue",
            "color": "#14e117"
          }
        ]
      },
      {
        "name": "Usuario",
        "type": "integer",
        "values": null
      }
    ],
    "tableData": []
  },
  "count": "0",
  "error": null
}

POST Cria Objeto

https://api.tatodesk.com/crm/v1/insertObject

Descrição: Cria um novo registro em um objeto do CRM (como “Vendas”, “Clientes” ou “Pedidos”), informando os campos e valores correspondentes. O sistema realiza validação automática de campos obrigatórios definidos na configuração do objeto.

Exemplo de Request:

curl --location 'https://api-v2.tatodesk.com/crm/v1/insertObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'

Exemplo de Response:

{
  "dataObject": {
    "accountID": 1,
    "createdAt": "2025-09-11T20:20:51.031Z",
    "updatedAt": "2025-09-11T20:20:51.031Z",
    "id": "8b7d02b9-bff1-40d2-81ee-10ac90886d21",
    "Produto": "Refrigerante"
  },
  "error": null
}

POST Edita Objeto

https://api.tatodesk.com/crm/v1/updateObject

Descrição: Remove um registro específico de um objeto CRM (como “vendas”, “clientes”, “pedidos” etc.). A exclusão é feita com base no ID do registro, e não no ID do objeto ou estrutura do CRM.

Exemplo de Request:

curl --location 'https://api-v2.tatodesk.com/crm/v1/deleteObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'

Exemplo de Response:

{
  "error": null
}

POST Deletar Objeto

https://api.tatodesk.com/crm/v1/deleteObject

Descrição: Remove um registro específico de um objeto personalizado criado no módulo CRM (ex: “Vendas”, “Clientes”, “Pedidos”). A exclusão é feita informando o nome da entidade (apiName) e o identificador único (ID) do registro desejado.

Exemplo de Request:

curl --location 'https://api-v2.tatodesk.com/crm/v1/deleteObject' \
--header 'TATODESK-API-KEY: {{API-KEY-CRM}}'

Exemplo de Response:

{
  "error": null
}

Contact Center

POST Listar Departamentos

https://api.tatodesk.com/cc/v1/listDepartments

Descrição: Retorna uma lista paginada de departamentos ativos e inativos cadastrados no Contact Center. Esse endpoint é útil para consultar o nome e o ID dos departamentos, que podem ser utilizados em outras integrações (como roteamento de chamados, atendimentos, entre outros).

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listDepartments' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "departments": [
    {
      "ID": 334,
      "name": "am-civil",
      "isActive": 1
    },
    {
      "ID": 335,
      "name": "am-criminal",
      "isActive": 1
    },
    {
      "ID": 336,
      "name": "am-familia",
      "isActive": 1
    },
    {
      "ID": 337,
      "name": "am-plantão",
      "isActive": 1
    },
    {
      "ID": 52,
      "name": "Atendimento REFIS",
      "isActive": 1
    },
    {
      "ID": 7,
      "name": "Cobrança",
      "isActive": 1
    },
    {
      "ID": 3,
      "name": "Conta",
      "isActive": 1
    },
    {
      "ID": 68,
      "name": "DEPART FIESC",
      "isActive": 1
    },
    {
      "ID": 726,
      "name": "Departamento com limite",
      "isActive": 1
    },
    {
      "ID": 1110,
      "name": "Depto. Teste",
      "isActive": 1
    }
  ],
  "count": 29,
  "error": null
}

POST Listar Grupo de Atendimentos

https://api.tatodesk.com/cc/v1/listAttendanceGroups

Descrição: Retorna uma lista paginada de grupos de atendimento vinculados a departamentos específicos. Os grupos de atendimento organizam operadores e horários, permitindo definir regras e filas de atendimento.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listAttendanceGroups' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "filter": {
        "attendanceGroupIDs":[],
        "departmentIDs": [],
        "isNormalOpenningHour": 1
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "attendanceGroups": [
    {
      "ID": 305,
      "name": "Apresentação",
      "description": "Apresentação 09/10/24",
      "isActive": 1,
      "departmentID": 7
    },
    {
      "ID": 64,
      "name": "Cobrança",
      "description": "Grupo de Cobrança",
      "isActive": 2,
      "departmentID": 7
    },
    {
      "ID": 6,
      "name": "Contas",
      "description": "Contas",
      "isActive": 1,
      "departmentID": 3
    },
    {
      "ID": 13,
      "name": "Doações",
      "description": "Doações",
      "isActive": 2,
      "departmentID": 3
    },
    {
      "ID": 3,
      "name": "Documentos insuficientes para parcelar",
      "description": "Documentos insuficientes para parcelar",
      "isActive": 2,
      "departmentID": 2
    },
    {
      "ID": 144,
      "name": "Geral",
      "description": "Geral",
      "isActive": 1,
      "departmentID": 63
    },
    {
      "ID": 21,
      "name": "Grandes Empresas",
      "description": "Grandes Empresas",
      "isActive": 2,
      "departmentID": 17
    },
    {
      "ID": 74,
      "name": "Imoveis acima de 1.000.000,00",
      "description": "Imoveis acima de 1.000.000,00",
      "isActive": 2,
      "departmentID": 3
    },
    {
      "ID": 135,
      "name": "Interior",
      "description": "Interior",
      "isActive": 2,
      "departmentID": 338
    },
    {
      "ID": 75,
      "name": "Já sou cliente",
      "description": "Já sou cliente",
      "isActive": 2,
      "departmentID": 67
    }
  ],
  "count": 43,
  "error": null
}

POST Listar Especialidades

https://api.tatodesk.com/cc/v1/listGroupSpecializations

Descrição: Retorna uma lista de especialidades (ou subdivisões) vinculadas a um grupo de atendimento específico. Cada especialidade representa uma área, localidade ou tipo de serviço dentro de um grupo de atendimento.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listGroupSpecializations' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "filter": {
        "attendanceGroupID": 455,
        "groupSpecializationIDs": [],
        "departmentIDs": [],
        "isNormalOpenningHour": 1
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "specializations": [
    {
      "ID": 165,
      "name": "Aracaju",
      "isActive": 1,
      "attendanceGroupID": 455
    },
    {
      "ID": 166,
      "name": "Nossa Senhora do Socorro Piedade/Soledade",
      "isActive": 1,
      "attendanceGroupID": 455
    }
  ],
  "count": 2,
  "error": null
}

POST Listar Subspecialidades

https://api.tatodesk.com/cc/v1/listSubSpecializations

Descrição: Retorna uma lista de subespecialidades associadas a uma especialidade específica (ou grupo de especializações). Cada subespecialidade representa uma subdivisão mais detalhada dentro de uma especialidade — como um bairro, setor ou categoria de serviço.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listSubSpecializations' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "filter": {
        "groupSpecializationID": 165,
        "subSpecializationIDs": [],
        "departmentIDs": [],
        "isNormalOpenningHour": 1
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "subSpecializations": [
    {
      "ID": 375,
      "name": "13 de Julho",
      "isActive": 1,
      "groupSpecializationID": 165
    },
    {
      "ID": 376,
      "name": "Coroa do meio",
      "isActive": 1,
      "groupSpecializationID": 165
    }
  ],
  "count": 2,
  "error": null
}

POST Listar Áreas

https://api.tatodesk.com/cc/v1/listAreas

Descrição: Retorna uma lista de áreas associadas a uma subespecialidade específica. As áreas representam subdivisões operacionais ou temáticas dentro de uma subespecialidade — por exemplo, setores, tipos de serviço ou categorias específicas de atendimento.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listAreas' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "filter": {
        "subspecializationID": 375,
        "areaIDs": [],
        "departmentIDs": [],
        "isNormalOpenningHour": 1
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "areas": [
    {
      "ID": 940,
      "name": "Bares",
      "isActive": 1,
      "subspecializationID": 375,
      "departmentID": 337
    },
    {
      "ID": 941,
      "name": "Restaurantes",
      "isActive": 1,
      "subspecializationID": 375,
      "departmentID": 52
    }
  ],
  "count": 2,
  "error": null
}

POST Listar Subáreas

https://api.tatodesk.com/cc/v1/listSubAreas

Descrição: Esse endpoint retorna a lista de subáreas associadas a uma área específica. As subáreas representam subdivisões dentro de uma área cadastrada.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listSubAreas' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "filter": {
        "areaID": 940,
        "subAreaIDs": [],
        "departmentIDs": [],
        "isNormalOpenningHour": 1
    },
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "subAreas": [
    {
      "ID": 700,
      "name": "Budega do Jorjão",
      "isActive": 1,
      "areaID": 940,
      "departmentID": null
    },
    {
      "ID": 699,
      "name": "Chopp 13",
      "isActive": 1,
      "areaID": 940,
      "departmentID": null
    }
  ],
  "count": 2,
  "error": null
}

POST Listar Horários de Atendimento

https://api.tatodesk.com/cc/v1/listOpeningHours

Descrição: Retorna a lista de horários de funcionamento de um grupo de atendimento específico, filtrando por grupo de atendimento, especialidade, subespecialidade, área e subárea.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listOpeningHours' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceGroupID": 455,
    "groupSpecializationID": 165,
    "subSpecializationID": 375, 
    "areaID": 940,
    "subAreaID": 699
}'

Exemplo de Response:

{
  "object": "general",
  "openingHours": [
    {
      "dayID": 1,
      "day": "Domingo",
      "startTime": "00:00:00",
      "endTime": "23:59:00"
    },
    {
      "dayID": 2,
      "day": "Segunda-Feira",
      "startTime": "00:01:00",
      "endTime": "23:59:00"
    },
    {
      "dayID": 3,
      "day": "Terça-Feira",
      "startTime": "10:19:00",
      "endTime": "19:19:00"
    },
    {
      "dayID": 3,
      "day": "Terça-Feira",
      "startTime": "22:53:00",
      "endTime": "23:53:00"
    },
    {
      "dayID": 4,
      "day": "Quarta-Feira",
      "startTime": "00:00:00",
      "endTime": "23:59:00"
    },
    {
      "dayID": 5,
      "day": "Quinta-Feira",
      "startTime": "00:00:00",
      "endTime": "23:59:00"
    },
    {
      "dayID": 6,
      "day": "Sexta-Feira",
      "startTime": "14:00:00",
      "endTime": "23:59:00"
    },
    {
      "dayID": 7,
      "day": "Sábado",
      "startTime": "00:00:00",
      "endTime": "23:12:00"
    }
  ],
  "error": null
}

POST Listar Exceções do Horário de Atendimento

https://api.tatodesk.com/cc/v1/listOpeningHourExceptions

Descrição: Retorna as exceções dos horários de atendimento cadastradas para determinado grupo, especialidade, subespecialidade, área e subárea.

Essas exceções representam alterações pontuais no horário normal de funcionamento, como feriados, manutenções ou eventos específicos que modificam a disponibilidade padrão.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/cc/v1/listOpeningHourExceptions' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "attendanceGroupID": 455,
    "groupSpecializationID": 165,
    "subSpecializationID": 375, 
    "areaID": 940,
    "subAreaID": 699
}'

Exemplo de Response:

{
  "object": "general",
  "exceptions": [
    {
      "description": "teste",
      "date": "2024-11-22",
      "startTime": "00:00:00",
      "endTime": "23:59:00",
      "observation": null
    },
    {
      "description": "dia do trabalho",
      "date": "2025-05-01",
      "startTime": "00:00:00",
      "endTime": "23:59:00",
      "observation": "Dia do trabalho"
    },
    {
      "description": "Feriado da confraternização universal.",
      "date": "2023-01-01",
      "startTime": "00:00:00",
      "endTime": "23:59:00",
      "observation": "Feriado da confraternização universal."
    },
    {
      "description": "Ano novo.",
      "date": "2023-01-01",
      "startTime": "00:00:00",
      "endTime": "23:59:00",
      "observation": "Ano novo."
    },
    {
      "description": "Feriado municipal de Recife",
      "date": "2021-12-08",
      "startTime": "00:00:00",
      "endTime": "23:59:00",
      "observation": "Feriado municipal de Recife"
    },
    {
      "description": "teste adauto",
      "date": "2025-05-28",
      "startTime": "00:00:00",
      "endTime": "23:59:00",
      "observation": "testeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeetesteeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeetesteeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeetesteeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"
    }
  ],
  "error": null
}

Pulse

POST Criar sessão de Aplicativo

https://api.tatodesk.com/pulse/v1/createAppSession

Descrição: Essa rota cria uma sessão de aplicativo, permitindo que o sistema reconheça e autentique um app que está se conectando à API do TatoDesk.

Exemplo de Request:

curl --location 'https://api-v2.tatodesk.com/pulse/v1/createAppSession' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "client": {
        "clientVersionApp": "v1.0.0",
        "appID": "8cba24be-596e-4758-85bc-b4964ff78f98"
    },
    "payload": {
        "os": "android",
        "language": "pt-BR",
        "screen": "1200x800",
        "platform": "mobile"
    }
}'

Exemplo de Response:

{
  "session": "c23a31c7-7bf1-4972-855a-da6dad2bc5d9",
  "error": null
}

POST Registrar evento

https://api.tatodesk.com/pulse/v1/createEvent

Descrição: Essa rota registra eventos personalizados relacionados a uma sessão de aplicativo no TatoDesk. Serve para acompanhar ações do usuário dentro do app — como cliques, acessos, visualizações de tela, erros ou qualquer tipo de evento que você deseje rastrear.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/pulse/v1/createEvent' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "data": { "METADATA_KEY": "METADATA_VALUE" },
    "appID": "8cba24be-596e-4758-85bc-b4964ff78f98",
    "appSessionID": "c23a31c7-7bf1-4972-855a-da6dad2bc5d9",
    "tag": "Sessão Personalizada"
}
'

Chatbot

POST Listar Jornadas

https://api.tatodesk.com/chatbot/v1/listChatbotJourneys

Descrição: Esta rota retorna a lista de jornadas de chatbot cadastradas no sistema. Cada jornada representa um fluxo automatizado de atendimento, podendo estar ativa ou inativa.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/chatbot/v1/listChatbotJourneys' \
--header 'TATODESK-API-KEY: {{TATODESK-API-KEY}}' \
--data '{
    "page": 0,
    "limit": 10
}'

Exemplo de Response:

{
  "journeys": [
    {
      "ID": "7da3e4e2-bd3c-47d1-88f2-e2d3db74066f",
      "description": "2 jornada",
      "isActive": 1
    },
    {
      "ID": "688a1139-af13-4b95-b41d-c63109c53003",
      "description": "21",
      "isActive": 1
    },
    {
      "ID": "d3ab6c40-9e3d-4d1a-b463-1077904079fc",
      "description": "Jornada de Sucessos teste atos",
      "isActive": 1
    },
    {
      "ID": "95f19173-ea4b-4cb0-8c1f-e88da925fce1",
      "description": "Teste Adauto ",
      "isActive": 1
    },
    {
      "ID": "639a640b-5392-4526-9d2e-ee0575a14e6c",
      "description": "Teste Adauto 1",
      "isActive": 1
    },
    {
      "ID": "ed9d79b3-0442-47a8-abfe-55528c75168a",
      "description": "Teste Adauto 111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
      "isActive": 1
    },
    {
      "ID": "1f89759b-deba-4495-98d2-cc1f14023ce2",
      "description": "Teste Adauto 1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
      "isActive": 1
    },
    {
      "ID": "7146dcdb-b90f-40c9-8c0b-a107720091c1",
      "description": "Teste David",
      "isActive": 1
    },
    {
      "ID": "e4dd3c45-5ba9-421c-bfac-465ae741168c",
      "description": "Teste David bot",
      "isActive": 1
    },
    {
      "ID": "86670f0d-048f-4c10-a498-f003eb6e2298",
      "description": "Teste Emanuel",
      "isActive": 1
    }
  ],
  "count": 14,
  "error": null
}

Survey

POST Formulários

https://api.tatodesk.com/survey/v1/getSurveyForm

Descrição: Esta rota retorna os detalhes completos de um formulário de pesquisa (survey) específico no sistema. É utilizada para visualizar as informações configuradas no formulário, como nome, descrição, imagem, cores e tipo de escala.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/survey/v1/getSurveyForm' \
--header 'TATODESK-API-KEY: bc363b4a-ebeb-4625-97e6-e74d2def2723' \
--data '{
    "surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25"
}'

Exemplo de Response:

{
  "surveyForm": {
    "surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
    "name": "Formulário Modelo",
    "description": "Formulário Modelo",
    "color": "#00ff55",
    "image": "https://public-file.tatodesk.net/general/file?file=979b2d33-23c9-4d3f-934f-7ac020b41d74",
    "scale": "scale_one_to_ten",
    "isActive": 1,
    "isDeleted": 2,
    "userID": 4405,
    "accountID": 241,
    "responseFlowType": "full",
    "createdAt": "2025-10-17T08:33:32.214Z",
    "updatedAt": "2025-10-17T08:33:32.214Z",
    "questions": [
      {
        "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d",
        "question": "Qual sua avaliação para nosso atendimento?",
        "questionType": "check",
        "weight": 1,
        "textRates": null,
        "isRequired": 1,
        "sort": 1,
        "scale": "scale_one_to_five",
        "isDeleted": 2,
        "surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
        "options": [
          {
            "surveyFormQuestionOptionID": "9e54ca0e-b640-454a-813a-0c0ab962dde1",
            "option": "😡 Ruim",
            "rate": 1,
            "sort": 1,
            "isDeleted": 2,
            "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
          },
          {
            "surveyFormQuestionOptionID": "abd6ccf0-47fc-4b6c-9a62-b0333a8c8a88",
            "option": "😕 Razoável",
            "rate": 2,
            "sort": 2,
            "isDeleted": 2,
            "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
          },
          {
            "surveyFormQuestionOptionID": "99aec891-ada3-480d-88be-4521c50782e7",
            "option": "😐 Regular",
            "rate": 3,
            "sort": 3,
            "isDeleted": 2,
            "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
          },
          {
            "surveyFormQuestionOptionID": "c0dcf185-e10c-41ba-862d-1bc96a3ded47",
            "option": "😊 Bom",
            "rate": 4,
            "sort": 4,
            "isDeleted": 2,
            "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
          },
          {
            "surveyFormQuestionOptionID": "5826429b-6604-487e-be07-7218d06e8775",
            "option": "🤩 Excelente",
            "rate": 5,
            "sort": 5,
            "isDeleted": 2,
            "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d"
          }
        ],
        "formatPreviewOptions": "vertical"
      },
      {
        "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561",
        "question": "Quais dos motivos abaixo se aplicam ao seu contato de hoje?",
        "questionType": "check",
        "weight": 1,
        "textRates": null,
        "isRequired": 1,
        "sort": 2,
        "scale": "scale_one_to_five",
        "isDeleted": 2,
        "surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
        "options": [
          {
            "surveyFormQuestionOptionID": "862f18e2-38e7-463c-b0c3-1d88bc86bfd5",
            "option": "💧 Falta de água",
            "rate": 1,
            "sort": 1,
            "isDeleted": 2,
            "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
          },
          {
            "surveyFormQuestionOptionID": "36d3f5d0-0dc9-4c7a-9970-9b7820f61838",
            "option": "💡 Conta / Fatura",
            "rate": 2,
            "sort": 2,
            "isDeleted": 2,
            "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
          },
          {
            "surveyFormQuestionOptionID": "070ee2f4-c611-4e69-8cec-d6da8dc0caa4",
            "option": "🧾 Segunda via",
            "rate": 3,
            "sort": 3,
            "isDeleted": 2,
            "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
          },
          {
            "surveyFormQuestionOptionID": "f09f8747-3423-4732-954f-c3b6c82d97b3",
            "option": "🔧 Manutenção",
            "rate": 4,
            "sort": 4,
            "isDeleted": 2,
            "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
          },
          {
            "surveyFormQuestionOptionID": "9b008637-a345-48c1-aa1b-fa97a0aa3d1d",
            "option": "📝 Outros",
            "rate": 5,
            "sort": 5,
            "isDeleted": 2,
            "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561"
          }
        ],
        "formatPreviewOptions": "vertical"
      },
      {
        "surveyFormQuestionID": "2c4f2484-d530-47fc-9274-68487eaf796e",
        "question": "Qual sua sugestão/reclamação para nosso serviço?",
        "questionType": "text",
        "weight": 1,
        "textRates": [
          {
            "rate": 1,
            "description": "Qual sua sugestão/reclamação para nosso serviço?"
          }
        ],
        "isRequired": 1,
        "sort": 3,
        "scale": "scale_one_to_ten",
        "isDeleted": 2,
        "surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
        "options": [],
        "formatPreviewOptions": ""
      }
    ],
    "footer": "tatodesk",
    "finalMessage": "Obrigado por nos avaliar",
    "shortID": "59rWwm6",
    "tagIDs": []
  }
}

POST Registrar respostas do formulário

https://api.tatodesk.com/survey/v1/registerSurveyAnswer

Descrição: Essa requisição registra as respostas fornecidas por um usuário em um formulário de pesquisa (survey). Ela envia tanto informações de identificação do formulário quanto o conjunto de perguntas e respostas preenchidas.

Exemplo de Request:

curl --location 'https://api.tatodesk.com/survey/v1/registerSurveyAnswer' \
--header 'TATODESK-API-KEY: {{surveyApiKEy}}' \
--data '{

        "surveyFormID": "76bfdc3d-7185-4c9d-a520-527574e23f25",
        "referenceDate": "10102025",
        "requestDate": "10102025",
        "answers": {
            "answers": [
            {
                "question": "Qual sua avaliação para nosso atendimento?",
                "answerText": "🤩 Excelente",
                "answerValue": 5,
                "questionType": "check",
                "scaleQuestion": "scale_one_to_five",
                "weightQuestion": 1,
                "surveyFormQuestionID": "c800a3a9-1d31-43fd-a8dc-d70bb8fc620d",
                "surveyFormQuestionOptionID": "5826429b-6604-487e-be07-7218d06e8775"
            },
            {
                "question": "Quais dos motivos abaixo se aplicam ao seu contato de hoje?",
                "answerText": "📝 Outros",
                "answerValue": 5,
                "questionType": "check",
                "scaleQuestion": "scale_one_to_five",
                "weightQuestion": 1,
                "surveyFormQuestionID": "5d131fda-0181-4c08-8295-1e62ff572561",
                "surveyFormQuestionOptionID": "9b008637-a345-48c1-aa1b-fa97a0aa3d1d"
            },
            {
                "question": "Qual sua sugestão/reclamação para nosso serviço?",
                "answerText": "Atendimento poderia ser mais humanizado.",
                "answerValue": 1,
                "questionType": "text",
                "scaleQuestion": "scale_one_to_five",
                "weightQuestion": 1,
                "surveyFormQuestionID": "2c4f2484-d530-47fc-9274-68487eaf796e"
            }
            
        ]
        }
    }
    
'

Exemplo de Response:

{
  "error": null
}