GET
/
conversation

​
Example JS Code to Get Conversations by Date

const apiUrl = 'https://api.chatvolt.ai';
const apiKey = 'XXX';

const res = await fetch(
  `${apiUrl}/conversation?agentId=XXX&createdAt=2024-11-01 00:00:00&status=RESOLVED`,
  {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  }
);

Authorizations

Authorization
string
headerrequired

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

Query Parameters

agentId
string

Agent ID to filter conversations. If 'null' (string), searches for conversations not assigned to any agent. Optional.

createdAt
string

Filters conversations created from this date/time (inclusive). Accepted formats include 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DD HH:mm', 'YYYY-MM-DD', or a complete ISO 8601 format. Optional.

status
enum<string>

Filters conversations by status. Optional.

Available options:
RESOLVED,
UNRESOLVED,
HUMAN_REQUESTED

Response

200 - application/json
id
string

The unique identifier for the conversation

title
string | null

The title of the conversation, if available

isAiEnabled
boolean

Indicates whether AI is enabled for the conversation

channel
string

The channel through which the conversation took place (e.g., 'dashboard', 'whatsapp')

status
enum<string>

The current status of the conversation

Available options:
RESOLVED,
UNRESOLVED,
HUMAN_REQUESTED
metadata
object | null

Metadata associated with the conversation, if any

channelExternalId
string | null

External ID of the channel, if any

channelCredentialsId
string | null

ID of the credentials used for the channel

organizationId
string

The organization ID associated with the conversation

mailInboxId
string | null

The mailbox ID, if relevant

priority
enum<string>

The priority of the conversation

Available options:
LOW,
MEDIUM,
HIGH
formId
string | null

ID of the form used, if any

agentId
string | null

The ID of the agent handling the conversation

userId
string | null

The ID of the user associated with the conversation

visitorId
string | null

The ID of the visitor, if applicable

createdAt
string

The date and time when the conversation was created

updatedAt
string

The date and time when the conversation was last updated

participantsContacts
object[]

List of contacts associated with the conversation

conversationVariables
object[]

List of variables associated with the conversation

conversationContexts
object[]

List of contexts associated with the conversation.

Was this page helpful?

Get one MessageGet Conversation By Id