mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-03-30 14:15:55 +00:00
4811d663e6
* rfc: bot messages and buttons * update * update bot rfc * core: add bot commands to chat preferences and peer type to profile * update postgresql schema * update query plans * chat sessions preference * markdown for bot commands * schema * core: file preference, options to create bot from CLI * core: different command type * ios: commands menu * update types * update ios * improve command markdown * core, ios: update types * android, desktop: clickable commands in messages in chats with bots * android, desktop: commands menu * command menu button, bot icon * ios: connect flow for bots * android, desktop: connect flow for bots * icon * CLI commands to view and set commands, remove "hidden" property of command, bot api docs * corrections * fix inheriting profile preferences to business groups * note on business address * ios: export localizations * fix test * commands to set file preference on user/contact, tidy up layout and display of command and attachment buttons
1576 lines
30 KiB
Markdown
1576 lines
30 KiB
Markdown
# API Commands and Responses
|
|
|
|
This file is generated automatically.
|
|
|
|
[Address commands](#address-commands)
|
|
- [APICreateMyAddress](#apicreatemyaddress)
|
|
- [APIDeleteMyAddress](#apideletemyaddress)
|
|
- [APIShowMyAddress](#apishowmyaddress)
|
|
- [APISetProfileAddress](#apisetprofileaddress)
|
|
- [APISetAddressSettings](#apisetaddresssettings)
|
|
|
|
[Message commands](#message-commands)
|
|
- [APISendMessages](#apisendmessages)
|
|
- [APIUpdateChatItem](#apiupdatechatitem)
|
|
- [APIDeleteChatItem](#apideletechatitem)
|
|
- [APIDeleteMemberChatItem](#apideletememberchatitem)
|
|
- [APIChatItemReaction](#apichatitemreaction)
|
|
|
|
[File commands](#file-commands)
|
|
- [ReceiveFile](#receivefile)
|
|
- [CancelFile](#cancelfile)
|
|
|
|
[Group commands](#group-commands)
|
|
- [APIAddMember](#apiaddmember)
|
|
- [APIJoinGroup](#apijoingroup)
|
|
- [APIAcceptMember](#apiacceptmember)
|
|
- [APIMembersRole](#apimembersrole)
|
|
- [APIBlockMembersForAll](#apiblockmembersforall)
|
|
- [APIRemoveMembers](#apiremovemembers)
|
|
- [APILeaveGroup](#apileavegroup)
|
|
- [APIListMembers](#apilistmembers)
|
|
- [APINewGroup](#apinewgroup)
|
|
- [APIUpdateGroupProfile](#apiupdategroupprofile)
|
|
|
|
[Group link commands](#group-link-commands)
|
|
- [APICreateGroupLink](#apicreategrouplink)
|
|
- [APIGroupLinkMemberRole](#apigrouplinkmemberrole)
|
|
- [APIDeleteGroupLink](#apideletegrouplink)
|
|
- [APIGetGroupLink](#apigetgrouplink)
|
|
|
|
[Connection commands](#connection-commands)
|
|
- [APIAddContact](#apiaddcontact)
|
|
- [APIConnectPlan](#apiconnectplan)
|
|
- [APIConnect](#apiconnect)
|
|
- [APIAcceptContact](#apiacceptcontact)
|
|
- [APIRejectContact](#apirejectcontact)
|
|
|
|
[Chat commands](#chat-commands)
|
|
- [APIListContacts](#apilistcontacts)
|
|
- [APIListGroups](#apilistgroups)
|
|
- [APIDeleteChat](#apideletechat)
|
|
|
|
[User profile commands](#user-profile-commands)
|
|
- [ShowActiveUser](#showactiveuser)
|
|
- [CreateActiveUser](#createactiveuser)
|
|
- [ListUsers](#listusers)
|
|
- [APISetActiveUser](#apisetactiveuser)
|
|
- [APIDeleteUser](#apideleteuser)
|
|
- [APIUpdateProfile](#apiupdateprofile)
|
|
- [APISetContactPrefs](#apisetcontactprefs)
|
|
|
|
---
|
|
|
|
|
|
## Address commands
|
|
|
|
Bots can use these commands to automatically check and create address when initialized
|
|
|
|
|
|
### APICreateMyAddress
|
|
|
|
Create bot address.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_address <userId>
|
|
```
|
|
|
|
```javascript
|
|
'/_address ' + userId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_address ' + str(userId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserContactLinkCreated: User contact address created.
|
|
- type: "userContactLinkCreated"
|
|
- user: [User](./TYPES.md#user)
|
|
- connLinkContact: [CreatedConnLink](./TYPES.md#createdconnlink)
|
|
|
|
---
|
|
|
|
|
|
### APIDeleteMyAddress
|
|
|
|
Delete bot address.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_delete_address <userId>
|
|
```
|
|
|
|
```javascript
|
|
'/_delete_address ' + userId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_delete_address ' + str(userId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserContactLinkDeleted: User contact address deleted.
|
|
- type: "userContactLinkDeleted"
|
|
- user: [User](./TYPES.md#user)
|
|
|
|
---
|
|
|
|
|
|
### APIShowMyAddress
|
|
|
|
Get bot address and settings.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_show_address <userId>
|
|
```
|
|
|
|
```javascript
|
|
'/_show_address ' + userId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_show_address ' + str(userId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserContactLink: User contact address.
|
|
- type: "userContactLink"
|
|
- user: [User](./TYPES.md#user)
|
|
- contactLink: [UserContactLink](./TYPES.md#usercontactlink)
|
|
|
|
---
|
|
|
|
|
|
### APISetProfileAddress
|
|
|
|
Add address to bot profile.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- enable: bool
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_profile_address <userId> on|off
|
|
```
|
|
|
|
```javascript
|
|
'/_profile_address ' + userId + ' ' + (enable ? 'on' : 'off') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_profile_address ' + str(userId) + ' ' + ('on' if enable else 'off') # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserProfileUpdated: User profile updated.
|
|
- type: "userProfileUpdated"
|
|
- user: [User](./TYPES.md#user)
|
|
- fromProfile: [Profile](./TYPES.md#profile)
|
|
- toProfile: [Profile](./TYPES.md#profile)
|
|
- updateSummary: [UserProfileUpdateSummary](./TYPES.md#userprofileupdatesummary)
|
|
|
|
---
|
|
|
|
|
|
### APISetAddressSettings
|
|
|
|
Set bot address settings.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- settings: [AddressSettings](./TYPES.md#addresssettings)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_address_settings <userId> <json(settings)>
|
|
```
|
|
|
|
```javascript
|
|
'/_address_settings ' + userId + ' ' + JSON.stringify(settings) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_address_settings ' + str(userId) + ' ' + json.dumps(settings) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserContactLinkUpdated: User contact address updated.
|
|
- type: "userContactLinkUpdated"
|
|
- user: [User](./TYPES.md#user)
|
|
- contactLink: [UserContactLink](./TYPES.md#usercontactlink)
|
|
|
|
---
|
|
|
|
|
|
## Message commands
|
|
|
|
Commands to send, update, delete, moderate messages and set message reactions
|
|
|
|
|
|
### APISendMessages
|
|
|
|
Send messages.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- sendRef: [ChatRef](./TYPES.md#chatref)
|
|
- liveMessage: bool
|
|
- ttl: int?
|
|
- composedMessages: [[ComposedMessage](./TYPES.md#composedmessage)]
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_send <str(sendRef)>[ live=on][ ttl=<ttl>] json <json(composedMessages)>
|
|
```
|
|
|
|
```javascript
|
|
'/_send ' + sendRef.toString() + (liveMessage ? ' live=on' : '') + (ttl ? ' ttl=' + ttl : '') + ' json ' + JSON.stringify(composedMessages) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_send ' + str(sendRef) + (' live=on' if liveMessage else '') + ((' ttl=' + str(ttl)) if ttl is not None else '') + ' json ' + json.dumps(composedMessages) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
NewChatItems: New messages.
|
|
- type: "newChatItems"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItems: [[AChatItem](./TYPES.md#achatitem)]
|
|
|
|
---
|
|
|
|
|
|
### APIUpdateChatItem
|
|
|
|
Update message.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- chatRef: [ChatRef](./TYPES.md#chatref)
|
|
- chatItemId: int64
|
|
- liveMessage: bool
|
|
- updatedMessage: [UpdatedMessage](./TYPES.md#updatedmessage)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_update item <str(chatRef)> <chatItemId>[ live=on] json <json(updatedMessage)>
|
|
```
|
|
|
|
```javascript
|
|
'/_update item ' + chatRef.toString() + ' ' + chatItemId + (liveMessage ? ' live=on' : '') + ' json ' + JSON.stringify(updatedMessage) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_update item ' + str(chatRef) + ' ' + str(chatItemId) + (' live=on' if liveMessage else '') + ' json ' + json.dumps(updatedMessage) # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
ChatItemUpdated: Message updated.
|
|
- type: "chatItemUpdated"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItem: [AChatItem](./TYPES.md#achatitem)
|
|
|
|
ChatItemNotChanged: Message not changed.
|
|
- type: "chatItemNotChanged"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItem: [AChatItem](./TYPES.md#achatitem)
|
|
|
|
ChatCmdError: Command error.
|
|
- type: "chatCmdError"
|
|
- chatError: [ChatError](./TYPES.md#chaterror)
|
|
|
|
**Errors**:
|
|
- InvalidChatItemUpdate: Not user's message or cannot be edited.
|
|
|
|
---
|
|
|
|
|
|
### APIDeleteChatItem
|
|
|
|
Delete message.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- chatRef: [ChatRef](./TYPES.md#chatref)
|
|
- chatItemIds: [int64]
|
|
- deleteMode: [CIDeleteMode](./TYPES.md#cideletemode)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_delete item <str(chatRef)> <chatItemIds[0]>[,<chatItemIds[1]>...] broadcast|internal|internalMark
|
|
```
|
|
|
|
```javascript
|
|
'/_delete item ' + chatRef.toString() + ' ' + chatItemIds.join(',') + ' ' + deleteMode // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_delete item ' + str(chatRef) + ' ' + ','.join(map(str, chatItemIds)) + ' ' + str(deleteMode) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ChatItemsDeleted: Messages deleted.
|
|
- type: "chatItemsDeleted"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItemDeletions: [[ChatItemDeletion](./TYPES.md#chatitemdeletion)]
|
|
- byUser: bool
|
|
- timed: bool
|
|
|
|
---
|
|
|
|
|
|
### APIDeleteMemberChatItem
|
|
|
|
Moderate message. Requires Moderator role (and higher than message author's).
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- chatItemIds: [int64]
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_delete member item #<groupId> <chatItemIds[0]>[,<chatItemIds[1]>...]
|
|
```
|
|
|
|
```javascript
|
|
'/_delete member item #' + groupId + ' ' + chatItemIds.join(',') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_delete member item #' + str(groupId) + ' ' + ','.join(map(str, chatItemIds)) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ChatItemsDeleted: Messages deleted.
|
|
- type: "chatItemsDeleted"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItemDeletions: [[ChatItemDeletion](./TYPES.md#chatitemdeletion)]
|
|
- byUser: bool
|
|
- timed: bool
|
|
|
|
---
|
|
|
|
|
|
### APIChatItemReaction
|
|
|
|
Add/remove message reaction.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- chatRef: [ChatRef](./TYPES.md#chatref)
|
|
- chatItemId: int64
|
|
- add: bool
|
|
- reaction: [MsgReaction](./TYPES.md#msgreaction)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_reaction <str(chatRef)> <chatItemId> on|off <json(reaction)>
|
|
```
|
|
|
|
```javascript
|
|
'/_reaction ' + chatRef.toString() + ' ' + chatItemId + ' ' + (add ? 'on' : 'off') + ' ' + JSON.stringify(reaction) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_reaction ' + str(chatRef) + ' ' + str(chatItemId) + ' ' + ('on' if add else 'off') + ' ' + json.dumps(reaction) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ChatItemReaction: Message reaction.
|
|
- type: "chatItemReaction"
|
|
- user: [User](./TYPES.md#user)
|
|
- added: bool
|
|
- reaction: [ACIReaction](./TYPES.md#acireaction)
|
|
|
|
---
|
|
|
|
|
|
## File commands
|
|
|
|
Commands to receive and to cancel files. Files are sent as part of the message, there are no separate commands to send files.
|
|
|
|
|
|
### ReceiveFile
|
|
|
|
Receive file.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- fileId: int64
|
|
- userApprovedRelays: bool
|
|
- storeEncrypted: bool?
|
|
- fileInline: bool?
|
|
- filePath: string?
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/freceive <fileId>[ approved_relays=on][ encrypt=on|off][ inline=on|off][ <filePath>]
|
|
```
|
|
|
|
```javascript
|
|
'/freceive ' + fileId + (userApprovedRelays ? ' approved_relays=on' : '') + (typeof storeEncrypted == 'boolean' ? ' encrypt=' + (storeEncrypted ? 'on' : 'off') : '') + (typeof fileInline == 'boolean' ? ' inline=' + (fileInline ? 'on' : 'off') : '') + (filePath ? ' ' + filePath : '') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/freceive ' + str(fileId) + (' approved_relays=on' if userApprovedRelays else '') + ((' encrypt=' + ('on' if storeEncrypted else 'off')) if storeEncrypted is not None else '') + ((' inline=' + ('on' if fileInline else 'off')) if fileInline is not None else '') + ((' ' + filePath) if filePath is not None else '') # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
RcvFileAccepted: File accepted to be received.
|
|
- type: "rcvFileAccepted"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItem: [AChatItem](./TYPES.md#achatitem)
|
|
|
|
RcvFileAcceptedSndCancelled: File accepted, but no longer sent.
|
|
- type: "rcvFileAcceptedSndCancelled"
|
|
- user: [User](./TYPES.md#user)
|
|
- rcvFileTransfer: [RcvFileTransfer](./TYPES.md#rcvfiletransfer)
|
|
|
|
---
|
|
|
|
|
|
### CancelFile
|
|
|
|
Cancel file.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- fileId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/fcancel <fileId>
|
|
```
|
|
|
|
```javascript
|
|
'/fcancel ' + fileId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/fcancel ' + str(fileId) # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
SndFileCancelled: Cancelled sending file.
|
|
- type: "sndFileCancelled"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItem_: [AChatItem](./TYPES.md#achatitem)?
|
|
- fileTransferMeta: [FileTransferMeta](./TYPES.md#filetransfermeta)
|
|
- sndFileTransfers: [[SndFileTransfer](./TYPES.md#sndfiletransfer)]
|
|
|
|
RcvFileCancelled: Cancelled receiving file.
|
|
- type: "rcvFileCancelled"
|
|
- user: [User](./TYPES.md#user)
|
|
- chatItem_: [AChatItem](./TYPES.md#achatitem)?
|
|
- rcvFileTransfer: [RcvFileTransfer](./TYPES.md#rcvfiletransfer)
|
|
|
|
ChatCmdError: Command error.
|
|
- type: "chatCmdError"
|
|
- chatError: [ChatError](./TYPES.md#chaterror)
|
|
|
|
**Errors**:
|
|
- FileCancel: Cannot cancel file.
|
|
|
|
---
|
|
|
|
|
|
## Group commands
|
|
|
|
Commands to manage and moderate groups. These commands can be used with business chats as well - they are groups. E.g., a common scenario would be to add human agents to business chat with the customer who connected via business address.
|
|
|
|
|
|
### APIAddMember
|
|
|
|
Add contact to group. Requires bot to have Admin role.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- contactId: int64
|
|
- memberRole: [GroupMemberRole](./TYPES.md#groupmemberrole)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_add #<groupId> <contactId> observer|author|member|moderator|admin|owner
|
|
```
|
|
|
|
```javascript
|
|
'/_add #' + groupId + ' ' + contactId + ' ' + memberRole // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_add #' + str(groupId) + ' ' + str(contactId) + ' ' + str(memberRole) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
SentGroupInvitation: Group invitation sent.
|
|
- type: "sentGroupInvitation"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- contact: [Contact](./TYPES.md#contact)
|
|
- member: [GroupMember](./TYPES.md#groupmember)
|
|
|
|
---
|
|
|
|
|
|
### APIJoinGroup
|
|
|
|
Join group.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_join #<groupId>
|
|
```
|
|
|
|
```javascript
|
|
'/_join #' + groupId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_join #' + str(groupId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserAcceptedGroupSent: User accepted group invitation.
|
|
- type: "userAcceptedGroupSent"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- hostContact: [Contact](./TYPES.md#contact)?
|
|
|
|
---
|
|
|
|
|
|
### APIAcceptMember
|
|
|
|
Accept group member. Requires Admin role.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- groupMemberId: int64
|
|
- memberRole: [GroupMemberRole](./TYPES.md#groupmemberrole)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_accept member #<groupId> <groupMemberId> observer|author|member|moderator|admin|owner
|
|
```
|
|
|
|
```javascript
|
|
'/_accept member #' + groupId + ' ' + groupMemberId + ' ' + memberRole // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_accept member #' + str(groupId) + ' ' + str(groupMemberId) + ' ' + str(memberRole) # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
MemberAccepted: Member accepted to group.
|
|
- type: "memberAccepted"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- member: [GroupMember](./TYPES.md#groupmember)
|
|
|
|
ChatCmdError: Command error.
|
|
- type: "chatCmdError"
|
|
- chatError: [ChatError](./TYPES.md#chaterror)
|
|
|
|
**Errors**:
|
|
- GroupMemberNotActive: Member is not connected yet.
|
|
|
|
---
|
|
|
|
|
|
### APIMembersRole
|
|
|
|
Set members role. Requires Admin role.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- groupMemberIds: [int64]
|
|
- memberRole: [GroupMemberRole](./TYPES.md#groupmemberrole)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_member role #<groupId> <groupMemberIds[0]>[,<groupMemberIds[1]>...] observer|author|member|moderator|admin|owner
|
|
```
|
|
|
|
```javascript
|
|
'/_member role #' + groupId + ' ' + groupMemberIds.join(',') + ' ' + memberRole // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_member role #' + str(groupId) + ' ' + ','.join(map(str, groupMemberIds)) + ' ' + str(memberRole) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
MembersRoleUser: Members role changed by user.
|
|
- type: "membersRoleUser"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- members: [[GroupMember](./TYPES.md#groupmember)]
|
|
- toRole: [GroupMemberRole](./TYPES.md#groupmemberrole)
|
|
|
|
---
|
|
|
|
|
|
### APIBlockMembersForAll
|
|
|
|
Block members. Requires Moderator role.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- groupMemberIds: [int64]
|
|
- blocked: bool
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_block #<groupId> <groupMemberIds[0]>[,<groupMemberIds[1]>...] blocked=on|off
|
|
```
|
|
|
|
```javascript
|
|
'/_block #' + groupId + ' ' + groupMemberIds.join(',') + ' blocked=' + (blocked ? 'on' : 'off') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_block #' + str(groupId) + ' ' + ','.join(map(str, groupMemberIds)) + ' blocked=' + ('on' if blocked else 'off') # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
MembersBlockedForAllUser: Members blocked for all by admin.
|
|
- type: "membersBlockedForAllUser"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- members: [[GroupMember](./TYPES.md#groupmember)]
|
|
- blocked: bool
|
|
|
|
---
|
|
|
|
|
|
### APIRemoveMembers
|
|
|
|
Remove members. Requires Admin role.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- groupMemberIds: [int64]
|
|
- withMessages: bool
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_remove #<groupId> <groupMemberIds[0]>[,<groupMemberIds[1]>...][ messages=on]
|
|
```
|
|
|
|
```javascript
|
|
'/_remove #' + groupId + ' ' + groupMemberIds.join(',') + (withMessages ? ' messages=on' : '') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_remove #' + str(groupId) + ' ' + ','.join(map(str, groupMemberIds)) + (' messages=on' if withMessages else '') # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
UserDeletedMembers: Members deleted.
|
|
- type: "userDeletedMembers"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- members: [[GroupMember](./TYPES.md#groupmember)]
|
|
- withMessages: bool
|
|
|
|
ChatCmdError: Command error.
|
|
- type: "chatCmdError"
|
|
- chatError: [ChatError](./TYPES.md#chaterror)
|
|
|
|
**Errors**:
|
|
- GroupMemberNotFound: Group member not found.
|
|
|
|
---
|
|
|
|
|
|
### APILeaveGroup
|
|
|
|
Leave group.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_leave #<groupId>
|
|
```
|
|
|
|
```javascript
|
|
'/_leave #' + groupId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_leave #' + str(groupId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
LeftMemberUser: User left group.
|
|
- type: "leftMemberUser"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
|
|
---
|
|
|
|
|
|
### APIListMembers
|
|
|
|
Get group members.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_members #<groupId>
|
|
```
|
|
|
|
```javascript
|
|
'/_members #' + groupId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_members #' + str(groupId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupMembers: Group members.
|
|
- type: "groupMembers"
|
|
- user: [User](./TYPES.md#user)
|
|
- group: [Group](./TYPES.md#group)
|
|
|
|
---
|
|
|
|
|
|
### APINewGroup
|
|
|
|
Create group.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- incognito: bool
|
|
- groupProfile: [GroupProfile](./TYPES.md#groupprofile)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_group <userId>[ incognito=on] <json(groupProfile)>
|
|
```
|
|
|
|
```javascript
|
|
'/_group ' + userId + (incognito ? ' incognito=on' : '') + ' ' + JSON.stringify(groupProfile) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_group ' + str(userId) + (' incognito=on' if incognito else '') + ' ' + json.dumps(groupProfile) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupCreated: Group created.
|
|
- type: "groupCreated"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
|
|
---
|
|
|
|
|
|
### APIUpdateGroupProfile
|
|
|
|
Update group profile.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- groupProfile: [GroupProfile](./TYPES.md#groupprofile)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_group_profile #<groupId> <json(groupProfile)>
|
|
```
|
|
|
|
```javascript
|
|
'/_group_profile #' + groupId + ' ' + JSON.stringify(groupProfile) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_group_profile #' + str(groupId) + ' ' + json.dumps(groupProfile) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupUpdated: Group updated.
|
|
- type: "groupUpdated"
|
|
- user: [User](./TYPES.md#user)
|
|
- fromGroup: [GroupInfo](./TYPES.md#groupinfo)
|
|
- toGroup: [GroupInfo](./TYPES.md#groupinfo)
|
|
- member_: [GroupMember](./TYPES.md#groupmember)?
|
|
|
|
---
|
|
|
|
|
|
## Group link commands
|
|
|
|
These commands can be used by bots that manage multiple public groups
|
|
|
|
|
|
### APICreateGroupLink
|
|
|
|
Create group link.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- memberRole: [GroupMemberRole](./TYPES.md#groupmemberrole)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_create link #<groupId> observer|author|member|moderator|admin|owner
|
|
```
|
|
|
|
```javascript
|
|
'/_create link #' + groupId + ' ' + memberRole // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_create link #' + str(groupId) + ' ' + str(memberRole) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupLinkCreated: Group link created.
|
|
- type: "groupLinkCreated"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- groupLink: [GroupLink](./TYPES.md#grouplink)
|
|
|
|
---
|
|
|
|
|
|
### APIGroupLinkMemberRole
|
|
|
|
Set member role for group link.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
- memberRole: [GroupMemberRole](./TYPES.md#groupmemberrole)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_set link role #<groupId> observer|author|member|moderator|admin|owner
|
|
```
|
|
|
|
```javascript
|
|
'/_set link role #' + groupId + ' ' + memberRole // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_set link role #' + str(groupId) + ' ' + str(memberRole) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupLink: Group link.
|
|
- type: "groupLink"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- groupLink: [GroupLink](./TYPES.md#grouplink)
|
|
|
|
---
|
|
|
|
|
|
### APIDeleteGroupLink
|
|
|
|
Delete group link.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_delete link #<groupId>
|
|
```
|
|
|
|
```javascript
|
|
'/_delete link #' + groupId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_delete link #' + str(groupId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupLinkDeleted: Group link deleted.
|
|
- type: "groupLinkDeleted"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
|
|
---
|
|
|
|
|
|
### APIGetGroupLink
|
|
|
|
Get group link.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- groupId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_get link #<groupId>
|
|
```
|
|
|
|
```javascript
|
|
'/_get link #' + groupId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_get link #' + str(groupId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupLink: Group link.
|
|
- type: "groupLink"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
- groupLink: [GroupLink](./TYPES.md#grouplink)
|
|
|
|
---
|
|
|
|
|
|
## Connection commands
|
|
|
|
These commands may be used to create connections. Most bots do not need to use them - bot users will connect via bot address with auto-accept enabled.
|
|
|
|
|
|
### APIAddContact
|
|
|
|
Create 1-time invitation link.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- incognito: bool
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_connect <userId>[ incognito=on]
|
|
```
|
|
|
|
```javascript
|
|
'/_connect ' + userId + (incognito ? ' incognito=on' : '') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_connect ' + str(userId) + (' incognito=on' if incognito else '') # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
Invitation: One-time invitation.
|
|
- type: "invitation"
|
|
- user: [User](./TYPES.md#user)
|
|
- connLinkInvitation: [CreatedConnLink](./TYPES.md#createdconnlink)
|
|
- connection: [PendingContactConnection](./TYPES.md#pendingcontactconnection)
|
|
|
|
---
|
|
|
|
|
|
### APIConnectPlan
|
|
|
|
Determine SimpleX link type and if the bot is already connected via this link.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- connectionLink: string?
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_connect plan <userId> <connectionLink>
|
|
```
|
|
|
|
```javascript
|
|
'/_connect plan ' + userId + ' ' + connectionLink // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_connect plan ' + str(userId) + ' ' + connectionLink # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ConnectionPlan: Connection link information.
|
|
- type: "connectionPlan"
|
|
- user: [User](./TYPES.md#user)
|
|
- connLink: [CreatedConnLink](./TYPES.md#createdconnlink)
|
|
- connectionPlan: [ConnectionPlan](./TYPES.md#connectionplan)
|
|
|
|
---
|
|
|
|
|
|
### APIConnect
|
|
|
|
Connect via SimpleX link. The link can be 1-time invitation link, contact address or group link
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- incognito: bool
|
|
- connLink_: [CreatedConnLink](./TYPES.md#createdconnlink)?
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_connect <userId> <str(connLink_)>
|
|
```
|
|
|
|
```javascript
|
|
'/_connect ' + userId + ' ' + connLink_.toString() // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_connect ' + str(userId) + ' ' + str(connLink_) # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
SentConfirmation: Confirmation sent to one-time invitation.
|
|
- type: "sentConfirmation"
|
|
- user: [User](./TYPES.md#user)
|
|
- connection: [PendingContactConnection](./TYPES.md#pendingcontactconnection)
|
|
- customUserProfile: [Profile](./TYPES.md#profile)?
|
|
|
|
ContactAlreadyExists: Contact already exists.
|
|
- type: "contactAlreadyExists"
|
|
- user: [User](./TYPES.md#user)
|
|
- contact: [Contact](./TYPES.md#contact)
|
|
|
|
SentInvitation: Invitation sent to contact address.
|
|
- type: "sentInvitation"
|
|
- user: [User](./TYPES.md#user)
|
|
- connection: [PendingContactConnection](./TYPES.md#pendingcontactconnection)
|
|
- customUserProfile: [Profile](./TYPES.md#profile)?
|
|
|
|
---
|
|
|
|
|
|
### APIAcceptContact
|
|
|
|
Accept contact request.
|
|
|
|
*Network usage*: interactive.
|
|
|
|
**Parameters**:
|
|
- contactReqId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_accept <contactReqId>
|
|
```
|
|
|
|
```javascript
|
|
'/_accept ' + contactReqId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_accept ' + str(contactReqId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
AcceptingContactRequest: Contact request accepted.
|
|
- type: "acceptingContactRequest"
|
|
- user: [User](./TYPES.md#user)
|
|
- contact: [Contact](./TYPES.md#contact)
|
|
|
|
---
|
|
|
|
|
|
### APIRejectContact
|
|
|
|
Reject contact request. The user who sent the request is **not notified**.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- contactReqId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_reject <contactReqId>
|
|
```
|
|
|
|
```javascript
|
|
'/_reject ' + contactReqId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_reject ' + str(contactReqId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ContactRequestRejected: Contact request rejected.
|
|
- type: "contactRequestRejected"
|
|
- user: [User](./TYPES.md#user)
|
|
- contactRequest: [UserContactRequest](./TYPES.md#usercontactrequest)
|
|
- contact_: [Contact](./TYPES.md#contact)?
|
|
|
|
---
|
|
|
|
|
|
## Chat commands
|
|
|
|
Commands to list and delete conversations.
|
|
|
|
|
|
### APIListContacts
|
|
|
|
Get contacts.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_contacts <userId>
|
|
```
|
|
|
|
```javascript
|
|
'/_contacts ' + userId // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_contacts ' + str(userId) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ContactsList: Contacts.
|
|
- type: "contactsList"
|
|
- user: [User](./TYPES.md#user)
|
|
- contacts: [[Contact](./TYPES.md#contact)]
|
|
|
|
---
|
|
|
|
|
|
### APIListGroups
|
|
|
|
Get groups.
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- contactId_: int64?
|
|
- search: string?
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_groups <userId>[ @<contactId_>][ <search>]
|
|
```
|
|
|
|
```javascript
|
|
'/_groups ' + userId + (contactId_ ? ' @' + contactId_ : '') + (search ? ' ' + search : '') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_groups ' + str(userId) + ((' @' + str(contactId_)) if contactId_ is not None else '') + ((' ' + search) if search is not None else '') # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
GroupsList: Groups.
|
|
- type: "groupsList"
|
|
- user: [User](./TYPES.md#user)
|
|
- groups: [[GroupInfoSummary](./TYPES.md#groupinfosummary)]
|
|
|
|
---
|
|
|
|
|
|
### APIDeleteChat
|
|
|
|
Delete chat.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- chatRef: [ChatRef](./TYPES.md#chatref)
|
|
- chatDeleteMode: [ChatDeleteMode](./TYPES.md#chatdeletemode)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_delete <str(chatRef)> <str(chatDeleteMode)>
|
|
```
|
|
|
|
```javascript
|
|
'/_delete ' + chatRef.toString() + ' ' + chatDeleteMode.toString() // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_delete ' + str(chatRef) + ' ' + str(chatDeleteMode) # Python
|
|
```
|
|
|
|
**Responses**:
|
|
|
|
ContactDeleted: Contact deleted.
|
|
- type: "contactDeleted"
|
|
- user: [User](./TYPES.md#user)
|
|
- contact: [Contact](./TYPES.md#contact)
|
|
|
|
ContactConnectionDeleted: Connection deleted.
|
|
- type: "contactConnectionDeleted"
|
|
- user: [User](./TYPES.md#user)
|
|
- connection: [PendingContactConnection](./TYPES.md#pendingcontactconnection)
|
|
|
|
GroupDeletedUser: User deleted group.
|
|
- type: "groupDeletedUser"
|
|
- user: [User](./TYPES.md#user)
|
|
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
|
|
|
|
---
|
|
|
|
|
|
## User profile commands
|
|
|
|
Most bots don't need to use these commands, as bot profile can be configured manually via CLI or desktop client. These commands can be used by bots that need to manage multiple user profiles (e.g., the profiles of support agents).
|
|
|
|
|
|
### ShowActiveUser
|
|
|
|
Get active user profile
|
|
|
|
*Network usage*: no.
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/user
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ActiveUser: Active user profile.
|
|
- type: "activeUser"
|
|
- user: [User](./TYPES.md#user)
|
|
|
|
---
|
|
|
|
|
|
### CreateActiveUser
|
|
|
|
Create new user profile
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- newUser: [NewUser](./TYPES.md#newuser)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_create user <json(newUser)>
|
|
```
|
|
|
|
```javascript
|
|
'/_create user ' + JSON.stringify(newUser) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_create user ' + json.dumps(newUser) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ActiveUser: Active user profile.
|
|
- type: "activeUser"
|
|
- user: [User](./TYPES.md#user)
|
|
|
|
**Errors**:
|
|
- UserExists: User or contact with this name already exists.
|
|
- InvalidDisplayName: Invalid user display name.
|
|
|
|
---
|
|
|
|
|
|
### ListUsers
|
|
|
|
Get all user profiles
|
|
|
|
*Network usage*: no.
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/users
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UsersList: Users.
|
|
- type: "usersList"
|
|
- users: [[UserInfo](./TYPES.md#userinfo)]
|
|
|
|
---
|
|
|
|
|
|
### APISetActiveUser
|
|
|
|
Set active user profile
|
|
|
|
*Network usage*: no.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- viewPwd: string?
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_user <userId>[ <json(viewPwd)>]
|
|
```
|
|
|
|
```javascript
|
|
'/_user ' + userId + (viewPwd ? ' ' + JSON.stringify(viewPwd) : '') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_user ' + str(userId) + ((' ' + json.dumps(viewPwd)) if viewPwd is not None else '') # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ActiveUser: Active user profile.
|
|
- type: "activeUser"
|
|
- user: [User](./TYPES.md#user)
|
|
|
|
**Errors**:
|
|
- ChatNotStarted: Chat not started.
|
|
|
|
---
|
|
|
|
|
|
### APIDeleteUser
|
|
|
|
Delete user profile.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- delSMPQueues: bool
|
|
- viewPwd: string?
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_delete user <userId> del_smp=on|off[ <json(viewPwd)>]
|
|
```
|
|
|
|
```javascript
|
|
'/_delete user ' + userId + ' del_smp=' + (delSMPQueues ? 'on' : 'off') + (viewPwd ? ' ' + JSON.stringify(viewPwd) : '') // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_delete user ' + str(userId) + ' del_smp=' + ('on' if delSMPQueues else 'off') + ((' ' + json.dumps(viewPwd)) if viewPwd is not None else '') # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
CmdOk: Ok.
|
|
- type: "cmdOk"
|
|
- user_: [User](./TYPES.md#user)?
|
|
|
|
---
|
|
|
|
|
|
### APIUpdateProfile
|
|
|
|
Update user profile.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- userId: int64
|
|
- profile: [Profile](./TYPES.md#profile)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_profile <userId> <json(profile)>
|
|
```
|
|
|
|
```javascript
|
|
'/_profile ' + userId + ' ' + JSON.stringify(profile) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_profile ' + str(userId) + ' ' + json.dumps(profile) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
UserProfileUpdated: User profile updated.
|
|
- type: "userProfileUpdated"
|
|
- user: [User](./TYPES.md#user)
|
|
- fromProfile: [Profile](./TYPES.md#profile)
|
|
- toProfile: [Profile](./TYPES.md#profile)
|
|
- updateSummary: [UserProfileUpdateSummary](./TYPES.md#userprofileupdatesummary)
|
|
|
|
---
|
|
|
|
|
|
### APISetContactPrefs
|
|
|
|
Configure chat preference overrides for the contact.
|
|
|
|
*Network usage*: background.
|
|
|
|
**Parameters**:
|
|
- contactId: int64
|
|
- preferences: [Preferences](./TYPES.md#preferences)
|
|
|
|
**Syntax**:
|
|
|
|
```
|
|
/_set prefs @<contactId> <json(preferences)>
|
|
```
|
|
|
|
```javascript
|
|
'/_set prefs @' + contactId + ' ' + JSON.stringify(preferences) // JavaScript
|
|
```
|
|
|
|
```python
|
|
'/_set prefs @' + str(contactId) + ' ' + json.dumps(preferences) # Python
|
|
```
|
|
|
|
**Response**:
|
|
|
|
ContactPrefsUpdated: Contact preferences updated.
|
|
- type: "contactPrefsUpdated"
|
|
- user: [User](./TYPES.md#user)
|
|
- fromContact: [Contact](./TYPES.md#contact)
|
|
- toContact: [Contact](./TYPES.md#contact)
|
|
|
|
---
|