Interface MessagesGetConversationsParams

interface MessagesGetConversationsParams {
    count?: number;
    extended?: number | boolean;
    fields?: BaseUserGroupFields[];
    filter?: "all" | "unread" | "important" | "unanswered" | "archive" | "sorted_chats";
    group_id?: number;
    offset?: number;
    start_message_id?: number;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

count? extended? fields? filter? group_id? offset? start_message_id?

Properties

Optional count

count?: number

Number of conversations to return.

Optional extended

extended?: number | boolean

'1' - return extra information about users and communities

Optional fields

fields?: BaseUserGroupFields[]

Optional filter

filter?: "all" | "unread" | "important" | "unanswered" | "archive" | "sorted_chats"

Filter to apply: 'all' - all conversations, 'unread' - conversations with unread messages, 'important' - conversations, marked as important (only for community messages), 'unanswered' - conversations, marked as unanswered (only for community messages)

Optional group_id

group_id?: number

Group ID (for group messages with group access token)

Optional offset

offset?: number

Offset needed to return a specific subset of conversations.

Optional start_message_id

start_message_id?: number

ID of the message from what to return dialogs.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc