Chat WS API 0.0.11 documentation

Chat WS API 0.0.11

application/json

This Chat API allows your clients and operators to communicate in real time.

Servers

https://sockets-chat.bezlimit.ru/httpschat-sockets
Deafault chat server

Operations

REPLY /chat
Used to send new messages from clients/operators
Operation IDsendMessage
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.
Accepts the following message:
SendMessageEventsendMessageEvent
Event emitted when user sends new message to the chat room
application/json
Message IDsendMessageEvent
object
type
required
string
Event specific type

Const:"send_message"
required
object
Event specific payload data

text
required
string
Text contents of the message

array<string>
Attachments uuid list

Items:
string
Attachment uuid

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "send_message", "data": { "text": "string", "attachments": [ "3f439f10-9c19-4bd4-81a8-d6e048b97ba4" ] } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: /chat
Address: /chat
Available only on servers:
chat-sockets
Messages:
#0SendMessageEventsendMessageEvent
Event emitted when user sends new message to the chat room
application/json
Message IDsendMessageEvent
object
type
required
string
Event specific type

Const:"send_message"
required
object
Event specific payload data

text
required
string
Text contents of the message

array<string>
Attachments uuid list

Items:
string
Attachment uuid

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "send_message", "data": { "text": "string", "attachments": [ "3f439f10-9c19-4bd4-81a8-d6e048b97ba4" ] } }

This example has been generated automatically.
#1MarkMessageDeliveredEventmarkMessageDeliveredEvent
Event emitted when user receives new message
application/json
Message IDmarkMessageDeliveredEvent
object
type
required
string
Event specific type

Const:"mark_message_delivered"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "mark_message_delivered", "data": { "message_id": 0 } }

This example has been generated automatically.
#2MarkMessageReadEventmarkMessageReadEvent
Event emitted when user reads a message
application/json
Message IDmarkMessageReadEvent
object
type
required
string
Event specific type

Const:"mark_message_read"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "mark_message_read", "data": { "message_id": 0 } }

This example has been generated automatically.
#3MessageAddedEventmessageAddedEvent
Event emitted when server adds new message to the room
application/json
Message IDmessageAddedEvent
object
type
required
string
Event specific type

Const:"message_added"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_added", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#4MessageNotAddedEventmessageNotAddedEvent
Event emitted when server could not add new message to the room
application/json
Message IDmessageNotAddedEvent
object
type
required
string
Event specific type

Const:"message_not_added"
required
object
Event specific payload data

text
required
string
Text contents of the message

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_not_added", "data": { "text": "string", "sender": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#5MessageUpdatedEventmessageUpdatedEvent
Event emitted when server modifies existing message in the room
application/json
Message IDmessageUpdatedEvent
object
type
required
string
Event specific type

Const:"message_updated"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_updated", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#6UserConnectedEventuserConnectedEvent
Event emitted by server when user connects to the room
application/json
Message IDuserConnectedEvent
object
type
required
string
Event specific type

Const:"user_connected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "user_connected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#7UserDisconnectedEventuserDisconnectedEvent
Event emitted by server when user disconnects from the room
application/json
Message IDuserDisconnectedEvent
object
type
required
string
Event specific type

Const:"user_disconnected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "user_disconnected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#8UpdateTypingEventupdateTypingEvent
Event emitted when user starts/stops typing
application/json
Message IDupdateTypingEvent
object
type
required
string
Event specific type

Const:"update_typing"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "update_typing", "data": { "text": "string", "stopped": true } }

This example has been generated automatically.
#9TypingUpdatedEventtypingUpdatedEvent
Event emitted by server when user starts/stops typing
application/json
Message IDtypingUpdatedEvent
object
type
required
string
Event specific type

Const:"typing_updated"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

chat_id
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "typing_updated", "data": { "text": "string", "stopped": true, "chat_id": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.

#0MessageAddedEventmessageAddedEvent
Event emitted when server adds new message to the room
application/json
Message IDmessageAddedEvent
object
type
required
string
Event specific type

Const:"message_added"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_added", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#1MessageNotAddedEventmessageNotAddedEvent
Event emitted when server could not add new message to the room
application/json
Message IDmessageNotAddedEvent
object
type
required
string
Event specific type

Const:"message_not_added"
required
object
Event specific payload data

text
required
string
Text contents of the message

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_not_added", "data": { "text": "string", "sender": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
REPLY /chat
Used to notify server that user has successefuly received/read message
Operation IDupdateMessageStatus
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.
Accepts one of the following messages:
- #0MarkMessageDeliveredEventmarkMessageDeliveredEvent
  Event emitted when user receives new message
  application/json
  Message IDmarkMessageDeliveredEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"mark_message_delivered"
  required
  object
  Event specific payload data
  
  message_id
  required
  integer
  Unique message identifier
  
  Additional properties are allowed.
  Additional properties are allowed.
  #source:client
  Examples
  { "type": "mark_message_delivered", "data": { "message_id": 0 } }
  
  This example has been generated automatically.
- #1MarkMessageReadEventmarkMessageReadEvent
  Event emitted when user reads a message
  application/json
  Message IDmarkMessageReadEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"mark_message_read"
  required
  object
  Event specific payload data
  
  message_id
  required
  integer
  Unique message identifier
  
  Additional properties are allowed.
  Additional properties are allowed.
  #source:client
  Examples
  { "type": "mark_message_read", "data": { "message_id": 0 } }
  
  This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: /chat
Address: /chat
Available only on servers:
chat-sockets
Messages:
#0SendMessageEventsendMessageEvent
Event emitted when user sends new message to the chat room
application/json
Message IDsendMessageEvent
object
type
required
string
Event specific type

Const:"send_message"
required
object
Event specific payload data

text
required
string
Text contents of the message

array<string>
Attachments uuid list

Items:
string
Attachment uuid

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "send_message", "data": { "text": "string", "attachments": [ "3f439f10-9c19-4bd4-81a8-d6e048b97ba4" ] } }

This example has been generated automatically.
#1MarkMessageDeliveredEventmarkMessageDeliveredEvent
Event emitted when user receives new message
application/json
Message IDmarkMessageDeliveredEvent
object
type
required
string
Event specific type

Const:"mark_message_delivered"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "mark_message_delivered", "data": { "message_id": 0 } }

This example has been generated automatically.
#2MarkMessageReadEventmarkMessageReadEvent
Event emitted when user reads a message
application/json
Message IDmarkMessageReadEvent
object
type
required
string
Event specific type

Const:"mark_message_read"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "mark_message_read", "data": { "message_id": 0 } }

This example has been generated automatically.
#3MessageAddedEventmessageAddedEvent
Event emitted when server adds new message to the room
application/json
Message IDmessageAddedEvent
object
type
required
string
Event specific type

Const:"message_added"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_added", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#4MessageNotAddedEventmessageNotAddedEvent
Event emitted when server could not add new message to the room
application/json
Message IDmessageNotAddedEvent
object
type
required
string
Event specific type

Const:"message_not_added"
required
object
Event specific payload data

text
required
string
Text contents of the message

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_not_added", "data": { "text": "string", "sender": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#5MessageUpdatedEventmessageUpdatedEvent
Event emitted when server modifies existing message in the room
application/json
Message IDmessageUpdatedEvent
object
type
required
string
Event specific type

Const:"message_updated"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_updated", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#6UserConnectedEventuserConnectedEvent
Event emitted by server when user connects to the room
application/json
Message IDuserConnectedEvent
object
type
required
string
Event specific type

Const:"user_connected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "user_connected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#7UserDisconnectedEventuserDisconnectedEvent
Event emitted by server when user disconnects from the room
application/json
Message IDuserDisconnectedEvent
object
type
required
string
Event specific type

Const:"user_disconnected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "user_disconnected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#8UpdateTypingEventupdateTypingEvent
Event emitted when user starts/stops typing
application/json
Message IDupdateTypingEvent
object
type
required
string
Event specific type

Const:"update_typing"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "update_typing", "data": { "text": "string", "stopped": true } }

This example has been generated automatically.
#9TypingUpdatedEventtypingUpdatedEvent
Event emitted by server when user starts/stops typing
application/json
Message IDtypingUpdatedEvent
object
type
required
string
Event specific type

Const:"typing_updated"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

chat_id
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "typing_updated", "data": { "text": "string", "stopped": true, "chat_id": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.

MessageUpdatedEventmessageUpdatedEvent
Event emitted when server modifies existing message in the room
application/json
Message IDmessageUpdatedEvent
object
type
required
string
Event specific type

Const:"message_updated"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_updated", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
REPLY /chat
Used to notify room about typing updates
Operation IDupdateTyping
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.
Accepts the following message:
UpdateTypingEventupdateTypingEvent
Event emitted when user starts/stops typing
application/json
Message IDupdateTypingEvent
object
type
required
string
Event specific type

Const:"update_typing"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "update_typing", "data": { "text": "string", "stopped": true } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: /chat
Address: /chat
Available only on servers:
chat-sockets
Messages:
#0SendMessageEventsendMessageEvent
Event emitted when user sends new message to the chat room
application/json
Message IDsendMessageEvent
object
type
required
string
Event specific type

Const:"send_message"
required
object
Event specific payload data

text
required
string
Text contents of the message

array<string>
Attachments uuid list

Items:
string
Attachment uuid

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "send_message", "data": { "text": "string", "attachments": [ "3f439f10-9c19-4bd4-81a8-d6e048b97ba4" ] } }

This example has been generated automatically.
#1MarkMessageDeliveredEventmarkMessageDeliveredEvent
Event emitted when user receives new message
application/json
Message IDmarkMessageDeliveredEvent
object
type
required
string
Event specific type

Const:"mark_message_delivered"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "mark_message_delivered", "data": { "message_id": 0 } }

This example has been generated automatically.
#2MarkMessageReadEventmarkMessageReadEvent
Event emitted when user reads a message
application/json
Message IDmarkMessageReadEvent
object
type
required
string
Event specific type

Const:"mark_message_read"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "mark_message_read", "data": { "message_id": 0 } }

This example has been generated automatically.
#3MessageAddedEventmessageAddedEvent
Event emitted when server adds new message to the room
application/json
Message IDmessageAddedEvent
object
type
required
string
Event specific type

Const:"message_added"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_added", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#4MessageNotAddedEventmessageNotAddedEvent
Event emitted when server could not add new message to the room
application/json
Message IDmessageNotAddedEvent
object
type
required
string
Event specific type

Const:"message_not_added"
required
object
Event specific payload data

text
required
string
Text contents of the message

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_not_added", "data": { "text": "string", "sender": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#5MessageUpdatedEventmessageUpdatedEvent
Event emitted when server modifies existing message in the room
application/json
Message IDmessageUpdatedEvent
object
type
required
string
Event specific type

Const:"message_updated"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_updated", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
#6UserConnectedEventuserConnectedEvent
Event emitted by server when user connects to the room
application/json
Message IDuserConnectedEvent
object
type
required
string
Event specific type

Const:"user_connected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "user_connected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#7UserDisconnectedEventuserDisconnectedEvent
Event emitted by server when user disconnects from the room
application/json
Message IDuserDisconnectedEvent
object
type
required
string
Event specific type

Const:"user_disconnected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "user_disconnected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
#8UpdateTypingEventupdateTypingEvent
Event emitted when user starts/stops typing
application/json
Message IDupdateTypingEvent
object
type
required
string
Event specific type

Const:"update_typing"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

Additional properties are allowed.
Additional properties are allowed.
#source:client
Examples
{ "type": "update_typing", "data": { "text": "string", "stopped": true } }

This example has been generated automatically.
#9TypingUpdatedEventtypingUpdatedEvent
Event emitted by server when user starts/stops typing
application/json
Message IDtypingUpdatedEvent
object
type
required
string
Event specific type

Const:"typing_updated"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

chat_id
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "typing_updated", "data": { "text": "string", "stopped": true, "chat_id": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.

TypingUpdatedEventtypingUpdatedEvent
Event emitted by server when user starts/stops typing
application/json
Message IDtypingUpdatedEvent
object
type
required
string
Event specific type

Const:"typing_updated"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

chat_id
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "typing_updated", "data": { "text": "string", "stopped": true, "chat_id": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }

This example has been generated automatically.
SEND /chat
Used to notify users that a new message was added to the room
Operation IDreceiveNewMessage
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.
Accepts the following message:
MessageAddedEventmessageAddedEvent
Event emitted when server adds new message to the room
application/json
Message IDmessageAddedEvent
object
type
required
string
Event specific type

Const:"message_added"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_added", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
SEND /chat
Used to notify users that some message in the current room was updated
Operation IDreceiveMessageUpdate
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.
Accepts the following message:
MessageUpdatedEventmessageUpdatedEvent
Event emitted when server modifies existing message in the room
application/json
Message IDmessageUpdatedEvent
object
type
required
string
Event specific type

Const:"message_updated"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
Examples
{ "type": "message_updated", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }

This example has been generated automatically.
SEND /chat
Used to notify users that somebody just joined/left the room
Operation IDtrackUserConnection
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k","chat_id":"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de","role":"operator"}
token
required
string
User token obtained from main API

role
required
string
Role of the user

Allowed values:
"user"
"operator"
chat_id
string
Chat room identifier to connect user to (only used by operators)

Additional properties are allowed.
Accepts one of the following messages:
- #0UserConnectedEventuserConnectedEvent
  Event emitted by server when user connects to the room
  application/json
  Message IDuserConnectedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"user_connected"
  required
  object
  Event specific payload data
  
  required
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "user_connected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }
  
  This example has been generated automatically.
- #1UserDisconnectedEventuserDisconnectedEvent
  Event emitted by server when user disconnects from the room
  application/json
  Message IDuserDisconnectedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"user_disconnected"
  required
  object
  Event specific payload data
  
  required
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "user_disconnected", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }
  
  This example has been generated automatically.
SEND /broadcast
Used to notify operators about new messages in every room and global updates
Operation IDreceiveBroadcast
Available only on servers:
- chat-sockets
object
object
Query parameters required for successeful connection to channel

Examples values:
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQ2hhdCBVc2VyIiwicm9sZSI6IkNsaWVudCJ9.8SpHT_A3okIpco1W9yiux3YtBeD1mZGUiZuNipYoy5k"}
token
required
string
User token obtained from main API

Additional properties are allowed.
Accepts one of the following messages:
- #0MessageAddedEventmessageAddedEvent
  Event emitted when server adds new message to the room
  application/json
  Message IDmessageAddedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"message_added"
  required
  object
  Event specific payload data
  
  required
  object
  Message related information
  
  id
  required
  integer
  Unique message identifier
  
  type
  required
  string
  Message type
  
  Allowed values:
  "standard"
  "system"
  type_role
  required
  string
  Role of the user to whom this message is adressed
  
  Allowed values:
  "user"
  "operator"
  status
  required
  string
  Message delivery status
  
  Allowed values:
  "new"
  "delivered"
  "read"
  text
  required
  string
  Message text contents
  
  send_time
  required
  string
  Message send time
  
  Examples values:
  "2025-01-20T16:31:04+03:00"
  message_index
  integer
  Message index
  
  required
  object
  Additional chat information
  
  uuid
  required
  string
  Unique chat identifier
  
  Examples values:
  "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
  required
  object
  Relevant chat widget
  
  source
  required
  string
  Widget source
  
  Allowed values:
  "lk"
  "store"
  Additional properties are allowed.
  status
  string
  Current chat status
  
  Allowed values:
  "new"
  "open"
  "closed"
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  Additional properties are allowed.
  required
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  required
  array<object>
  Files attached to message
  
  object
  uuid
  required
  string
  Unique attachment identifier
  
  Examples values:
  "3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
  type
  required
  string
  Attachment type
  
  Allowed values:
  "image"
  "document"
  "video"
  "audio"
  url
  required
  string
  Attachment url
  
  url_preview
  required
  string
  Attachment preview url
  
  filename
  required
  string
  Attachment filename
  
  Examples values:
  "gold sphere_2.gif"
  extension
  required
  string
  Attachment extension
  
  Examples values:
  "gif"
  size
  required
  integer
  Attachment size
  
  Examples values:
  1614977
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "message_added", "data": { "message": { "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] } } }
  
  This example has been generated automatically.
- #1ChatUpdatedEventchatUpdatedEvent
  Event emitted by server on chat updates
  application/json
  Message IDchatUpdatedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"chat_updated"
  required
  object
  Event specific payload data
  
  required
  object
  Additional chat information
  
  uuid
  required
  string
  Unique chat identifier
  
  Examples values:
  "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
  required
  object
  Relevant chat widget
  
  source
  required
  string
  Widget source
  
  Allowed values:
  "lk"
  "store"
  Additional properties are allowed.
  status
  string
  Current chat status
  
  Allowed values:
  "new"
  "open"
  "closed"
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "chat_updated", "data": { "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } } }
  
  This example has been generated automatically.
- #2OperatorUpdatedEventoperatorUpdatedEvent
  Event emitted by server on operator updates
  application/json
  Message IDoperatorUpdatedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"operator_updated"
  required
  object
  Operator related information
  
  required
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  is_online
  required
  boolean
  Whether or not operator is online
  
  new_chats
  required
  integer
  New chats count
  
  open_chats
  required
  integer
  Open chats count
  
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "operator_updated", "data": { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "is_online": true, "new_chats": 0, "open_chats": 0 } }
  
  This example has been generated automatically.
- #3TypingUpdatedEventtypingUpdatedEvent
  Event emitted by server when user starts/stops typing
  application/json
  Message IDtypingUpdatedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"typing_updated"
  required
  object
  Event specific payload data
  
  text
  required
  string
  Typed text
  
  stopped
  required
  boolean
  Whether or not typing is stopped
  
  chat_id
  string
  Unique chat identifier
  
  Examples values:
  "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
  required
  object
  User related information
  
  id
  required
  integer
  Unique user identifier
  
  role
  required
  string
  Role of the user
  
  Allowed values:
  "user"
  "operator"
  avatar
  string
  lastname
  string
  firstname
  string
  patronymic
  string
  Additional properties are allowed.
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "typing_updated", "data": { "text": "string", "stopped": true, "chat_id": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } } }
  
  This example has been generated automatically.
- #4GlobalUpdatedEventglobalUpdatedEvent
  Event emitted by server on global data updates
  application/json
  Message IDglobalUpdatedEvent
  object
  type
  required
  string
  Event specific type
  
  Const:"global_updated"
  required
  object
  Event specific payload data
  
  unread_chats
  required
  integer
  Unread chats count
  
  Additional properties are allowed.
  Additional properties are allowed.
  #source:server
  Examples
  { "type": "global_updated", "data": { "unread_chats": 0 } }
  
  This example has been generated automatically.
RECEIVE /update/chat
Used to notify operators about updates in chat
Operation IDupdateChat
Available only on servers:
- chat-sockets
Additional security requirements:
HTTP API key
Name: Api-Token
In: header
object
method
PUT
Accepts the following message:
Chat Request BodychatBody
Json encoded chat
application/json
Message IDchatBody
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }

This example has been generated automatically.
RECEIVE /update/operators
Used to notify broadcast listener about updates related to operators
Operation IDupdateOperators
Available only on servers:
- chat-sockets
Additional security requirements:
HTTP API key
Name: Api-Token
In: header
object
method
PUT
Accepts the following message:
Operators Request BodyoperatorsBody
Json encoded operators data
application/json
Message IDoperatorsBody
array<object>
List of updated operators data

object
Operator related information

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
is_online
required
boolean
Whether or not operator is online

new_chats
required
integer
New chats count

open_chats
required
integer
Open chats count

Additional properties are allowed.
object
Widget-Source
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
Examples
[ { "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "is_online": true, "new_chats": 0, "open_chats": 0 } ]

This example has been generated automatically.
{ "Widget-Source": "lk" }

This example has been generated automatically.
RECEIVE /message
Used to notify users about new messages
Messages with type=standard are added to both chat and broadcast channels, messages with type=system are added only to the chat channel, and only users with role=type_role receive notifications.

Operation IDcreateMessage
Available only on servers:
- chat-sockets
Additional security requirements:
HTTP API key
Name: Api-Token
In: header
object
method
POST
Accepts the following message:
Message Request BodymessageBody
Json encoded message data
application/json
Message IDmessageBody
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
object
Widget-Source
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
Examples
{ "id": 0, "type": "standard", "type_role": "user", "status": "new", "text": "string", "send_time": "2025-01-20T16:31:04+03:00", "message_index": 0, "chat": { "uuid": "d599cb9b-a451-4bb3-ac0c-1465b9a1c4de", "widget": { "source": "lk" }, "status": "new", "owner_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "operator_user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" } }, "user": { "id": 0, "role": "user", "avatar": "string", "lastname": "string", "firstname": "string", "patronymic": "string" }, "attachments": [ { "uuid": "3f439f10-9c19-4bd4-81a8-d6e048b97ba4", "type": "image", "url": "string", "url_preview": "string", "filename": "gold sphere_2.gif", "extension": "gif", "size": 1614977 } ] }

This example has been generated automatically.
{ "Widget-Source": "lk" }

This example has been generated automatically.
RECEIVE /global
Used to notify broadcast listener about updates to global data
Operation IDupdateGlobal
Available only on servers:
- chat-sockets
Additional security requirements:
HTTP API key
Name: Api-Token
In: header
object
method
PUT
Accepts the following message:
Global Data Request BodyglobalBody
Json encoded global data
application/json
Message IDglobalBody
object
Event specific payload data

unread_chats
required
integer
Unread chats count

Additional properties are allowed.
object
Widget-Source
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
Examples
{ "unread_chats": 0 }

This example has been generated automatically.
{ "Widget-Source": "lk" }

This example has been generated automatically.

Messages

#1SendMessageEventsendMessageEvent
Event emitted when user sends new message to the chat room
- application/json
Message IDsendMessageEvent
object
type
required
string
Event specific type

Const:"send_message"
required
object
Event specific payload data

text
required
string
Text contents of the message

array<string>
Attachments uuid list

Items:
string
Attachment uuid

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
Additional properties are allowed.
Additional properties are allowed.
#source:client
#2MarkMessageDeliveredEventmarkMessageDeliveredEvent
Event emitted when user receives new message
- application/json
Message IDmarkMessageDeliveredEvent
object
type
required
string
Event specific type

Const:"mark_message_delivered"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
#3MarkMessageReadEventmarkMessageReadEvent
Event emitted when user reads a message
- application/json
Message IDmarkMessageReadEvent
object
type
required
string
Event specific type

Const:"mark_message_read"
required
object
Event specific payload data

message_id
required
integer
Unique message identifier

Additional properties are allowed.
Additional properties are allowed.
#source:client
#4MessageAddedEventmessageAddedEvent
Event emitted when server adds new message to the room
- application/json
Message IDmessageAddedEvent
object
type
required
string
Event specific type

Const:"message_added"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#5MessageNotAddedEventmessageNotAddedEvent
Event emitted when server could not add new message to the room
- application/json
Message IDmessageNotAddedEvent
object
type
required
string
Event specific type

Const:"message_not_added"
required
object
Event specific payload data

text
required
string
Text contents of the message

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#6MessageUpdatedEventmessageUpdatedEvent
Event emitted when server modifies existing message in the room
- application/json
Message IDmessageUpdatedEvent
object
type
required
string
Event specific type

Const:"message_updated"
required
object
Event specific payload data

required
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#7UpdateTypingEventupdateTypingEvent
Event emitted when user starts/stops typing
- application/json
Message IDupdateTypingEvent
object
type
required
string
Event specific type

Const:"update_typing"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

Additional properties are allowed.
Additional properties are allowed.
#source:client
#8TypingUpdatedEventtypingUpdatedEvent
Event emitted by server when user starts/stops typing
- application/json
Message IDtypingUpdatedEvent
object
type
required
string
Event specific type

Const:"typing_updated"
required
object
Event specific payload data

text
required
string
Typed text

stopped
required
boolean
Whether or not typing is stopped

chat_id
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#9UserConnectedEventuserConnectedEvent
Event emitted by server when user connects to the room
- application/json
Message IDuserConnectedEvent
object
type
required
string
Event specific type

Const:"user_connected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#10UserDisconnectedEventuserDisconnectedEvent
Event emitted by server when user disconnects from the room
- application/json
Message IDuserDisconnectedEvent
object
type
required
string
Event specific type

Const:"user_disconnected"
required
object
Event specific payload data

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#11ChatUpdatedEventchatUpdatedEvent
Event emitted by server on chat updates
- application/json
Message IDchatUpdatedEvent
object
type
required
string
Event specific type

Const:"chat_updated"
required
object
Event specific payload data

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#source:server
#12OperatorUpdatedEventoperatorUpdatedEvent
Event emitted by server on operator updates
- application/json
Message IDoperatorUpdatedEvent
object
type
required
string
Event specific type

Const:"operator_updated"
required
object
Operator related information

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
is_online
required
boolean
Whether or not operator is online

new_chats
required
integer
New chats count

open_chats
required
integer
Open chats count

Additional properties are allowed.
Additional properties are allowed.
#source:server
#13GlobalUpdatedEventglobalUpdatedEvent
Event emitted by server on global data updates
- application/json
Message IDglobalUpdatedEvent
object
type
required
string
Event specific type

Const:"global_updated"
required
object
Event specific payload data

unread_chats
required
integer
Unread chats count

Additional properties are allowed.
Additional properties are allowed.
#source:server

Schemas

object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
object
Message related information

id
required
integer
Unique message identifier

type
required
string
Message type

Allowed values:
"standard"
"system"
type_role
required
string
Role of the user to whom this message is adressed

Allowed values:
"user"
"operator"
status
required
string
Message delivery status

Allowed values:
"new"
"delivered"
"read"
text
required
string
Message text contents

send_time
required
string
Message send time

Examples values:
"2025-01-20T16:31:04+03:00"
message_index
integer
Message index

required
object
Additional chat information

uuid
required
string
Unique chat identifier

Examples values:
"d599cb9b-a451-4bb3-ac0c-1465b9a1c4de"
required
object
Relevant chat widget

source
required
string
Widget source

Allowed values:
"lk"
"store"
Additional properties are allowed.
status
string
Current chat status

Allowed values:
"new"
"open"
"closed"
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
Additional properties are allowed.
required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
required
array<object>
Files attached to message

object
uuid
required
string
Unique attachment identifier

Examples values:
"3f439f10-9c19-4bd4-81a8-d6e048b97ba4"
type
required
string
Attachment type

Allowed values:
"image"
"document"
"video"
"audio"
url
required
string
Attachment url

url_preview
required
string
Attachment preview url

filename
required
string
Attachment filename

Examples values:
"gold sphere_2.gif"
extension
required
string
Attachment extension

Examples values:
"gif"
size
required
integer
Attachment size

Examples values:
1614977
Additional properties are allowed.
Additional properties are allowed.
object
Operator related information

required
object
User related information

id
required
integer
Unique user identifier

role
required
string
Role of the user

Allowed values:
"user"
"operator"
avatar
string
lastname
string
firstname
string
patronymic
string
Additional properties are allowed.
is_online
required
boolean
Whether or not operator is online

new_chats
required
integer
New chats count

open_chats
required
integer
Open chats count

Additional properties are allowed.

Chat WS API 0.0.11

Servers

Operations

REPLY /chat

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY /chat

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY /chat

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples