List conversations

GET

public

api

conversations

List conversations

curl --request GET \
  --url https://api.gennia.ai/public/api/v1/conversations \
  --header 'X-Api-Key: <api-key>'

{
  "items": [
    {
      "agentPublicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel": "<string>",
      "externalUserId": "<string>",
      "isEnded": true,
      "isPaused": true,
      "isTest": true,
      "lastMessageAt": "2023-11-07T05:31:56Z",
      "lastMessageSnippet": "<string>",
      "messageCount": 123,
      "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123,
  "totalPages": 123
}

Autorizações

X-Api-Key

string

header

obrigatório

Parâmetros de consulta

page

integer<int32>

padrão:1

1-based page index

limit

integer<int32>

padrão:20

Page size (max 100)

agentPublicId

string<uuid>

Filter by agent public ID

externalUserId

string

Filter by end-user identifier

channel

string

Filter by channel type (api|web_chat|whatsapp|z_api)

isTest

boolean

Filter by test flag (omit for both)

isEnded

boolean

Filter by ended status

since

string<date-time>

Only conversations with lastMessageAt >= since (ISO-8601)

until

string<date-time>

Only conversations with lastMessageAt <= until (ISO-8601)

Resposta

items

object[]

Show child attributes

limit

integer<int32>

page

integer<int32>

total

integer<int64>

totalPages

integer<int32>

Delete conversationSoft-delete the conversation.

List conversations

curl --request GET \
  --url https://api.gennia.ai/public/api/v1/conversations \
  --header 'X-Api-Key: <api-key>'

{
  "items": [
    {
      "agentPublicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel": "<string>",
      "externalUserId": "<string>",
      "isEnded": true,
      "isPaused": true,
      "isTest": true,
      "lastMessageAt": "2023-11-07T05:31:56Z",
      "lastMessageSnippet": "<string>",
      "messageCount": 123,
      "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123,
  "totalPages": 123
}