Toloka documentation

find_message_threads

toloka.client.TolokaClient.find_message_threads | Source code

Finds message threads that match certain criteria.

The number of returned message threads is limited. To find remaining threads call find_message_threads with updated search criteria.

To iterate over all matching threads you may use the get_message_threads method.

Parameters Description

Parameters Type Description
folder Union[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_ne Union[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_lt Optional[str]

Threads with IDs less than the specified value.

id_lte Optional[str]

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

id_gt Optional[str]

Threads with IDs greater than the specified value.

id_gte Optional[str]

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

created_lt Optional[datetime]

Threads created before the specified date.

created_lte Optional[datetime]

Threads created before or on the specified date.

created_gt Optional[datetime]

Threads created after the specified date.

created_gte Optional[datetime]

Threads created after or on the specified date.

sort Union[List[str], MessageThreadSortItems, None]

Sorting options. Default: None.

limit Optional[int]

Returned message threads limit. The default limit is 50. The maximum allowed limit is 300.

  • Returns:

    Found message threads and a flag showing whether there are more matching threads.

  • Return type:

    MessageThreadSearchResult

Examples:

Find all message threads in the Inbox folder.

toloka_client.find_message_threads(folder='INBOX')