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 will be 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 of group type.

Appears when Exact Match or Starts With are selected the Search By option.

 String 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 Exact Match is selected the Search By option.

 Dropdown TRUE
Search Criteria
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, no records are returned.

  • When the Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Limit field is empty or not selected, all records are streamed.

  • Default value is 10 million.

  • Valid range is 0 to 10 million.

Appears when Stream Matching Records is selected from the Result Set option.

 Number TRUE
Streaming
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 ID of the chat. String
Chat Type Specifies the type of chat. String
Members Represents a user in a team, a channel, or a chat. See ConversationMember. List of Object
Topic Title of the chat. The chat title can be provided only if the chat is of group type. String
Created Date Time Date and time at which the chat was created. Date and Time
Last Updated Date Time Date and time at which the chat was renamed or list of members were last changed. Date and Time
Records Streamed Number of records streamed in a streaming flow.

Appears when Stream Matching Records is selected 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.

Related topics

Microsoft Teams connector

Workflow elements

Guidance for Microsoft Teams connector

Microsoft Teams API overview