Cmdlets for Microsoft Teams

Build 23.0.8839

ChannelMessages

Get Channel messages and its replies.

Table Specific Information

Select

The cmdlet uses the Microsoft Teams API to process WHERE clause conditions built with the columns and operator shown below. The rest of the filter is executed client-side within the cmdlet.

  • TeamId supports '=' operator.
  • ChannelId supports '=' operator.
  • Id supports '=' operator.
  • ReplyToId supports '=' operator.

Note: ChannelId and TeamId are required columns to get results from this view, and must both be specified in the WHERE clause. The data cannot be retrieved by the cmdlet using ChannelId alone.

Example Queries

The cmdlet executes this by fetching ChannelID and TeamId from Microsoft Teams API:

SELECT * FROM ChannelMessages

This query uses the TeamID from Microsoft Teams API to obtain the ChannelID:

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]'

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND Id='1688061957561'

To get all the replies in a message:

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND ReplyToId='1688061957561'

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND Id='1688061957562' AND ReplyToId='1688061957561'

Columns

Name Type Description
Id [KEY] String The Channel Messsages Id.
BodyContent String Content of the Body.
BodyContentType String Type of BodyContent.
ChannelId String The Channel Id.
TeamId String The Team Id.
Mentions String List of entities mentioned in the channel message. Supported entities are: user, bot, team, and channel.
Reactions String Reactions for the channel messages (for example, Like).
Attachments String References to attached objects like files, tabs, meetings etc.
Importance String Importance of the messages.
CreatedDateTime Datetime Timestamp of when the channel message was created.
LastEditedDateTime Datetime The timestamp on which this message was last edited.
LastModifiedDateTime Datetime The timestamp on which this message was last updated.
DeletedDateTime Datetime Timestamp at which the channel messages was deleted, or null if not deleted.
MessageType String Type of Channel message.
ChatId String The Chat Id.
Etag String Version number of the channel message.
FromUserDisplayName String From User Display Name.
FromUserId String From User Id.
FromUserUserIdentityType String From User UserIdentityType.
FromApplication String The From Application.
FromDevice String The From Device.
Locale String Locale of the channel message set by the client. Always set to en-us.
PolicyViolation String Channel Message Policy Violation.
ReplyToId String ID of the parent chat message or root chat message of the thread.
Subject String The subject of the channel message, in plaintext.
Summary String Summary text of the channel message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
WebUrl String Link to the message in Microsoft Teams.
EventDetail String The Event Message Detail.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839