TeamsClient
Attributes
module-attribute
module-attribute
ThemeEditor = Literal['white', 'blue', 'green', 'purple', 'pink', 'yellow', 'gray', 'darkblue', 'darkgreen', 'darkpurple', 'darkpink', 'darkyellow']
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewChannelMessage': {'operation_id': 'OnNewChannelMessage', 'path': '/{connectionId}/trigger/beta/teams/{groupId}/channels/{channelId}/messages', 'method': 'get', 'required_parameters': ['groupId', 'channelId'], 'callback_payload_type': 'ChatMessageList'}, 'OnNewChannelMessageMentioningMe': {'operation_id': 'OnNewChannelMessageMentioningMe', 'path': '/{connectionId}/trigger/beta/teams/{groupId}/channels/{channelId}/messages_mentioningme', 'method': 'get', 'required_parameters': ['groupId', 'channelId'], 'callback_payload_type': 'ChatMessageList'}, 'WebhookAtMentionTrigger': {'operation_id': 'WebhookAtMentionTrigger', 'path': '/{connectionId}/beta/subscriptions/atmentiontrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['threadType'], 'callback_payload_type': None}, 'WebhookMessageReactionTrigger': {'operation_id': 'WebhookMessageReactionTrigger', 'path': '/{connectionId}/beta/subscriptions/messagereactiontrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['reactionKey', 'frequency', 'runningPolicy', 'threadType'], 'callback_payload_type': None}, 'TranscriptTrigger': {'operation_id': 'TranscriptTrigger', 'path': '/{connectionId}/beta/subscriptions/transcripttrigger', 'method': 'post', 'required_parameters': ['scopeType', 'body'], 'callback_payload_type': None}, 'RecordingTrigger': {'operation_id': 'RecordingTrigger', 'path': '/{connectionId}/beta/subscriptions/recordingtrigger', 'method': 'post', 'required_parameters': ['scopeType', 'body'], 'callback_payload_type': None}, 'WebhookChatMessageTrigger': {'operation_id': 'WebhookChatMessageTrigger', 'path': '/{connectionId}/beta/subscriptions/chatmessagetrigger', 'method': 'post', 'required_parameters': ['ChatMessageSubscriptionRequest'], 'callback_payload_type': None}, 'WebhookKeywordTrigger': {'operation_id': 'WebhookKeywordTrigger', 'path': '/{connectionId}/beta/subscriptions/keywordtrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['threadType', '$search'], 'callback_payload_type': None}, 'WebhookNewMessageTrigger': {'operation_id': 'WebhookNewMessageTrigger', 'path': '/{connectionId}/beta/subscriptions/newmessagetrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['threadType'], 'callback_payload_type': None}, 'OnGroupMembershipRemoval': {'operation_id': 'OnGroupMembershipRemoval', 'path': '/{connectionId}/trigger/v1.0/groups/removal', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnGroupMemberChangeResponse'}, 'OnGroupMembershipAdd': {'operation_id': 'OnGroupMembershipAdd', 'path': '/{connectionId}/trigger/v1.0/groups/delta', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnGroupMemberChangeResponse'}}
Classes
dataclass
NewMeetingResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, categories: Optional[List[Any]] = None, time_zone: Optional[str] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, has_attachments: Optional[bool] = None, subject: Optional[str] = None, body_preview: Optional[str] = None, importance: Optional[str] = None, sensitivity: Optional[str] = None, is_all_day: Optional[bool] = None, is_cancelled: Optional[bool] = None, is_organizer: Optional[bool] = None, response_requested: Optional[bool] = None, show_as: Optional[str] = None, type_: Optional[str] = None, web_link: Optional[str] = None, online_meeting_url: Optional[str] = None, allow_new_time_proposals: Optional[bool] = None, recurrence: Optional[Dict[str, Any]] = None, response_status: Optional[Dict[str, Any]] = None, body: Optional[Dict[str, Any]] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, attendees: Optional[List[Dict[str, Any]]] = None, organizer: Optional[Dict[str, Any]] = None, online_meeting: Optional[Dict[str, Any]] = None)
Response for Create a Teams meeting
Attributes
class-attribute
instance-attribute
Timestamp the event was created
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
Timestamp the event was last modified
class-attribute
instance-attribute
The categories associated with the event
class-attribute
instance-attribute
Time zone of the event
class-attribute
instance-attribute
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})
The number of minutes before the event start time that the reminder alert occurs
class-attribute
instance-attribute
Set to true if an alert is set to remind the user of the event
class-attribute
instance-attribute
Set to true if the event has attachments
class-attribute
instance-attribute
The text of the event's subject line
class-attribute
instance-attribute
The preview of the message associated with the event
class-attribute
instance-attribute
The importance of the event. The possible values are: low, normal, high
class-attribute
instance-attribute
Sensitivity of the event
class-attribute
instance-attribute
Set to true if the event lasts all day
class-attribute
instance-attribute
Set to true if the event has been canceled
class-attribute
instance-attribute
Set to true if the calendar owner is the organizer of the event
class-attribute
instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})
The organizer would like an invitee to send a response to the event
class-attribute
instance-attribute
The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
class-attribute
instance-attribute
The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster
class-attribute
instance-attribute
The URL to open the event in Outlook on the web.
class-attribute
instance-attribute
A URL for an online meeting
class-attribute
instance-attribute
allow_new_time_proposals: Optional[bool] = field(default=None, metadata={'wire_name': 'allowNewTimeProposals'})
True if the meeting organizer allows invitees to propose a new time when responding
class-attribute
instance-attribute
The recurrence pattern for the event
class-attribute
instance-attribute
response_status: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'responseStatus'})
Indicates the type of response sent in response to an event message
class-attribute
instance-attribute
The body of the message associated with the event
class-attribute
instance-attribute
The start date, time, and time zone of the event
class-attribute
instance-attribute
The date, time, and time zone that the event ends
class-attribute
instance-attribute
The location of the event
class-attribute
instance-attribute
The collection of attendees for the event
dataclass
dataclass
dataclass
dataclass
CreateChannelInput(description: Optional[str] = None, display_name: Optional[str] = None, membership_type: Optional[str] = None)
Create a channel
Attributes
class-attribute
instance-attribute
Optional textual description for the channel
class-attribute
instance-attribute
Channel name as it appears in Microsoft Teams
class-attribute
instance-attribute
The type of channel. Private channels are accessible only to specific members. Shared channels can be shared with users outside the team. Defaults to standard.
dataclass
CreateChannelResponse(description: Optional[str] = None, display_name: Optional[str] = None, id: Optional[str] = None, membership_type: Optional[str] = None)
Response for Create a channel
Attributes
class-attribute
instance-attribute
Optional textual description for the channel
class-attribute
instance-attribute
Channel name as it appears in Microsoft Teams
dataclass
GetChannelResponse(id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, email: Optional[str] = None, tenant_id: Optional[str] = None, web_url: Optional[str] = None, files_folder_web_url: Optional[str] = None, created_date_time: Optional[str] = None, membership_type: Optional[str] = None)
Response for Get details for a specific channel in a team
Attributes
class-attribute
instance-attribute
The name of the channel
class-attribute
instance-attribute
The description of the channel, optional
class-attribute
instance-attribute
The email address for sending messages to the channel
class-attribute
instance-attribute
The ID of the Microsoft Entra tenant.
class-attribute
instance-attribute
A hyperlink for the channel in Microsoft Teams
class-attribute
instance-attribute
files_folder_web_url: Optional[str] = field(default=None, metadata={'wire_name': 'filesFolderWebUrl'})
The SharePoint folder URL of the channel
class-attribute
instance-attribute
Timestamp at which the channel was created. Read only
dataclass
Update channel
Attributes
class-attribute
instance-attribute
The new display name for the channel.
dataclass
Archive a channel
Attributes
class-attribute
instance-attribute
should_set_spo_site_read_only_for_members: Optional[bool] = field(default=None, metadata={'wire_name': 'shouldSetSpoSiteReadOnlyForMembers'})
If true, sets permissions for channel members to read-only on the SharePoint Online site associated with the team.
dataclass
dataclass
dataclass
dataclass
dataclass
GetMessagesFromConversationResponse(context: Optional[str] = None, count: Optional[int] = None, next_link: Optional[str] = None, value: Optional[ChatMessageList] = None)
Response for Get messages in a channel
Attributes
class-attribute
instance-attribute
@odata.context
class-attribute
instance-attribute
@odata.count
dataclass
dataclass
dataclass
dataclass
When a new chat message is added
dataclass
GetTeamResponse(id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, internal_id: Optional[str] = None, web_url: Optional[str] = None, is_archived: Optional[bool] = None, member_settings: Optional[MemberSettings] = None, guest_settings: Optional[GuestSettings] = None, messaging_settings: Optional[MessagingSettings] = None, fun_settings: Optional[FunSettings] = None, discovery_settings: Optional[DiscoverySettings] = None)
Response for Get a team
Attributes
class-attribute
instance-attribute
The name of the team
class-attribute
instance-attribute
The description of the team, optional
class-attribute
instance-attribute
The internal ID of the team
class-attribute
instance-attribute
A hyperlink that will go to the team in the Microsoft Teams client
dataclass
dataclass
dataclass
ChatMessage(attachments: Optional[List[Dict[str, Any]]] = None, body: Optional[Dict[str, Any]] = None, created_date_time: Optional[str] = None, deleted: Optional[bool] = None, etag: Optional[str] = None, from_: Optional[Dict[str, Any]] = None, id: Optional[str] = None, importance: Optional[str] = None, last_modified_date_time: Optional[str] = None, locale: Optional[str] = None, mentions: Optional[List[Dict[str, Any]]] = None, message_type: Optional[str] = None, reactions: Optional[List[Dict[str, Any]]] = None, reply_to_id: Optional[str] = None, subject: Optional[str] = None, summary: Optional[str] = None)
Response for Post a message to myself
Attributes
class-attribute
instance-attribute
attachments
class-attribute
instance-attribute
Plaintext representation of the content of the message
class-attribute
instance-attribute
Timestamp of when the chat message was created
class-attribute
instance-attribute
Version number of the chat message.
class-attribute
instance-attribute
The message sender
class-attribute
instance-attribute
The importance of the message. The possible values are: normal, high, urgent.
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed
class-attribute
instance-attribute
Locale of the chat message set by the client.
class-attribute
instance-attribute
List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.
class-attribute
instance-attribute
The type of chat message
class-attribute
instance-attribute
Reactions for this chat message (for example, Like)
class-attribute
instance-attribute
ID of the parent message of the thread
class-attribute
instance-attribute
The subject of the chat message, optional
dataclass
CreateATeamInput(display_name: Optional[str] = None, description: Optional[str] = None, visibility: Optional[str] = None)
Create a team
Attributes
class-attribute
instance-attribute
The name of the team
class-attribute
instance-attribute
An optional description for the team
dataclass
dataclass
Add a member to a team
dataclass
Add a member to a channel
dataclass
PostToConversationResponse(id: Optional[str] = None, message_link: Optional[str] = None, conversation_id: Optional[str] = None)
Response for Post message in a chat or channel
Attributes
class-attribute
instance-attribute
Link to the message in Microsoft Teams
dataclass
PostCardAndWaitForResponseInput(notification_url: Optional[str] = None, body: Optional[Dict[str, Any]] = None)
Post adaptive card and wait for a response
dataclass
dataclass
dataclass
AddMemberToChatInput(user_id: Optional[str] = None, owner: Optional[bool] = None, visible_history_start_date_time: Optional[str] = None)
Add a user to a chat
Attributes
class-attribute
instance-attribute
User principal name or Microsoft Entra ID to add
class-attribute
instance-attribute
True, if the user should be a chat owner
class-attribute
instance-attribute
visible_history_start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'visibleHistoryStartDateTime'})
Timestamp that represents how far back in the chat history the new member can see. If not specified, no history is shared.
dataclass
GetOnlineMeetingResponse(id: Optional[str] = None, subject: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, creation_date_time: Optional[str] = None, join_web_url: Optional[str] = None, join_meeting_id_settings: Optional[Dict[str, Any]] = None, participants: Optional[Dict[str, Any]] = None, audio_conferencing: Optional[Dict[str, Any]] = None, is_entry_exit_announced: Optional[bool] = None, allowed_presenters: Optional[str] = None, lobby_bypass_settings: Optional[Dict[str, Any]] = None, record_automatically: Optional[bool] = None, allow_meeting_chat: Optional[str] = None, meeting_options_web_url: Optional[str] = None)
Response for Get an online meeting
Attributes
class-attribute
instance-attribute
The unique identifier of the online meeting
class-attribute
instance-attribute
The subject of the online meeting
class-attribute
instance-attribute
The start time of the meeting in UTC
class-attribute
instance-attribute
The end time of the meeting in UTC
class-attribute
instance-attribute
The creation time of the meeting in UTC
class-attribute
instance-attribute
The URL used to join the meeting online
class-attribute
instance-attribute
join_meeting_id_settings: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'joinMeetingIdSettings'})
Settings related to the join meeting ID
class-attribute
instance-attribute
The participants of the meeting
class-attribute
instance-attribute
audio_conferencing: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'audioConferencing'})
Phone call-in information for the meeting
class-attribute
instance-attribute
is_entry_exit_announced: Optional[bool] = field(default=None, metadata={'wire_name': 'isEntryExitAnnounced'})
Whether announce notifications are enabled for callers joining or leaving the meeting
class-attribute
instance-attribute
allowed_presenters: Optional[str] = field(default=None, metadata={'wire_name': 'allowedPresenters'})
Specifies who can be a presenter in the meeting
class-attribute
instance-attribute
lobby_bypass_settings: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'lobbyBypassSettings'})
Specifies which participants can bypass the meeting lobby
class-attribute
instance-attribute
record_automatically: Optional[bool] = field(default=None, metadata={'wire_name': 'recordAutomatically'})
Indicates whether to record the meeting automatically
class-attribute
instance-attribute
Specifies the mode of meeting chat
dataclass
dataclass
CallTranscriptResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, transcript_content_url: Optional[str] = None, meeting_id: Optional[str] = None, meeting_organizer_id: Optional[str] = None, call_id: Optional[str] = None)
Response for Get meeting transcript
Attributes
class-attribute
instance-attribute
The date and time when the transcript was created
class-attribute
instance-attribute
transcript_content_url: Optional[str] = field(default=None, metadata={'wire_name': 'transcriptContentUrl'})
The URL to access the transcript content
class-attribute
instance-attribute
The meeting ID
dataclass
dataclass
CallRecordingResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, recording_content_url: Optional[str] = None, meeting_id: Optional[str] = None, meeting_organizer_id: Optional[str] = None, call_id: Optional[str] = None)
Response for Get meeting recording
Attributes
class-attribute
instance-attribute
The date and time when the recording was created
class-attribute
instance-attribute
recording_content_url: Optional[str] = field(default=None, metadata={'wire_name': 'recordingContentUrl'})
The URL to access the recording content
class-attribute
instance-attribute
The meeting ID
dataclass
ListSectionsResponse(context: Optional[str] = None, microsoft_graph_sections_version: Optional[str] = None, value: Optional[List[SectionResponse]] = None)
Response for List sections
Attributes
class-attribute
instance-attribute
microsoft_graph_sections_version: Optional[str] = field(default=None, metadata={'wire_name': '@microsoft.graph.sectionsVersion'})
Version identifier for the sections hierarchy. Pass as If-Match on Create, Update, Delete, Add Item, Remove Item, and Move Item operations.
dataclass
CreateSectionInput(display_name: Optional[str] = None, display_icon: Optional[Dict[str, Any]] = None, is_expanded: Optional[bool] = None, sort_type: Optional[str] = None)
Create a section
Attributes
class-attribute
instance-attribute
The display name of the section
class-attribute
instance-attribute
The display icon for the section. Only iconType is writable; other fields are populated by the service.
class-attribute
instance-attribute
Whether the section is expanded
dataclass
SectionResponse(etag: Optional[str] = None, id: Optional[str] = None, display_name: Optional[str] = None, display_icon: Optional[Dict[str, Any]] = None, is_expanded: Optional[bool] = None, sort_type: Optional[str] = None, section_type: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None)
Response for Create a section
Attributes
class-attribute
instance-attribute
ETag for the sections collection. Pass as If-Match on Create, Update, and Delete.
class-attribute
instance-attribute
The display name of the section
class-attribute
instance-attribute
The display icon for the section
class-attribute
instance-attribute
Whether the section is expanded
class-attribute
instance-attribute
The sort type for the section
class-attribute
instance-attribute
The type of section
class-attribute
instance-attribute
The date and time when the section was created
dataclass
UpdateSectionInput(display_name: Optional[str] = None, display_icon: Optional[Dict[str, Any]] = None, is_expanded: Optional[bool] = None, sort_type: Optional[str] = None)
Update a section
Attributes
class-attribute
instance-attribute
The display name of the section
class-attribute
instance-attribute
The display icon for the section. Only iconType is writable; other fields are populated by the service.
class-attribute
instance-attribute
Whether the section is expanded
dataclass
dataclass
dataclass
SectionItemResponse(etag: Optional[str] = None, id: Optional[str] = None, item_type: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None)
Response for Add an item to a section
Attributes
class-attribute
instance-attribute
ETag for the section items collection. Pass as If-Match on Add, Remove, and Move.
class-attribute
instance-attribute
The unique identifier of the item. Corresponds to the conversation ID of the underlying chat, channel, meeting, or community.
class-attribute
instance-attribute
The type of the item
class-attribute
instance-attribute
The date and time when the item was added to the section
dataclass
dataclass
Response for List all tags for a team
dataclass
Create a tag for a team
Attributes
class-attribute
instance-attribute
The name of the tag as it appears to the user in Microsoft Teams.
dataclass
CreateTagResponseSchema(type_: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None, display_name: Optional[str] = None, member_count: Optional[int] = None)
Response for Create a tag for a team
Attributes
class-attribute
instance-attribute
ID of the team in which the tag is defined
class-attribute
instance-attribute
The name of the tag as it appears to the user in Microsoft Teams.
dataclass
dataclass
dataclass
dataclass
Response for List the members of a team tag
dataclass
dataclass
AiInsightResponse(id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None)
Response for Get AI insight
Attributes
class-attribute
instance-attribute
The call ID
class-attribute
instance-attribute
content_correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'contentCorrelationId'})
The content correlation ID
class-attribute
instance-attribute
The date and time when the AI insight was created
dataclass
dataclass
Response for Get message details response schema
dataclass
Response for List members input schema
dataclass
Response for Get feed notification input metadata
dataclass
Response for Get unified action input metadata
dataclass
ConnectorMetadata(metadatatype: Optional[str] = None, activitytype: Optional[str] = None, schema: Optional[ObjectEntity] = None)
Response for Get message with options subscription input metadata
dataclass
Response for Input schema for webhook trigger
dataclass
Response for Get response schema
dataclass
dataclass
Definition: PostMessageSchema
dataclass
Definition: PostCardSchema
dataclass
Definition: PostCardAndWaitSchema
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
MessageReactionWebhookResponseSchema(thread_type: Optional[str] = None, chat_id: Optional[str] = None, team_id: Optional[str] = None, channel_id: Optional[str] = None, message_id: Optional[str] = None, reply_to_id: Optional[str] = None, message_link: Optional[str] = None, user_id: Optional[str] = None, message_reaction: Optional[str] = None)
Definition: MessageReactionWebhookResponseSchema
Attributes
class-attribute
instance-attribute
The chat's unique identifier
class-attribute
instance-attribute
The team's unique identifier
class-attribute
instance-attribute
The channel's unique identifier
class-attribute
instance-attribute
Id of the message which was reacted
class-attribute
instance-attribute
ID of the parent message of the thread
class-attribute
instance-attribute
Link to the message which was reacted
class-attribute
instance-attribute
Reacting user's Id
dataclass
TeamsIdentitySet(application: Optional[Dict[str, Any]] = None, device: Optional[Dict[str, Any]] = None, user: Optional[Dict[str, Any]] = None)
Definition: TeamsIdentitySet
Attributes
class-attribute
instance-attribute
Application identity (bot or service)
dataclass
CallEventWebhookResponseSchema(id: Optional[str] = None, id_2: Optional[str] = None, type_: Optional[str] = None, call_event_type: Optional[str] = None, event_date_time: Optional[str] = None, call_conversation_id: Optional[str] = None, join_web_url: Optional[str] = None, chat_info: Optional[Dict[str, Any]] = None, organizer_meeting_info: Optional[Dict[str, Any]] = None, transcription_state: Optional[Dict[str, Any]] = None, recording_state: Optional[Dict[str, Any]] = None, participants: Optional[List[Dict[str, Any]]] = None)
Definition: CallEventWebhookResponseSchema
Attributes
class-attribute
instance-attribute
OData identifier
class-attribute
instance-attribute
OData type discriminator (always #microsoft.graph.callEvent; meeting-specific fields are flattened onto the base type by notification delivery).
class-attribute
instance-attribute
Type of call event
class-attribute
instance-attribute
When the event occurred
class-attribute
instance-attribute
call_conversation_id: Optional[str] = field(default=None, metadata={'wire_name': 'callConversationId'})
Call conversation identifier
class-attribute
instance-attribute
Meeting join URL (populated when the call is associated with an online meeting)
class-attribute
instance-attribute
Chat information for the meeting (populated when the call is associated with an online meeting)
class-attribute
instance-attribute
organizer_meeting_info: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'organizerMeetingInfo'})
Organizer info (populated when the call is associated with an online meeting)
class-attribute
instance-attribute
transcription_state: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'transcriptionState'})
Transcription state (set on transcriptionStateUpdated events)
dataclass
TranscriptWebhookResponseSchema(id: Optional[str] = None, id_2: Optional[str] = None, meeting_id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, meeting_organizer: Optional[TeamsIdentitySet] = None, transcript_content_url: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None)
Definition: TranscriptWebhookResponseSchema
Attributes
class-attribute
instance-attribute
OData identifier
class-attribute
instance-attribute
Online meeting identifier (empty for ad-hoc call transcripts)
class-attribute
instance-attribute
Call identifier (set for ad-hoc call transcripts)
class-attribute
instance-attribute
content_correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'contentCorrelationId'})
Content correlation identifier
class-attribute
instance-attribute
transcript_content_url: Optional[str] = field(default=None, metadata={'wire_name': 'transcriptContentUrl'})
URL to download the transcript content
class-attribute
instance-attribute
When the transcript was created (UTC)
dataclass
RecordingWebhookResponseSchema(id: Optional[str] = None, id_2: Optional[str] = None, meeting_id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, meeting_organizer: Optional[TeamsIdentitySet] = None, recording_content_url: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None)
Definition: RecordingWebhookResponseSchema
Attributes
class-attribute
instance-attribute
OData identifier
class-attribute
instance-attribute
Online meeting identifier (empty for ad-hoc call recordings)
class-attribute
instance-attribute
Call identifier (set for ad-hoc call recordings)
class-attribute
instance-attribute
content_correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'contentCorrelationId'})
Content correlation identifier
class-attribute
instance-attribute
recording_content_url: Optional[str] = field(default=None, metadata={'wire_name': 'recordingContentUrl'})
URL to download the recording content
class-attribute
instance-attribute
When the recording was created (UTC)
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
AssociatedTeamInfo(id: Optional[str] = None, display_name: Optional[str] = None, tenant_id: Optional[str] = None)
Definition: AssociatedTeamInfo
Attributes
class-attribute
instance-attribute
The name of the team
dataclass
ChannelWithOwnerTeamId(id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, email: Optional[str] = None, tenant_id: Optional[str] = None, web_url: Optional[str] = None, files_folder_web_url: Optional[str] = None, created_date_time: Optional[str] = None, membership_type: Optional[str] = None, owner_team_id: Optional[str] = None)
Definition: ChannelWithOwnerTeamId
Attributes
class-attribute
instance-attribute
The name of the channel
class-attribute
instance-attribute
The description of the channel, optional
class-attribute
instance-attribute
The email address for sending messages to the channel
class-attribute
instance-attribute
The ID of the Microsoft Entra tenant.
class-attribute
instance-attribute
A hyperlink for the channel in Microsoft Teams
class-attribute
instance-attribute
files_folder_web_url: Optional[str] = field(default=None, metadata={'wire_name': 'filesFolderWebUrl'})
The SharePoint folder URL of the channel
class-attribute
instance-attribute
Timestamp at which the channel was created. Read only
class-attribute
instance-attribute
The channel membership type
dataclass
dataclass
dataclass
TimeOffRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, time_off_reason_id: Optional[str] = None)
Definition: TimeOffRequestResponse
Attributes
class-attribute
instance-attribute
The unique ID of the TimeOff request.
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
The person the request is assigned to: 'manager' or 'recipient'
class-attribute
instance-attribute
'approved', 'pending' or 'declined'
class-attribute
instance-attribute
Time when the request was sent
class-attribute
instance-attribute
The message from the request sender
class-attribute
instance-attribute
The ID of the user that sent the request
class-attribute
instance-attribute
manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})
Time when the manager responded
class-attribute
instance-attribute
manager_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionMessage'})
The message from the manager
class-attribute
instance-attribute
The ID of the manager that responded
class-attribute
instance-attribute
Start of time requested off
class-attribute
instance-attribute
End of time requested off
dataclass
OfferShiftRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, sender_shift_id: Optional[str] = None, recipient_action_date_time: Optional[str] = None, recipient_action_message: Optional[str] = None, recipient_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None)
Definition: OfferShiftRequestResponse
Attributes
class-attribute
instance-attribute
The unique ID of the Offer Shift request.
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
The person the request is assigned to: 'manager' or 'recipient'
class-attribute
instance-attribute
'approved', 'pending' or 'declined'
class-attribute
instance-attribute
Time when the request was sent
class-attribute
instance-attribute
The message from the request sender
class-attribute
instance-attribute
The ID of the user that sent the request
class-attribute
instance-attribute
The ID of the shift from the sender
class-attribute
instance-attribute
recipient_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionDateTime'})
Time when the recipient responded
class-attribute
instance-attribute
recipient_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionMessage'})
The message from the recipient
class-attribute
instance-attribute
The ID of the recipient of the request
class-attribute
instance-attribute
manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})
Time when the manager responded
dataclass
SwapShiftsChangeRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, sender_shift_id: Optional[str] = None, recipient_action_date_time: Optional[str] = None, recipient_action_message: Optional[str] = None, recipient_user_id: Optional[str] = None, recipient_shift_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None)
Definition: SwapShiftsChangeRequestResponse
Attributes
class-attribute
instance-attribute
The unique ID of the Swap Shift request.
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
The person the request is assigned to: 'manager' or 'recipient'
class-attribute
instance-attribute
'approved', 'pending' or 'declined'
class-attribute
instance-attribute
Time when the request was sent
class-attribute
instance-attribute
The message from the request sender
class-attribute
instance-attribute
The ID of the user that sent the request
class-attribute
instance-attribute
The ID of the shift from the sender
class-attribute
instance-attribute
recipient_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionDateTime'})
Time when the recipient responded
class-attribute
instance-attribute
recipient_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionMessage'})
The message from the recipient
class-attribute
instance-attribute
The ID of the recipient of the request
class-attribute
instance-attribute
The ID of the shift from the recipient
class-attribute
instance-attribute
manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})
Time when the manager responded
dataclass
OpenShiftChangeRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None, open_shift_id: Optional[str] = None)
Definition: OpenShiftChangeRequestResponse
Attributes
class-attribute
instance-attribute
The unique ID of the Open Shift Change request.
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
The person the request is assigned to: 'manager' or 'recipient'
class-attribute
instance-attribute
'approved', 'pending' or 'declined'
class-attribute
instance-attribute
Time when the request was sent
class-attribute
instance-attribute
The message from the request sender
class-attribute
instance-attribute
The ID of the user that sent the request
class-attribute
instance-attribute
manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})
Time when the manager responded
class-attribute
instance-attribute
manager_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionMessage'})
The message from the manager
class-attribute
instance-attribute
The ID of the manager that responded
dataclass
dataclass
OpenShiftResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, scheduling_group_id: Optional[str] = None, last_modified_by: Optional[LastModifiedBy] = None, shared_open_shift: Optional[SharedOpenShift] = None, draft_open_shift: Optional[DraftOpenShift] = None)
Definition: OpenShiftResponse
Attributes
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
dataclass
SharedOpenShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, open_slot_count: Optional[int] = None, activities: Optional[Activities] = None)
Definition: SharedOpenShift
Attributes
class-attribute
instance-attribute
Display Name
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
dataclass
DraftOpenShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, open_slot_count: Optional[int] = None, activities: Optional[Activities] = None)
Definition: DraftOpenShift
Attributes
class-attribute
instance-attribute
Display Name
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
dataclass
ShiftResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, user_id: Optional[str] = None, scheduling_group_id: Optional[str] = None, last_modified_by: Optional[LastModifiedBy] = None, shared_shift: Optional[SharedShift] = None, draft_shift: Optional[DraftShift] = None)
Definition: ShiftResponse
Attributes
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
Assigned To User ID
dataclass
SharedShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, activities: Optional[Activities] = None)
Definition: SharedShift
Attributes
class-attribute
instance-attribute
Display Name
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
dataclass
DraftShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, activities: Optional[Activities] = None)
Definition: DraftShift
Attributes
class-attribute
instance-attribute
Display Name
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
dataclass
ScheduleResponse(id: Optional[str] = None, time_zone: Optional[str] = None, provision_status: Optional[str] = None, provision_status_code: Optional[str] = None)
Definition: ScheduleResponse
Attributes
class-attribute
instance-attribute
The Time Zone of the schedule.
class-attribute
instance-attribute
The Provision Status of the schedule.
dataclass
Definition: PostMessageToSelfRequest
dataclass
SchedulingGroupResponse(id: Optional[str] = None, display_name: Optional[str] = None, is_active: Optional[bool] = None, user_ids: Optional[List[str]] = None)
Definition: SchedulingGroupResponse
Attributes
class-attribute
instance-attribute
The unique ID of the scheduling group.
class-attribute
instance-attribute
The display name for the scheduling group.
class-attribute
instance-attribute
Indicates whether the scheduling group can be used when creating new entities or updating existing ones.
dataclass
BotMentionRequest(bot_id: Optional[str] = None, app_id: Optional[str] = None, name: Optional[str] = None)
Definition: BotMentionRequest
Attributes
class-attribute
instance-attribute
The bot's unique identifier (GUID)
class-attribute
instance-attribute
The bot's app identifier (GUID)
dataclass
dataclass
dataclass
NewMeeting(subject: Optional[str] = None, body: Optional[Dict[str, Any]] = None, time_zone: Optional[str] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, location: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, recurrence: Optional[Dict[str, Any]] = None, is_all_day: Optional[bool] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None, is_online_meeting: Optional[bool] = None, online_meeting_provider: Optional[str] = None)
Definition: NewMeeting
Attributes
class-attribute
instance-attribute
The text of the event's subject line
class-attribute
instance-attribute
The body of the message associated with the event
class-attribute
instance-attribute
Time zone of the event
class-attribute
instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'requiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'optionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
The location of the event
class-attribute
instance-attribute
The importance of the event: low, normal or high
class-attribute
instance-attribute
The recurrence pattern for the meeting
class-attribute
instance-attribute
Set to true if the event lasts all day
class-attribute
instance-attribute
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})
The number of minutes before the event start time that the reminder alert occurs
class-attribute
instance-attribute
Set to true if an alert is set to remind the user of the event
class-attribute
instance-attribute
Status to show during the event
class-attribute
instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})
Set to true if the sender would like a response when the event is accepted
class-attribute
instance-attribute
Set to true, if the meeting should have an online meeting provider
dataclass
LastModifiedBy(application: Optional[str] = None, device: Optional[str] = None, conversation: Optional[str] = None, user: Optional[Dict[str, Any]] = None)
Definition: LastModifiedBy
Attributes
dataclass
MemberSettings(allow_create_update_channels: Optional[bool] = None, allow_delete_channels: Optional[bool] = None, allow_add_remove_apps: Optional[bool] = None, allow_create_update_remove_tabs: Optional[bool] = None, allow_create_update_remove_connectors: Optional[bool] = None)
Definition: MemberSettings
Attributes
class-attribute
instance-attribute
allow_create_update_channels: Optional[bool] = field(default=None, metadata={'wire_name': 'allowCreateUpdateChannels'})
If set to true, members can add and update channels
class-attribute
instance-attribute
allow_delete_channels: Optional[bool] = field(default=None, metadata={'wire_name': 'allowDeleteChannels'})
If set to true, members can delete channels
class-attribute
instance-attribute
allow_add_remove_apps: Optional[bool] = field(default=None, metadata={'wire_name': 'allowAddRemoveApps'})
If set to true, members can add and remove apps
dataclass
GuestSettings(allow_create_update_channels: Optional[bool] = None, allow_delete_channels: Optional[bool] = None)
dataclass
MessagingSettings(allow_user_edit_messages: Optional[bool] = None, allow_user_delete_messages: Optional[bool] = None, allow_owner_delete_messages: Optional[bool] = None, allow_team_mentions: Optional[bool] = None, allow_channel_mentions: Optional[bool] = None)
Definition: MessagingSettings
Attributes
class-attribute
instance-attribute
allow_user_edit_messages: Optional[bool] = field(default=None, metadata={'wire_name': 'allowUserEditMessages'})
If set to true, users can edit their messages
class-attribute
instance-attribute
allow_user_delete_messages: Optional[bool] = field(default=None, metadata={'wire_name': 'allowUserDeleteMessages'})
If set to true, users can delete their messages
class-attribute
instance-attribute
allow_owner_delete_messages: Optional[bool] = field(default=None, metadata={'wire_name': 'allowOwnerDeleteMessages'})
If set to true, owners can delete any message
dataclass
FunSettings(allow_giphy: Optional[bool] = None, giphy_content_rating: Optional[str] = None, allow_stickers_and_memes: Optional[bool] = None, allow_custom_memes: Optional[bool] = None)
Definition: FunSettings
Attributes
class-attribute
instance-attribute
If set to true, enables Giphy use
class-attribute
instance-attribute
giphy_content_rating: Optional[str] = field(default=None, metadata={'wire_name': 'giphyContentRating'})
Giphy content rating. Possible values are: moderate, strict
dataclass
Definition: DiscoverySettings
Attributes
dataclass
SelectedMessageTriggerMetadata(teams_flow_run_context: Optional[ObjectEntity] = None, card_outputs: Optional[ObjectEntity] = None)
Definition: SelectedMessageTriggerMetadata
dataclass
ComposeMessageTriggerMetadata(teams_flow_run_context: Optional[ObjectEntity] = None, card_outputs: Optional[ObjectEntity] = None)
Definition: ComposeMessageTriggerMetadata
dataclass
CardResponseTriggerMetadata(teams_flow_run_context: Optional[ObjectEntity] = None, card_outputs: Optional[ObjectEntity] = None)
Definition: CardResponseTriggerMetadata
dataclass
dataclass
Definition: SectionItemConflictError
dataclass
dataclass
dataclass
dataclass
SingleTagTriggerRequest(notification_url: Optional[str] = None, group_id: Optional[str] = None, tag_id: Optional[str] = None)
Definition: SingleTagTriggerRequest
Attributes
class-attribute
instance-attribute
Webhook callback URL
class-attribute
instance-attribute
The team that owns the tag to monitor
dataclass
SingleTagMemberTriggerRequest(notification_url: Optional[str] = None, group_id: Optional[str] = None, tag_id: Optional[str] = None)
Definition: SingleTagMemberTriggerRequest
Attributes
class-attribute
instance-attribute
Webhook callback URL
class-attribute
instance-attribute
The team that owns the tag whose membership to monitor
dataclass
TagWebhookResponseSchema(change_type: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None, tag_id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, member_count: Optional[int] = None, tag_type: Optional[str] = None, event_id: Optional[str] = None)
Definition: TagWebhookResponseSchema
Attributes
class-attribute
instance-attribute
The tag lifecycle change: 'created', 'updated', or 'deleted'.
class-attribute
instance-attribute
The team (group) ID that owns the tag.
class-attribute
instance-attribute
The tag ID.
class-attribute
instance-attribute
Display name of the tag.
class-attribute
instance-attribute
Description of the tag.
class-attribute
instance-attribute
Number of members in the tag.
class-attribute
instance-attribute
Tag type.
dataclass
TagMemberWebhookResponseSchema(change_type: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None, tag_id: Optional[str] = None, tenant_id: Optional[str] = None, user_id: Optional[str] = None, event_id: Optional[str] = None)
Definition: TagMemberWebhookResponseSchema
Attributes
class-attribute
instance-attribute
The membership change: 'created' (member added) or 'deleted' (member removed).
class-attribute
instance-attribute
The team (group) ID that owns the tag.
class-attribute
instance-attribute
The tag ID whose membership changed.
class-attribute
instance-attribute
Tenant ID of the tag member.
class-attribute
instance-attribute
User ID of the tag member.
TeamsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)
Bases: ConnectorClientBase
Typed client for teams connector.
Initialize a TeamsClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
token_provider
|
Optional[TokenProvider]
|
Optional token provider. Defaults to ManagedIdentityTokenProvider. |
None
|
options
|
Optional[ConnectorClientOptions]
|
Optional connector client options. |
None
|
Methods:
async
Create a Teams meeting
Create a meeting with a link at the bottom of the invite to join the meeting online on Microsoft Teams.
async
List joined teams
Lists all the teams in Microsoft Teams that you are a member of
async
List associated teams
Lists all the teams you are a direct member of, or are a member of a shared channel that is hosted inside the team.
async
get_channels_for_group_async(group_id: str, filter: Optional[str] = None, orderby: Optional[str] = None) -> dict[str, Any] | None
List channels
Lists all the channels for a specific team
async
Create a channel
Create a new channel within a specified team
async
Get details for a specific channel in a team
Get the channel details
async
update_channel_properties_async(input: UpdateChannelPropertiesInput, group_id: str, channel_id: str) -> None
Update channel
Updates the properties of a channel in a specific team. Only the properties you provide are changed; omitted properties are left unchanged. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel.
async
archive_channel_async(input: ArchiveChannelInput, group_id: str, channel_id: str) -> dict[str, Any] | None
Archive a channel
Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. Archiving is an asynchronous operation.
async
get_all_channels_for_team_async(group_id: str, filter: Optional[str] = None, orderby: Optional[str] = None) -> dict[str, Any] | None
List all channels
Lists all the channels for a specific team, including channels that are shared with the team
async
List chats
Lists recent chats you are a part of
async
post_feed_notification_async(input: DynamicPostFeedNotificationRequest, poster: str, notification_type: str) -> None
Post a feed notification
Posts a notification to a user's activity feed linking to a chat or team.
async
Get an @mention token for a team tag
Creates a token that can be inserted into a message or adaptive card sent as a user in a channel to @mention a team tag.
async
Get messages in a channel
Gets messages from a channel in a specific team. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel.
async
get_message_details_async(input: DynamicGetMessageDetailsSchema, message_id: str, thread_type: str) -> dict[str, Any] | None
Get message details
Gets the details of a message in a chat or a channel.
async
list_replies_to_message_async(group_id: str, channel_id: str, message_id: str, top: Optional[int] = None) -> dict[str, Any] | None
List replies of a channel message
List replies to a message in a channel in a specific team. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel.
async
list_members_async(input: DynamicListMembersSchema, thread_type: str, filter: Optional[str] = None) -> dict[str, Any] | None
List chat or channel members
List direct members of a group chat or a channel
async
subscribe_user_message_with_options_async(input: DynamicUserMessageWithOptionsSubscriptionRequest) -> None
Post a choice of options as the Flow bot to a user
Send a set of options to a Microsoft Teams user, that they must respond to before the flow will continue. This action will pause the flow until the user response to the options
async
Get a team
Gets the details for a team in Microsoft Teams.
async
Get an @mention token for a user
Creates a token that can be inserted into a message or adaptive card to @mention a user.
async
Create a chat
Creates a one on one or group chat
async
get_messages_from_chat_async(chat_id: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[str] = None) -> dict[str, Any] | None
Get messages in a chat
Retrieves messages from a one on one or group chat
async
Post a message to myself
Sends a message to the signed-in user's own Notes chat in Microsoft Teams.
async
Create a team
Creates a new team in Microsoft Teams
async
list_team_members_async(team_id: str, filter: Optional[str] = None, top: Optional[str] = None) -> dict[str, Any] | None
List team members
Lists the members of a team in Microsoft Teams
async
Add a member to a team
Adds a member to a team in Microsoft Teams
async
Remove a member from a team
Removes a member from a team in Microsoft Teams
async
Add a member to a channel
Adds a member to a channel in Microsoft Teams. The channel must be a private or shared channel.
async
Remove a direct member from a channel
Removes a direct member from a channel in Microsoft Teams. The channel must be a private or shared channel.
async
post_message_to_conversation_async(input: DynamicPostMessageRequest, poster: str, location: str) -> dict[str, Any] | None
Post message in a chat or channel
Posts a message to a chat or a channel
async
reply_with_message_to_conversation_async(input: DynamicReplyMessageRequest, poster: str, location: str) -> dict[str, Any] | None
Reply with a message in a channel
Replies with a message to a channel's message
async
post_card_to_conversation_async(input: DynamicPostCardRequest, poster: str, location: str) -> dict[str, Any] | None
Post card in a chat or channel
Posts a card to a chat or a channel
async
post_card_and_wait_for_response_async(input: PostCardAndWaitForResponseInput, poster: str, location: str) -> dict[str, Any] | None
Post adaptive card and wait for a response
Posts an adaptive card to a chat or a channel and waits for a response from any user. This will pause the flow until any user responds.
async
reply_with_card_to_conversation_async(input: DynamicReplyCardRequest, poster: str, location: str) -> dict[str, Any] | None
Reply with an adaptive card in a channel
Replies with an adaptive card to a channel's message
async
update_card_in_conversation_async(input: DynamicUpdateCardRequest, poster: str, location: str) -> dict[str, Any] | None
Update an adaptive card in a chat or channel
Updates an existing adaptive card
async
Send a Microsoft Graph HTTP request
Construct a Microsoft Graph REST API request to invoke against the Microsoft Teams endpoints. These segments are supported: 1st segment: /teams, /me, /users 2nd segment: channels, chats, installedApps, messages, pinnedMessages, onlineMeetings. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api
async
Add a user to a chat
Adds a user to a chat in Microsoft Teams.
async
Remove a member from a chat
Removes a member from a chat in Microsoft Teams. Only group chats support member removal.
async
Get an online meeting
Retrieves the properties and relationships of an online meeting. You can look up a meeting by meeting ID, join web URL, or join meeting ID.
async
List meeting transcripts
Lists all transcripts for an online meeting
async
Get meeting transcript
Gets a specific transcript for an online meeting
async
Get meeting transcript content
Gets the content of a meeting transcript
async
List meeting recordings
Lists all recordings for an online meeting
async
Get meeting recording
Gets a specific recording for an online meeting
async
Get meeting recording content
Gets the content stream of a meeting recording
async
List sections
Lists the current user's teamwork sections
async
Create a section
Creates a new teamwork section for the current user
async
Get a section
Gets a specific teamwork section by ID
async
Update a section
Updates a teamwork section for the current user
async
Delete a section
Deletes a teamwork section for the current user
async
List section items
Lists the items (chats, channels, meetings, communities) in a teamwork section. Each item belongs to exactly one section at a time.
async
Add an item to a section
Adds an item (chat, channel, meeting, or community) currently in a system-defined section to a user-defined teamwork section. Use Move Section Item to relocate items already in another user-defined section.
async
Remove an item from a section
Removes an item from a user-defined teamwork section. The underlying chat, channel, meeting, or community is not deleted; the item returns to its default system-defined section.
async
move_section_item_async(input: MoveSectionItemInput, section_id: str, section_item_id: str) -> dict[str, Any] | None
Move a section item
Atomically moves an item from one user-defined teamwork section to another user-defined section. Each item can belong to only one section at a time. This action removes the item from its current section and adds it to the target section.
async
List all tags for a team
Lists the team's tags
async
Create a tag for a team
Creates a tag in a team
async
Get a team tag
Gets a specific tag by ID from a team
async
Update a team tag
Updates the display name of a tag in a team
async
Delete a team tag
Deletes a tag from a team
async
add_member_to_tag_async(input: AddMemberToTagInput, group_id: str, tag_id: str) -> dict[str, Any] | None
Add a member to a team tag
Adds a user to a team tag
async
List the members of a team tag
Lists the members of a team tag
async
Delete a member from a team tag
Deletes a member from a team tag
async
List call recordings
Lists all recordings for an ad-hoc call
async
Get call recording
Gets a specific recording for an ad-hoc call
async
Get call recording content
Gets the content of a call recording
async
List call transcripts
Lists all transcripts for an ad-hoc call
async
Get call transcript
Gets a specific transcript for an ad-hoc call
async
Get call transcript content
Gets the content of a call transcript
async
get_all_adhoc_call_recordings_async(start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, deltatoken: Optional[str] = None) -> dict[str, Any] | None
Get all ad-hoc call recordings
Gets all recordings from ad-hoc calls for the signed-in user
async
get_all_adhoc_call_transcripts_async(start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, deltatoken: Optional[str] = None) -> dict[str, Any] | None
Get all ad-hoc call transcripts
Gets all transcripts from ad-hoc calls for the signed-in user
async
List AI insights
Lists AI-generated insights for an online meeting. Requires Microsoft 365 Copilot license.
async
Get AI insight
Gets a specific AI-generated insight for an online meeting. Requires Microsoft 365 Copilot license.
async
Conversation location for where to post
Returns a list of locations to post a message or reply based on who the user is posting as
async
Get message details response schema
Get the schema information for get message details response
async
Get message details input metadata
Get the schema information for message inputs
async
List members input schema
Get the schema information for list members input based on thread type
async
get_feed_notification_input_schema_async(poster: str, notification_type: str) -> dict[str, Any] | None
Get feed notification input metadata
Get the schema information for feed notification
async
get_unified_action_schema_async(action_type: str, poster: str, recipient_type: str) -> dict[str, Any] | None
Get unified action input metadata
Get the schema information for unified actions
async
get_message_with_options_subscription_input_metadata_async(recipient_type: str) -> dict[str, Any] | None
Get message with options subscription input metadata
Get the schema information for the message with options subscription inputs
async
get_message_with_options_subscription_output_metadata_async(recipient_type: str) -> dict[str, Any] | None
Get message with options subscription output metadata
Get the schema information for the message with options subscription outputs
async
Input schema for webhook trigger
Gets the input schema for webhook trigger
async
get_webhook_trigger_response_schema_async(trigger_type: str, thread_type: str) -> dict[str, Any] | None
Response schema for webhook trigger
Gets the response schema for webhook trigger
async
get_post_to_conversation_response_schema_async(action_type: str, poster: str, recipient_type: str) -> dict[str, Any] | None
Get response schema
Get the schema information for unified action responses
async
get_flow_continuation_subscription_with_poster_output_metadata_async(input: GetFlowContinuationSubscriptionWithPosterOutputMetadataInput, poster: str, recipient_type: str) -> dict[str, Any] | None
Get flow continuation subscription output metadata
Get the schema information for the flow continuation subscription outputs