GET
/
v2
/
workspace
/
{workspaceId}
/
chats
curl --request GET \
  --url https://api.gptmaker.ai/v2/workspace/{workspaceId}/chats \
  --header 'Authorization: Bearer <token>'
[
  {
    "humanTalk": true,
    "userPicture": "<string>",
    "messageUserName": "<string>",
    "read": true,
    "role": "<string>",
    "agentName": "<string>",
    "agentId": "<string>",
    "whatsappPhone": "<string>",
    "finished": true,
    "avatar": "<string>",
    "title": "<string>",
    "type": "<string>",
    "userName": "<string>",
    "userId": "<string>",
    "picture": "<string>",
    "conversationType": "<string>",
    "createdAt": 123,
    "name": "<string>",
    "recipient": "<string>",
    "id": "<string>",
    "time": 123,
    "unReadCount": 123,
    "conversation": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

ID do workspace

Query Parameters

agentId
string

ID do agente para filtrar os chats

page
integer

Número da página

pageSize
integer

Tamanho da página

query
string

Filtro para o nome do chat

Response

200
application/json
Lista de chats
humanTalk
boolean

Indica se o chat está no controle de um humano ou do agente.

userPicture
string | null

Imagem do usuário que assumiu o atendimento

messageUserName
string | null

Nome do usuário que enviou a mensagem

read
boolean

Indica se o chat está lido

role
string

Função no chat

agentName
string

Nome do agente

agentId
string

ID do agente

whatsappPhone
string

Número do WhatsApp

finished
boolean

Indica se o chat está finalizado

avatar
string

Avatar do assistente

title
string | null

Título do chat

type
string

Tipo de chat

userName
string | null

Nome do usuário

userId
string | null

ID do usuário

picture
string

Imagem associada ao chat

conversationType
string

Tipo de conversa

createdAt
integer

Data de criação

name
string

Nome do chat

recipient
string

Destinatário do chat

id
string

ID do chat

time
integer

Hora do chat

unReadCount
integer

Contagem de não lidos

conversation
string

Conversa