Search Chats

Search chat in Microsoft Teams.

Options

Field	Definition	Type	Required
Result Set	Choose one of the following options to display your search results: First 50 Matching Records - returns the first 50 matching chats. Stream Matching Records - pass all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE
Search By	Choose whether to return teams that are an Exact Match of the search or Starts With the search expression.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose one of the following options to display your search results:

First 50 Matching Records - returns the first 50 matching chats.
Stream Matching Records - pass all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.

Dropdown

TRUE

Search By

Choose whether to return teams that are an Exact Match of the search or Starts With the search expression.

Dropdown

TRUE

Input

Field	Definition	Type	Required
Search
Topic	Title of the chat. The chat title can be provided only if the chat is a group type. Appears when you select Exact Match or Starts With in the Search By option.	Text	FALSE
Chat Type	Specifies the type of chat. Possible values are: oneOnOne: indicates that the chat is a 1:1 chat. group: indicates that the chat is a group chat. Appears when you select Exact Match in the Search By option.	Dropdown	TRUE
Search Criteria	Appears when you select Stream Matching Records in the Result Set option.
Record Limit	Specify the number of records to stream. When the Record Limit field is set to 0, the card returns a 400 Bad Request error. When the Record Limit field is set to greater than 0, the stream returns up to the maximum number specified. When the Record Limit field is empty, null, or not selected, the stream returns all records. The default value is 120000. The valid range is 1 to 120000.	Number	TRUE
Streaming	Appears when you select Stream Matching Records in the Result Set option.
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.	Flow	TRUE

Output

Field	Definition	Type
Chats
Id	Unique identifier of the chat.	Text
Chat Type	Specifies the type of chat.	Text
Members	Represents a user in a team, a channel, or a chat. See Conversation Member.	List of Objects
Topic	Title of the chat. The chat title can be provided only if the chat is a group type.	Text
Created Date Time	The date and time at which the chat was created.	Date & Time
Last Updated Date Time	The date and time at which the chat was renamed or when the list of members was last changed.	Date & Time
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Matching Records from the Result Set option.	Number

Additional information

If the First 50 Matching Records option is selected from Result Set, the API may not respond with all the records that are expected. To ensure that all records are found, use the Stream Matching Records option.

Search Chats

Options

Input

Output

Additional information

Related topics