Writing

[POST] .../v1/chatmessage/writing

Sends a typing event to the chat. Use this method to notify chat participants that the current user or an allowed custom author is typing. The request body is required and chat_id must identify the chat; optional author_entity_type and author_entity_id must be supplied together when a bot or custom author emits the event. Access is scoped to the current user's chat write visibility and the event is debounced by server settings rather than stored as a chat message. Missing body, missing chat_id, invalid author pair, denied chat access, closed chat restrictions and realtime delivery or database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
author_entity_id Int64 Optional Author entity identifier for the writing event. Used only together with author_entity_type.
author_entity_type String Optional Author entity type for the writing event. Used only together with author_entity_id. Allowed values: Default, User, ChatBot, Client.
chat_id String Required Chat UUID.

Request Example

{
  "chat_id": "8cdd646d-dbd0-45c0-8f5b-d90a9b000001"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}