ms-teams-chat-messages-batch
Retrieves the chat messages of each user in the input rows in batch using Microsoft Graph API.
Syntax
ms-teams-chat-messages-batch profile=STRING [user-field=STRING] [duration=STRING] [from=DATETIME] [to=DATETIME] [limit=INT] [include-system=BOOL]
Options
- profile=STRING
- Required. Microsoft Teams Graph API connect profile name. Only one profile is allowed.
- user-field=STRING
- Optional. Input field that holds the user principal name or object ID. (default: user)
- duration=STRING
- Optional. Query only recent messages. e.g. 10m, 1h, 1d
- from=DATETIME
- Optional. Start of the query range. One day before the end by default.
- to=DATETIME
- Optional. End of the query range. The current time by default.
- limit=INT
- Optional. Maximum number of messages to retrieve per input row. Specify a positive integer.
- include-system=BOOL
- Optional. Include system event messages such as membership changes. (default: f)
Input fields
| Field | Type | Required | Description |
|---|---|---|---|
| user | string | Y | User principal name or object ID to query. e.g. hong@example.com. Use the user-field option to read another field name |
Output fields
| Field | Type | Name | Description |
|---|---|---|---|
| _time | date | Time | Time the message was created |
| profile | string | Connect profile | Microsoft Teams Graph API connect profile name. e.g. ms_teams_graph |
| user | string | Queried user | User whose chat messages were queried. e.g. hong@example.com |
| msg_id | string | Message ID | Message ID |
| chat_id | string | Chat ID | ID of the chat the message belongs to. Shared by every message of the same chat |
| updated | date | Updated | Time the message was last modified. The query range filters on this value |
| msg_type | string | Message type | message, chatEvent, typing, systemEventMessage |
| from_user_id | string | Sender ID | Object ID of the sender. null when the sender is not set |
| from_user_name | string | Sender name | Display name of the sender. e.g. Hong Gildong |
| msg | string | Message | Message body with HTML markup removed. e.g. Sharing the meeting notes |
| content_type | string | Content type | Content type of the original body. html or text |
| importance | string | Importance | normal, high, urgent |
| _error | string | Error | Error message for invalid input or API failure. Present only on failed input rows |