Client. Chat List (TelegramClientGetChats)#
Returns all user chats: group chats, channels, dialogues.
| Connection | [Link] Client connection object. The variable name in this property must match the variable name in the "Connection" property of the "Client. Create Connection" block from the Telegram group that was previously used to connect the Telegram client. |
| Filter | [Text] A string for filtering the chat list. Searches for the occurrence of the specified value in chats (Id, Title) and in dialogues (Id, FirstName, LastName, Username, Phone). |
| Return as list | If enabled, the result will be returned as a list of chat objects. Available properties: Id; Title; IsPrivate - indicates that this chat is private with the User. If the property is equal to $true (and the "Extract User Data" property is also enabled), then the following properties are available: UserId; UserName; PhoneNumber. Properties Chat and User are also available, pointing to these Telegram objects. |
| Extract User Data | If the "Return as list" property is enabled, then when this property is enabled, user data will be extracted for private chats. |
| Chat List | [Dictionary/List] The list of chats is returned as a dictionary. The keys of the dictionary are the chat names, and the values are the chat ids. For example: $chatid = $Chats["username"]. This retrieves the chat id value with the user username, and this variable can then be used in message sending blocks. If a list is returned, the following properties are available: Id, Title, UserId, Username, PhoneNumber. |
| Error Handling Level | Select the error handling level. Possible values:
If "Default" is selected, the value from the "Start" block of this diagram will be used. |
| Message Level | Select the message level that blocks will output during operation. Possible values:
If "Default" is selected, the value from the "Start" block of this diagram will be used. |
| Error Text | [Text] Returns detailed information about the error in case of incorrect execution of the block. |