Retrieve chat details

Retrieves details of a chat by chat_id or external_id

GET /chat/get

Try it

Get chat details

cURL

curl --request GET \
  --url https://api.qtzl.ai/chat/get \
  --header 'api-key: <api-key>'

200

{
  "result": "ok",
  "quetzal_chat_id": "<string>",
  "external_chat_id": "<string>",
  "created_date": "2023-11-07T05:31:56Z",
  "participants": [
    {
      "participant_id": "<string>",
      "role": "<string>",
      "locale": "<string>"
    }
  ],
  "total_messages": 123,
  "external_message_ids": [
    "<string>"
  ]
}

Fetch chat details by providing either an external chat ID, or an assigned Quetzal Chat ID

Authorizations

api-key · string · header · required

API key authentication. You can obtain your API key by registering on your project dashboard.

Query Parameters

chat_id · string · required

Quetzal chat ID (ex: QTZLC001) or external ID of the chat

Response

200

application/json

Chat details retrieved successfully

result · string

Example:

"ok"

quetzal_chat_id · string

The internal chat ID

external_chat_id · string

External identifier for the chat if available

created_date · string<date-time>

Timestamp when the chat was created

participants · object[]

Show child attributes

participants. participant_id · string

Participant ID

participants. role · string

Participant role

participants. locale · string

Participant locale

total_messages · integer

Total number of messages in the chat

external_message_ids · string[]

List of external message IDs in this chat