get_message_threads

toloka.client.TolokaClient.get_message_threads | Source code

Finds all message threads that match certain criteria.

get_message_threads returns a generator. You can iterate over all found message threads using the generator. Several requests to the Toloka server are possible while iterating.

If you need to sort message threads use the find_message_threads method.

Parameters description

ParametersTypeDescription
folderUnion[str, Folder, List[Union[str, Folder]], None]

A folder where to search threads or a list of folders. Refer to the Folder page for more information on the available folder values.

folder_neUnion[str, Folder, List[Union[str, Folder]], None]

A folder to skip or a list of folders. Supported values are the same as for folder.

id_ltOptional[str]

Threads with IDs less than the specified value.

id_lteOptional[str]

Threads with IDs less than or equal to the specified value.

id_gtOptional[str]

Threads with IDs greater than the specified value.

id_gteOptional[str]

Threads with IDs greater than or equal to the specified value.

created_ltOptional[datetime]

Threads created before the specified date.

created_lteOptional[datetime]

Threads created before or on the specified date.

created_gtOptional[datetime]

Threads created after the specified date.

created_gteOptional[datetime]

Threads created after or on the specified date.

batch_sizeOptional[int]

A limit of items returned by each request to Toloka. The maximum allowed value: 300. The default value: 50.

  • Yields:

    The next matching message thread.

  • Yield type:

    Generator[MessageThread, None, None]

Examples:

How to get all unread incoming messages.

message_threads = toloka_client.get_message_threads(folder=['INBOX', 'UNREAD'])

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming