dandri/simplex-chat
1
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2026-03-29 08:00:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
47f82c10da7e404e89d45447321f50ca9b5786eb
simplex-chat/bots/api/EVENTS.md
Evgeny cf8bd7f6ac docs: bots API (#6091) 
* docs: bot API commands

* generate API commands doc

* generate commands docs with parameters and responses

* add API types

* more types

* document all types (with some deviations from JSON encodings)

* rename types

* interface objects

* separator

* command syntax

* more syntax

* API events

* event types

* fix all type definitions

* pre-process types outside of rendering

* pre-process event types

* overview

* pre-process commands

* param syntax WIP

* syntax for types in command parameters

* API error response and chat event

* remove unsupported/deprecated command parameters

* reorder

* syntax for choice

* show command errors

* event descriptions

* python syntax for commands and types (#6099)

* python syntax for commands and types

* python snippets: convert numbers to string

* fixes

* update readme, enable all tests

* fix operators test

* update plans

---------

Co-authored-by: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com>
2025-07-24 13:12:53 +01:00

16 KiB
Raw Blame History

API Events

This file is generated automatically.

Contact connection events

Message events

Group events

File events

Connection progress events

Error events

Contact connection events

Bots must use these events to process connecting users.

Most bots enable auto-accept and don't need to accept connections via commands.

You may create bot SimpleX address manually via CLI or desktop app or from bot code with these commands:

ContactConnected

This event is sent after a user connects via bot SimpleX address (not a business address).

Record type:

ContactUpdated

Contact profile of another user is updated.

Record type:

ContactDeletedByContact

Bot user's connection with another contact is deleted (conversation is kept).

Record type:

  • type: "contactDeletedByContact"
  • user: User
  • contact: Contact

ReceivedContactRequest

Contact request received.

This event is only sent when auto-accept is disabled.

The request needs to be accepted using APIAcceptContact command

Record type:

NewMemberContactReceivedInv

Received invitation to connect directly with a group member.

This event only needs to be processed to associate contact with group, the connection will proceed automatically.

Record type:

ContactSndReady

Connecting via 1-time invitation or after accepting contact request.

After this event bot can send messages to this contact.

Record type:

Message events

Bots must use these events to process received messages.

NewChatItems

Received message(s).

Record type:

ChatItemReaction

Received message reaction.

Record type:

ChatItemsDeleted

Message was deleted by another user.

Record type:

  • type: "chatItemsDeleted"
  • user: User
  • chatItemDeletions: [ChatItemDeletion]
  • byUser: bool
  • timed: bool

ChatItemUpdated

Message was updated by another user.

Record type:

GroupChatItemsDeleted

Group messages are deleted or moderated.

Record type:

ChatItemsStatusesUpdated

Message delivery status updates.

Record type:

  • type: "chatItemsStatusesUpdated"
  • user: User
  • chatItems: [AChatItem]

Group events

Bots may use these events to manage users' groups and business address groups.

Please note: programming groups is more complex than programming direct connections

ReceivedGroupInvitation

Received group invitation.

Record type:

UserJoinedGroup

Bot user joined group. Received when connection via group link completes.

Record type:

GroupUpdated

Group profile or preferences updated.

Record type:

JoinedGroupMember

Another member joined group.

Record type:

MemberRole

Member (or bot user's) group role changed.

Record type:

DeletedMember

Another member is removed from the group.

Record type:

LeftMember

Another member left the group.

Record type:

DeletedMemberUser

Bot user was removed from the group.

Record type:

GroupDeleted

Group was deleted by the owner (not bot user).

Record type:

ConnectedToGroupMember

Connected to another group member.

Record type:

MemberAcceptedByOther

Another group owner, admin or moderator accepted member to the group after review ("knocking").

Record type:

MemberBlockedForAll

Another member blocked for all members.

Record type:

GroupMemberUpdated

Another group member profile updated.

Record type:

File events

Bots that send or receive files may process these events to track delivery status and to process completion.

Bots that need to receive or moderate files (e.g., based on name, size or extension), can use relevant commands (e.g., ReceiveFile or APIDeleteMemberChatItem) when processing NewChatItems event.

Bots that need to send files should use APISendMessages command.

RcvFileDescrReady

File is ready to be received.

This event is useful for processing sender file servers and monitoring file reception progress.

ReceiveFile command can be used before this event.

Record type:

RcvFileComplete

File reception is competed.

Record type:

SndFileCompleteXFTP

File upload is competed.

Record type:

RcvFileStart

File reception started. This event will be sent after CEvtRcvFileDescrReady event.

Record type:

RcvFileSndCancelled

File was cancelled by the sender. This event may be sent instead of CEvtRcvFileDescrReady event.

Record type:

RcvFileAccepted

This event will be sent when file is automatically accepted because of CLI option.

Record type:

RcvFileError

Error receiving file.

Record type:

RcvFileWarning

Warning when receiving file. It can happen when CLI settings do not allow to connect to file server(s).

Record type:

SndFileError

Error sending file.

Record type:

SndFileWarning

Warning when sending file.

Record type:

Connection progress events

Bots may use these events to track progress of connections for monitoring or debugging.

AcceptingContactRequest

Automatically accepting contact request via bot's SimpleX address with auto-accept enabled.

Record type:

  • type: "acceptingContactRequest"
  • user: User
  • contact: Contact

AcceptingBusinessRequest

Automatically accepting contact request via bot's business address.

Record type:

  • type: "acceptingBusinessRequest"
  • user: User
  • groupInfo: GroupInfo

ContactConnecting

Contact confirmed connection.

Sent when contact started connecting via bot's 1-time invitation link or when bot connects to another SimpleX address.

Record type:

  • type: "contactConnecting"
  • user: User
  • contact: Contact

BusinessLinkConnecting

Contact confirmed connection.

Sent when bot connects to another business address.

Record type:

JoinedGroupMemberConnecting

Group member is announced to the group and will be connecting to bot.

Record type:

SentGroupInvitation

Sent when another user joins group via bot's link.

Record type:

GroupLinkConnecting

Sent when bot joins group via another user link.

Record type:

Error events

Bots may log these events for debugging. There will be many error events - this does NOT indicate a malfunction - e.g., they may happen because of bad network connectivity, or because messages may be delivered to deleted chats for a short period of time (they will be ignored).

MessageError

Message error.

Record type:

  • type: "messageError"
  • user: User
  • severity: string
  • errorMessage: string

ChatError

Chat error.

Record type:

ChatErrors

Chat errors.

Record type:

Reference in New Issue View Git Blame Copy Permalink