Conversations

Endpoint

Conversation management

List conversations

GET

https://api-chat.bara.my.id

/api/conversations

Agents see only their own and unassigned conversations. Supervisors and admins see all conversations.

List conversations › query Parameters

status

string · enum

Enum values:

open

pending

resolved

expired

assigned_agent_id

string · uuid

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 20

List conversations › Responses

200

List of conversations with contact info

object[]

id

string · uuid · required

contact_id

string · uuid · required

status

string · enum · required

Enum values:

open

pending

resolved

expired

last_message_at

string · date-time · required

unread_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

contact_channel

string · required

whatsapp, instagram, or email

assigned_agent_id

string · uuid

contact_name

string

contact_phone

string

Get a single conversation

GET

https://api-chat.bara.my.id

/api/conversations/{id}

Get a single conversation › path Parameters

id

string · uuid · required

Get a single conversation › Responses

Conversation details

id

string · uuid · required

contact_id

string · uuid · required

status

string · enum · required

Enum values:

open

pending

resolved

expired

last_message_at

string · date-time · required

unread_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

contact_channel

string · required

whatsapp, instagram, or email

assigned_agent_id

string · uuid

contact_name

string

contact_phone

string

Assign or unassign an agent

PATCH

https://api-chat.bara.my.id

/api/conversations/{id}/assign

Supervisor or admin only. Set agent_id to null to unassign.

Assign or unassign an agent › path Parameters

id

string · uuid · required

Assign or unassign an agent › Request Body

agent_id

string · uuid

Set to null to unassign

Assign or unassign an agent › Responses

Agent assigned

message

string

conversation_id

string · uuid

assigned_agent_id

string · uuid

Update conversation status

PATCH

https://api-chat.bara.my.id

/api/conversations/{id}/status

Update conversation status › path Parameters

id

string · uuid · required

Update conversation status › Request Body

status

string · enum · required

Enum values:

open

pending

resolved

expired

Update conversation status › Responses

200

Status updated

message

string

conversation_id

string · uuid

status

string

Mark conversation as read

POST

https://api-chat.bara.my.id

/api/conversations/{id}/read

Resets the unread_count to 0.

Mark conversation as read › path Parameters

id

string · uuid · required

Mark conversation as read › Responses

200

Marked as read

message

string

conversation_id

string · uuid

unread_count

integer

Expire stale conversations

POST

https://api-chat.bara.my.id

/api/conversations/expire

Supervisor or admin only. Expires open conversations older than 24 hours.

Expire stale conversations › Responses

Conversations expired

message

string

expired_count

integer

Update conversation tags

PATCH

https://api-chat.bara.my.id

/api/conversations/{id}/tags

Replaces the entire tags array on the conversation.

Update conversation tags › path Parameters

id

string · uuid · required

Update conversation tags › Request Body

tags

string[] · required

Update conversation tags › Responses

Tags updated

message

string

conversation_id

string · uuid

tags

string[]

Takeover a conversation

POST

https://api-chat.bara.my.id

/api/conversations/{id}/takeover

Assigns the conversation to the requesting agent.

Takeover a conversation › path Parameters

id

string · uuid · required

Takeover a conversation › Responses

200

Conversation taken over

message

string

conversation_id

string · uuid

assigned_agent_id

string · uuid

Bulk conversation actions

POST

https://api-chat.bara.my.id

/api/conversations/bulk

Apply bulk actions to multiple conversations: resolve, reopen, assign, add/remove tags. Max 100 conversations per request.

Bulk conversation actions › Request Body

conversation_ids

string[] · minItems: 1 · maxItems: 100 · required

required

Bulk conversation actions › Responses

Bulk action applied

message

string

affected_count

integer

Auth Messages

OmniStream CRM API

Conversations

Endpoint

Conversation management

List conversations

GET

https://api-chat.bara.my.id

/api/conversations

Agents see only their own and unassigned conversations. Supervisors and admins see all conversations.

List conversations › query Parameters

status

string · enum

Enum values:

open

pending

resolved

expired

assigned_agent_id

string · uuid

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 20

List conversations › Responses

200

List of conversations with contact info

object[]

id

string · uuid · required

contact_id

string · uuid · required

status

string · enum · required

Enum values:

open

pending

resolved

expired

last_message_at

string · date-time · required

unread_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

contact_channel

string · required

whatsapp, instagram, or email

assigned_agent_id

string · uuid

contact_name

string

contact_phone

string

Get a single conversation

GET

https://api-chat.bara.my.id

/api/conversations/{id}

Get a single conversation › path Parameters

id

string · uuid · required

Get a single conversation › Responses

Conversation details

id

string · uuid · required

contact_id

string · uuid · required

status

string · enum · required

Enum values:

open

pending

resolved

expired

last_message_at

string · date-time · required

unread_count

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

contact_channel

string · required

whatsapp, instagram, or email

assigned_agent_id

string · uuid

contact_name

string

contact_phone

string

Assign or unassign an agent

PATCH

https://api-chat.bara.my.id

/api/conversations/{id}/assign

Supervisor or admin only. Set agent_id to null to unassign.

Assign or unassign an agent › path Parameters

id

string · uuid · required

Assign or unassign an agent › Request Body

agent_id

string · uuid

Set to null to unassign

Assign or unassign an agent › Responses

Agent assigned

message

string

conversation_id

string · uuid

assigned_agent_id

string · uuid

Update conversation status

PATCH

https://api-chat.bara.my.id

/api/conversations/{id}/status

Update conversation status › path Parameters

id

string · uuid · required

Update conversation status › Request Body

status

string · enum · required

Enum values:

open

pending

resolved

expired

Update conversation status › Responses

200

Status updated

message

string

conversation_id

string · uuid

status

string

Mark conversation as read

POST

https://api-chat.bara.my.id

/api/conversations/{id}/read

Resets the unread_count to 0.

Mark conversation as read › path Parameters

id

string · uuid · required

Mark conversation as read › Responses

200

Marked as read

message

string

conversation_id

string · uuid

unread_count

integer

Expire stale conversations

POST

https://api-chat.bara.my.id

/api/conversations/expire

Supervisor or admin only. Expires open conversations older than 24 hours.

Expire stale conversations › Responses

Conversations expired

message

string

expired_count

integer

Update conversation tags

PATCH

https://api-chat.bara.my.id

/api/conversations/{id}/tags

Replaces the entire tags array on the conversation.

Update conversation tags › path Parameters

id

string · uuid · required

Update conversation tags › Request Body

tags

string[] · required

Update conversation tags › Responses

Tags updated

message

string

conversation_id

string · uuid

tags

string[]

Takeover a conversation

POST

https://api-chat.bara.my.id

/api/conversations/{id}/takeover

Assigns the conversation to the requesting agent.

Takeover a conversation › path Parameters

id

string · uuid · required

Takeover a conversation › Responses

200

Conversation taken over

message

string

conversation_id

string · uuid

assigned_agent_id

string · uuid

Bulk conversation actions

POST

https://api-chat.bara.my.id

/api/conversations/bulk

Apply bulk actions to multiple conversations: resolve, reopen, assign, add/remove tags. Max 100 conversations per request.

Bulk conversation actions › Request Body

conversation_ids

string[] · minItems: 1 · maxItems: 100 · required

required

Bulk conversation actions › Responses

Bulk action applied

message

string

affected_count

integer

Auth Messages