Conversas

Listar

get

Listagem paginada de conversas.

Autorizações
Parâmetros de consulta
DepartmentIdstring · uuidOpcional

Filtro por ID da equipe.

UserIdstring · uuidOpcional

Filtro por ID do usuário.

TagsIdstring · uuid[]Opcional

Filtro por IDs de etiquetas

TagsNamestring[]Opcional

Filtro por nomes de etiquetas

ChannelsIdstring · uuid[]Opcional

Filtro por ID de canais

ContactIdstring · uuidOpcional

Filtro por ID do contato.

EndAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

EndAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

ActiveAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

ActiveAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

LastInteractionAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

LastInteractionAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1
PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15
OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:
Respostas
200

Success

application/json
get
/v1/session
GET /chat/v1/session HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "updatedAt": "2025-11-06T22:36:22.000Z",
      "startAt": "2025-11-06T22:36:22.000Z",
      "endAt": "2025-11-06T22:36:22.000Z",
      "status": "UNDEFINED",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "previewUrl": "text",
      "title": "text",
      "number": "text",
      "utm": {
        "sourceId": "text",
        "source": "text",
        "clid": "text",
        "medium": "text",
        "campaign": "text",
        "content": "text",
        "headline": "text",
        "term": "text",
        "referralUrl": "text"
      },
      "origin": "text",
      "contactDetails": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "pictureUrl": "text",
        "phonenumber": "text",
        "instagram": "text",
        "phonenumberFormatted": "text",
        "tagsId": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "tagsName": [
          "text"
        ],
        "status": "ACTIVE"
      },
      "agentDetails": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "shortName": "text",
        "phoneNumber": "text",
        "email": "text",
        "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
        "pictureUrl": "text"
      },
      "channelDetails": {
        "humanId": "text",
        "platform": "text",
        "provider": "text",
        "providerVariable": "text",
        "pictureUrl": "text",
        "displayName": "text"
      },
      "departmentDetails": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "isDefault": true,
        "isSupervisor": true
      },
      "classification": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "category": "UNDEFINED",
        "categoryDescription": "text",
        "amount": 1,
        "categoryName": "text"
      },
      "statusDescription": "text",
      "timeService": "text",
      "timeWait": "text",
      "firstResponseAt": "2025-11-06T22:36:22.000Z",
      "botId": "123e4567-e89b-12d3-a456-426614174000",
      "unreadCount": 1,
      "lastMessageText": "text",
      "lastInteractionDate": "2025-11-06T22:36:22.000Z",
      "windowStatus": "ACTIVE",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "channelType": "GUPSHUP_WHATSAPP"
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Obter por ID

get
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Parâmetros de consulta
Respostas
200

Success

application/json
get
/v1/session/{id}
GET /chat/v1/session/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "startAt": "2025-11-06T22:36:22.000Z",
  "endAt": "2025-11-06T22:36:22.000Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:36:22.000Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:36:22.000Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Transferir

put
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Corpo
typestring · enumObrigatório

Determina se a transferência deverá ser entre equipes ou usuários.

Valores possíveis:
newDepartmentIdstring · uuid | nuloOpcional

ID da nova equipe para a conversa.

newUserIdstring · uuid | nuloOpcional

ID do novo usuário para a conversa.

Respostas
200

Success

application/json
put
/v1/session/{id}/transfer
PUT /chat/v1/session/{id}/transfer HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "type": "DEPARTMENT",
  "newDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
  "newUserId": "123e4567-e89b-12d3-a456-426614174000",
  "options": {
    "stopBotInExecution": false
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "startAt": "2025-11-06T22:36:22.000Z",
  "endAt": "2025-11-06T22:36:22.000Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:36:22.000Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:36:22.000Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Atribuir usuário

put
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Corpo
userIdstring · uuidObrigatório

ID do usuário.

Respostas
200

Success

application/json
put
/v1/session/{id}/assignee
PUT /chat/v1/session/{id}/assignee HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "options": {
    "stopBotInExecution": false
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "startAt": "2025-11-06T22:36:22.000Z",
  "endAt": "2025-11-06T22:36:22.000Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:36:22.000Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:36:22.000Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Concluir

put
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Corpo
reactivateOnNewMessagebooleanOpcional

Determina se a conversa deve ser reativada ao receber uma nova mensagem do contato. O valor padrão é false.

Default: false
stopBotInExecutionbooleanOpcional

Determina se o chatbot de automação em execução deve ser interrompido. O valor padrão é false.

Default: false
Respostas
200

Success

application/json
put
/v1/session/{id}/complete
PUT /chat/v1/session/{id}/complete HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "reactivateOnNewMessage": false,
  "stopBotInExecution": false
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "startAt": "2025-11-06T22:36:22.000Z",
  "endAt": "2025-11-06T22:36:22.000Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:36:22.000Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:36:22.000Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Alterar status

put
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Corpo
newStatusstring · enumObrigatório

Novo status para a conversa.

Valores possíveis:
Respostas
200

Success

application/json
put
/v1/session/{id}/status
PUT /chat/v1/session/{id}/status HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "newStatus": "UNDEFINED",
  "options": {
    "stopBotInExecution": false
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "startAt": "2025-11-06T22:36:22.000Z",
  "endAt": "2025-11-06T22:36:22.000Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:36:22.000Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:36:22.000Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Alterar

put

Atualiza um ou mais atributos de uma conversa. Para usar você deve informar o novo valor do atribuito e quais atributos serão atualizados.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Corpo
companyIdstring · uuidOpcional

Código da empresa

statusstring · enum | nuloOpcional

Situação do atendmento

Valores possíveis:
endAtstring · date-time | nuloOpcional

Data de conclusão

numberstring | nuloOpcional

Código de identificação

departmentIdstring · uuid | nuloOpcional

Código da equipe

userIdstring · uuid | nuloOpcional

Código do usuário / atendente

Respostas
200

Success

application/json
put
/v2/session/{id}/partial
PUT /chat/v2/session/{id}/partial HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 403

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "UNDEFINED",
  "endAt": "2025-11-06T22:36:22.000Z",
  "number": "text",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "classification": {
    "description": "text",
    "category": "UNDEFINED",
    "amount": 1
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "options": {
    "stopBotInExecution": false
  },
  "fields": [
    "Status"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "startAt": "2025-11-06T22:36:22.000Z",
  "endAt": "2025-11-06T22:36:22.000Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:36:22.000Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:36:22.000Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Listar mensagens

get

Listagem paginada de mensagens por ID de uma conversa.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da conversa.

Parâmetros de consulta
PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1
PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15
OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:
CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

Respostas
200

Success

application/json
get
/v1/session/{id}/message
GET /chat/v1/session/{id}/message HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "updatedAt": "2025-11-06T22:36:22.000Z",
      "timestamp": "2025-11-06T22:36:22.000Z",
      "type": "TEXT",
      "senderId": "text",
      "sessionId": "123e4567-e89b-12d3-a456-426614174000",
      "templateId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "direction": "FROM_HUB",
      "status": "PROCESSING",
      "origin": "DEFAULT",
      "text": "text",
      "fileId": "123e4567-e89b-12d3-a456-426614174000",
      "refId": "123e4567-e89b-12d3-a456-426614174000",
      "readContactAt": "2025-11-06T22:36:22.000Z",
      "details": {
        "file": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "companyId": "123e4567-e89b-12d3-a456-426614174000",
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "extension": "text",
          "mimeType": "text",
          "type": "UNDEFINED",
          "publicUrl": "text",
          "publicUrlDownload": "text",
          "size": 1,
          "isThumbnail": true,
          "thumbnail": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "publicUrl": "text"
          }
        },
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "extension": "text",
            "mimeType": "text",
            "type": "UNDEFINED",
            "publicUrl": "text",
            "publicUrlDownload": "text",
            "size": 1,
            "isThumbnail": true,
            "thumbnail": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "publicUrl": "text"
            }
          }
        ],
        "fileAsLink": {
          "file": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "extension": "text",
            "mimeType": "text",
            "type": "UNDEFINED",
            "publicUrl": "text",
            "publicUrlDownload": "text",
            "size": 1,
            "isThumbnail": true,
            "thumbnail": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "publicUrl": "text"
            }
          },
          "shortUrl": "text"
        },
        "location": {
          "latitude": 1,
          "longitude": 1,
          "address": "text",
          "name": "text",
          "url": "text"
        },
        "contact": {
          "name": "text",
          "email": "text",
          "phoneNumber": "text",
          "phoneNumberFormatted": "text"
        },
        "errors": [
          {
            "date": "2025-11-06T22:36:22.000Z",
            "origin": "text",
            "key": "text",
            "text": "text"
          }
        ],
        "footerText": "text",
        "utm": {
          "sourceId": "text",
          "source": "text",
          "clid": "text",
          "medium": "text",
          "campaign": "text",
          "content": "text",
          "headline": "text",
          "term": "text",
          "referralUrl": "text"
        },
        "payTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "reactionToContact": "SMILE",
        "reactionFromContact": "text",
        "track": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2025-11-06T22:36:22.000Z",
          "type": "ACCESS_PAGE",
          "pageTitle": "text",
          "pageUrl": "text",
          "pageUtm": {
            "sourceId": "text",
            "source": "text",
            "clid": "text",
            "medium": "text",
            "campaign": "text",
            "content": "text",
            "headline": "text",
            "term": "text",
            "referralUrl": "text"
          },
          "isMobileDevice": true,
          "formData": {
            "name": "text",
            "email": "text",
            "phoneNumber": "text",
            "annotation": "text"
          }
        },
        "transcription": {
          "text": "text",
          "processing": true,
          "error": true
        },
        "templateCategoryId": "123e4567-e89b-12d3-a456-426614174000",
        "templateCategoryName": "text"
      },
      "failedReason": "text",
      "filesIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Enviar mensagem

post

Este endpoint segue as mesmas regras do canal de atendimento, por exemplo: uma conversa só pode ser iniciada no WhatsApp utilizando um modelo de mensagem. Caso o contato não esteja cadastrado, ele será cadastrado automaticamente antes do envio. O envio da mensagem será assincrono, ao enviar a mensagem será salva em uma fila de disparo, e será processada posteriormente. Para verificar a situação do envio, consulte pelo endereço /chat/v1/message/{}/status

Autorizações
Parâmetros de rota
idstring · uuidObrigatório
Corpo
textstring | nuloOpcional

Texto da mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro templateId ou fileUrl.

templateIdstring | nuloOpcional

ID do modelo de mensagem para a mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro text ou fileUrl.

fileUrlstring | nuloOpcional

URL pública de algum arquivo que deseja-se enviar na mensagem. O arquivo enviado deverá seguir as regras do canal de atendimento.

fileIdstring · uuid | nuloOpcional

Código do arquivo que deseja-se enviar na mensagem, o ID pode ser obtido nas rotas /core/v2/file, o arquivo deverá seguir as regras do canal de atendimento.

refIdstring · uuid | nuloOpcional

ID de referência para identificar a mensagem externamente como resposta a uma mensagem anterior.

Respostas
200

Success

application/json
post
/v1/session/{id}/message
POST /chat/v1/session/{id}/message HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "text": "text",
  "templateId": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "fileUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "refId": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "senderId": "text",
  "status": "PROCESSING",
  "statusUrl": "text"
}

Enviar mensagem síncrona

post

Este endpoint segue as mesmas regras do canal de atendimento, por exemplo: uma conversa só pode ser iniciada no WhatsApp utilizando um modelo de mensagem. Caso o contato não esteja cadastrado, ele será cadastrado automaticamente antes do envio. O envio da mensagem será síncrono, então ele pode demorar um tempo até que o servidor do canal de atencimento responda com um status válido para a mensagem. O tempo máximo que este metodo esperará uma resposta é de 25 segundos, após este tempo ele entregará a última situação da mensagem;

Autorizações
Parâmetros de rota
idstring · uuidObrigatório
Corpo
textstring | nuloOpcional

Texto da mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro templateId ou fileUrl.

templateIdstring | nuloOpcional

ID do modelo de mensagem para a mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro text ou fileUrl.

fileUrlstring | nuloOpcional

URL pública de algum arquivo que deseja-se enviar na mensagem. O arquivo enviado deverá seguir as regras do canal de atendimento.

fileIdstring · uuid | nuloOpcional

Código do arquivo que deseja-se enviar na mensagem, o ID pode ser obtido nas rotas /core/v2/file, o arquivo deverá seguir as regras do canal de atendimento.

refIdstring · uuid | nuloOpcional

ID de referência para identificar a mensagem externamente como resposta a uma mensagem anterior.

Respostas
200

Success

application/json
post
/v1/session/{id}/message/sync
POST /chat/v1/session/{id}/message/sync HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "text": "text",
  "templateId": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "fileUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "refId": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "timestamp": "2025-11-06T22:36:22.000Z",
  "type": "TEXT",
  "senderId": "text",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "FROM_HUB",
  "status": "PROCESSING",
  "origin": "DEFAULT",
  "text": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "refId": "123e4567-e89b-12d3-a456-426614174000",
  "readContactAt": "2025-11-06T22:36:22.000Z",
  "details": {
    "file": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "extension": "text",
      "mimeType": "text",
      "type": "UNDEFINED",
      "publicUrl": "text",
      "publicUrlDownload": "text",
      "size": 1,
      "isThumbnail": true,
      "thumbnail": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "text"
      }
    },
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      }
    ],
    "fileAsLink": {
      "file": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      },
      "shortUrl": "text"
    },
    "location": {
      "latitude": 1,
      "longitude": 1,
      "address": "text",
      "name": "text",
      "url": "text"
    },
    "contact": {
      "name": "text",
      "email": "text",
      "phoneNumber": "text",
      "phoneNumberFormatted": "text"
    },
    "errors": [
      {
        "date": "2025-11-06T22:36:22.000Z",
        "origin": "text",
        "key": "text",
        "text": "text"
      }
    ],
    "footerText": "text",
    "utm": {
      "sourceId": "text",
      "source": "text",
      "clid": "text",
      "medium": "text",
      "campaign": "text",
      "content": "text",
      "headline": "text",
      "term": "text",
      "referralUrl": "text"
    },
    "payTransactionId": "123e4567-e89b-12d3-a456-426614174000",
    "reactionToContact": "SMILE",
    "reactionFromContact": "text",
    "track": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "type": "ACCESS_PAGE",
      "pageTitle": "text",
      "pageUrl": "text",
      "pageUtm": {
        "sourceId": "text",
        "source": "text",
        "clid": "text",
        "medium": "text",
        "campaign": "text",
        "content": "text",
        "headline": "text",
        "term": "text",
        "referralUrl": "text"
      },
      "isMobileDevice": true,
      "formData": {
        "name": "text",
        "email": "text",
        "phoneNumber": "text",
        "annotation": "text"
      }
    },
    "transcription": {
      "text": "text",
      "processing": true,
      "error": true
    },
    "templateCategoryId": "123e4567-e89b-12d3-a456-426614174000",
    "templateCategoryName": "text"
  },
  "failedReason": "text",
  "filesIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Listar notas internas

get

Este endpoint permite a listagem de notas internas de um atendimento.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório
Parâmetros de consulta
PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1
PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15
OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:
CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

Respostas
200

Success

application/json
get
/v1/session/{id}/note
GET /chat/v1/session/{id}/note HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "updatedAt": "2025-11-06T22:36:22.000Z",
      "timestamp": "2025-11-06T22:36:22.000Z",
      "type": "TEXT",
      "senderId": "text",
      "sessionId": "123e4567-e89b-12d3-a456-426614174000",
      "templateId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "direction": "FROM_HUB",
      "status": "PROCESSING",
      "origin": "DEFAULT",
      "text": "text",
      "fileId": "123e4567-e89b-12d3-a456-426614174000",
      "refId": "123e4567-e89b-12d3-a456-426614174000",
      "readContactAt": "2025-11-06T22:36:22.000Z",
      "details": {
        "file": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "companyId": "123e4567-e89b-12d3-a456-426614174000",
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "extension": "text",
          "mimeType": "text",
          "type": "UNDEFINED",
          "publicUrl": "text",
          "publicUrlDownload": "text",
          "size": 1,
          "isThumbnail": true,
          "thumbnail": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "publicUrl": "text"
          }
        },
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "extension": "text",
            "mimeType": "text",
            "type": "UNDEFINED",
            "publicUrl": "text",
            "publicUrlDownload": "text",
            "size": 1,
            "isThumbnail": true,
            "thumbnail": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "publicUrl": "text"
            }
          }
        ],
        "fileAsLink": {
          "file": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "extension": "text",
            "mimeType": "text",
            "type": "UNDEFINED",
            "publicUrl": "text",
            "publicUrlDownload": "text",
            "size": 1,
            "isThumbnail": true,
            "thumbnail": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "publicUrl": "text"
            }
          },
          "shortUrl": "text"
        },
        "location": {
          "latitude": 1,
          "longitude": 1,
          "address": "text",
          "name": "text",
          "url": "text"
        },
        "contact": {
          "name": "text",
          "email": "text",
          "phoneNumber": "text",
          "phoneNumberFormatted": "text"
        },
        "errors": [
          {
            "date": "2025-11-06T22:36:22.000Z",
            "origin": "text",
            "key": "text",
            "text": "text"
          }
        ],
        "footerText": "text",
        "utm": {
          "sourceId": "text",
          "source": "text",
          "clid": "text",
          "medium": "text",
          "campaign": "text",
          "content": "text",
          "headline": "text",
          "term": "text",
          "referralUrl": "text"
        },
        "payTransactionId": "123e4567-e89b-12d3-a456-426614174000",
        "reactionToContact": "SMILE",
        "reactionFromContact": "text",
        "track": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2025-11-06T22:36:22.000Z",
          "type": "ACCESS_PAGE",
          "pageTitle": "text",
          "pageUrl": "text",
          "pageUtm": {
            "sourceId": "text",
            "source": "text",
            "clid": "text",
            "medium": "text",
            "campaign": "text",
            "content": "text",
            "headline": "text",
            "term": "text",
            "referralUrl": "text"
          },
          "isMobileDevice": true,
          "formData": {
            "name": "text",
            "email": "text",
            "phoneNumber": "text",
            "annotation": "text"
          }
        },
        "transcription": {
          "text": "text",
          "processing": true,
          "error": true
        },
        "templateCategoryId": "123e4567-e89b-12d3-a456-426614174000",
        "templateCategoryName": "text"
      },
      "failedReason": "text",
      "filesIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Salvar nota interna

post
Autorizações
Parâmetros de rota
idstring · uuidObrigatório
Corpo
textstring | nuloOpcional

Texto da mensagem

filesUrlsstring[] | nuloOpcional

Lista de arquivos (Urls)

filesIdsstring · uuid[] | nuloOpcional

Lista de arquivos (Ids)

Respostas
200

Success

application/json
post
/v1/session/{id}/note
POST /chat/v1/session/{id}/note HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "text": "text",
  "filesUrls": [
    "text"
  ],
  "filesIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "timestamp": "2025-11-06T22:36:22.000Z",
  "type": "TEXT",
  "senderId": "text",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "FROM_HUB",
  "status": "PROCESSING",
  "origin": "DEFAULT",
  "text": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "refId": "123e4567-e89b-12d3-a456-426614174000",
  "readContactAt": "2025-11-06T22:36:22.000Z",
  "details": {
    "file": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "extension": "text",
      "mimeType": "text",
      "type": "UNDEFINED",
      "publicUrl": "text",
      "publicUrlDownload": "text",
      "size": 1,
      "isThumbnail": true,
      "thumbnail": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "text"
      }
    },
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      }
    ],
    "fileAsLink": {
      "file": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      },
      "shortUrl": "text"
    },
    "location": {
      "latitude": 1,
      "longitude": 1,
      "address": "text",
      "name": "text",
      "url": "text"
    },
    "contact": {
      "name": "text",
      "email": "text",
      "phoneNumber": "text",
      "phoneNumberFormatted": "text"
    },
    "errors": [
      {
        "date": "2025-11-06T22:36:22.000Z",
        "origin": "text",
        "key": "text",
        "text": "text"
      }
    ],
    "footerText": "text",
    "utm": {
      "sourceId": "text",
      "source": "text",
      "clid": "text",
      "medium": "text",
      "campaign": "text",
      "content": "text",
      "headline": "text",
      "term": "text",
      "referralUrl": "text"
    },
    "payTransactionId": "123e4567-e89b-12d3-a456-426614174000",
    "reactionToContact": "SMILE",
    "reactionFromContact": "text",
    "track": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "type": "ACCESS_PAGE",
      "pageTitle": "text",
      "pageUrl": "text",
      "pageUtm": {
        "sourceId": "text",
        "source": "text",
        "clid": "text",
        "medium": "text",
        "campaign": "text",
        "content": "text",
        "headline": "text",
        "term": "text",
        "referralUrl": "text"
      },
      "isMobileDevice": true,
      "formData": {
        "name": "text",
        "email": "text",
        "phoneNumber": "text",
        "annotation": "text"
      }
    },
    "transcription": {
      "text": "text",
      "processing": true,
      "error": true
    },
    "templateCategoryId": "123e4567-e89b-12d3-a456-426614174000",
    "templateCategoryName": "text"
  },
  "failedReason": "text",
  "filesIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Obter uma nota interna

get

Este endpoint permite a obtenção de uma nota interna por meio de seu ID.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório
Respostas
200

Success

application/json
get
/v1/session/note/{id}
GET /chat/v1/session/note/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "timestamp": "2025-11-06T22:36:22.000Z",
  "type": "TEXT",
  "senderId": "text",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "FROM_HUB",
  "status": "PROCESSING",
  "origin": "DEFAULT",
  "text": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "refId": "123e4567-e89b-12d3-a456-426614174000",
  "readContactAt": "2025-11-06T22:36:22.000Z",
  "details": {
    "file": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "extension": "text",
      "mimeType": "text",
      "type": "UNDEFINED",
      "publicUrl": "text",
      "publicUrlDownload": "text",
      "size": 1,
      "isThumbnail": true,
      "thumbnail": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "text"
      }
    },
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      }
    ],
    "fileAsLink": {
      "file": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      },
      "shortUrl": "text"
    },
    "location": {
      "latitude": 1,
      "longitude": 1,
      "address": "text",
      "name": "text",
      "url": "text"
    },
    "contact": {
      "name": "text",
      "email": "text",
      "phoneNumber": "text",
      "phoneNumberFormatted": "text"
    },
    "errors": [
      {
        "date": "2025-11-06T22:36:22.000Z",
        "origin": "text",
        "key": "text",
        "text": "text"
      }
    ],
    "footerText": "text",
    "utm": {
      "sourceId": "text",
      "source": "text",
      "clid": "text",
      "medium": "text",
      "campaign": "text",
      "content": "text",
      "headline": "text",
      "term": "text",
      "referralUrl": "text"
    },
    "payTransactionId": "123e4567-e89b-12d3-a456-426614174000",
    "reactionToContact": "SMILE",
    "reactionFromContact": "text",
    "track": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "type": "ACCESS_PAGE",
      "pageTitle": "text",
      "pageUrl": "text",
      "pageUtm": {
        "sourceId": "text",
        "source": "text",
        "clid": "text",
        "medium": "text",
        "campaign": "text",
        "content": "text",
        "headline": "text",
        "term": "text",
        "referralUrl": "text"
      },
      "isMobileDevice": true,
      "formData": {
        "name": "text",
        "email": "text",
        "phoneNumber": "text",
        "annotation": "text"
      }
    },
    "transcription": {
      "text": "text",
      "processing": true,
      "error": true
    },
    "templateCategoryId": "123e4567-e89b-12d3-a456-426614174000",
    "templateCategoryName": "text"
  },
  "failedReason": "text",
  "filesIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Excluir uma nota interna

delete

Este endpoint permite a exclusão de uma nota interna por meio de seu ID.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório
Respostas
200

Success

application/json
delete
/v1/session/note/{id}
DELETE /chat/v1/session/note/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:22.000Z",
  "updatedAt": "2025-11-06T22:36:22.000Z",
  "timestamp": "2025-11-06T22:36:22.000Z",
  "type": "TEXT",
  "senderId": "text",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "FROM_HUB",
  "status": "PROCESSING",
  "origin": "DEFAULT",
  "text": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "refId": "123e4567-e89b-12d3-a456-426614174000",
  "readContactAt": "2025-11-06T22:36:22.000Z",
  "details": {
    "file": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "extension": "text",
      "mimeType": "text",
      "type": "UNDEFINED",
      "publicUrl": "text",
      "publicUrlDownload": "text",
      "size": 1,
      "isThumbnail": true,
      "thumbnail": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "text"
      }
    },
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      }
    ],
    "fileAsLink": {
      "file": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      },
      "shortUrl": "text"
    },
    "location": {
      "latitude": 1,
      "longitude": 1,
      "address": "text",
      "name": "text",
      "url": "text"
    },
    "contact": {
      "name": "text",
      "email": "text",
      "phoneNumber": "text",
      "phoneNumberFormatted": "text"
    },
    "errors": [
      {
        "date": "2025-11-06T22:36:22.000Z",
        "origin": "text",
        "key": "text",
        "text": "text"
      }
    ],
    "footerText": "text",
    "utm": {
      "sourceId": "text",
      "source": "text",
      "clid": "text",
      "medium": "text",
      "campaign": "text",
      "content": "text",
      "headline": "text",
      "term": "text",
      "referralUrl": "text"
    },
    "payTransactionId": "123e4567-e89b-12d3-a456-426614174000",
    "reactionToContact": "SMILE",
    "reactionFromContact": "text",
    "track": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:36:22.000Z",
      "type": "ACCESS_PAGE",
      "pageTitle": "text",
      "pageUrl": "text",
      "pageUtm": {
        "sourceId": "text",
        "source": "text",
        "clid": "text",
        "medium": "text",
        "campaign": "text",
        "content": "text",
        "headline": "text",
        "term": "text",
        "referralUrl": "text"
      },
      "isMobileDevice": true,
      "formData": {
        "name": "text",
        "email": "text",
        "phoneNumber": "text",
        "annotation": "text"
      }
    },
    "transcription": {
      "text": "text",
      "processing": true,
      "error": true
    },
    "templateCategoryId": "123e4567-e89b-12d3-a456-426614174000",
    "templateCategoryName": "text"
  },
  "failedReason": "text",
  "filesIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Atualizado