messages.getDialogs

Returns the current user dialog list.

Example

Javascript

const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.messages.getDialogs({
        excludePinned: true,
        folderId: 1470086,
        offsetDate: 2226947,
        offsetId: 483369,
        offsetPeer: new Api.InputPeer({...}),
        limit: 5241323,
        hash: 7683946,
        }));
    console.log(result); // prints the result
})();

TypeScript

import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.messages.Dialogs = await client.invoke(new Api.messages.getDialogs({
        excludePinned: true,
        folderId: 1470086,
        offsetDate: 2226947,
        offsetId: 483369,
        offsetPeer: new Api.InputPeer({...}),
        limit: 5241323,
        hash: 7683946,
        }));
    console.log(result); // prints the result
})();

TL schema

messages.dialogs#15ba6c40 dialogs:Vector<Dialog> messages:Vector<Message> chats:Vector<Chat> users:Vector<User> = messages.Dialogs;
messages.dialogsSlice#71e094f3 count:int dialogs:Vector<Dialog> messages:Vector<Message> chats:Vector<Chat> users:Vector<User> = messages.Dialogs;
messages.dialogsNotModified#f0e3e596 count:int = messages.Dialogs;
---functions---
messages.getDialogs#a0ee3b73 flags:# exclude_pinned:flags.0?true folder_id:flags.1?int offset_date:int offset_id:int offset_peer:InputPeer limit:int hash:int = messages.Dialogs;

Parameters

Name	Type	Description
flags	#	Flags, see TL conditional fields
exclude_pinned	flags.0?true	Exclude pinned dialogs
folder_id	flags.1?int	Peer folder ID, for more info click here
offset_date	int	Offsets for pagination, for more info click here
offset_id	int	Offsets for pagination, for more info click here
offset_peer	InputPeer	Offset peer for pagination
limit	int	Number of list elements to be returned
hash	int	Hash for pagination, for more info click here

Result

messages.Dialogs

Possible errors

Code	Type	Description
400	FOLDER_ID_INVALID	Invalid folder ID
400	INPUT_CONSTRUCTOR_INVALID	The provided constructor is invalid
400	OFFSET_PEER_ID_INVALID	The provided offset peer is invalid

Can bots use this methd ?

yes

Related pages

Folders

Telegram allows placing chats into folders, based on their type, mute status, or other custom criteria, thanks to folder blacklists and whitelists.

Pagination in the API

How to fetch results from large lists of objects.