Microsoft Teams
API actions for the Microsoft Teams integration.
Microsoft Teams
Engage with Microsoft Teams chats, channels, and meetings via Microsoft Graph.
Add member to team
Add a member to a Teams team.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ms_team_id | string | Yes | The team ID. Obtainable from list_joined_teams (teams[].id) or resolve_teams_link (ms_team_id). |
ms_user_id | string | Yes | The user ID or email address of the user to add. Obtainable from search_team_members (members[].id) or as an email address directly. |
role | string | No | Optional role for the member (e.g., owner). |
Response
{
"ms_team_id": "team123",
"ms_user_id": "user123",
"result": {},
"status": "success"
}Create channel
Create a new channel in a Teams team.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ms_team_id | string | Yes | The team ID. Obtainable from list_joined_teams (teams[].id) or resolve_teams_link (ms_team_id). |
display_name | string | Yes | The display name for the channel. |
description | string | No | Optional description for the channel. |
Response
{
"channel_id": "channel123",
"ms_team_id": "team123",
"result": {},
"status": "success"
}List joined teams
List all Teams the current user has joined.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
top | number | No | Optional maximum number of teams to return. |
Response
{
"status": "success",
"team_count": 1,
"teams": [
{
"description": "Engineering team",
"displayName": "Engineering",
"id": "72602e12-78ac-474c-99d6-f619710353a9"
}
]
}List team channels
List channels in a Teams team.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ms_team_id | string | Yes | The team ID. Obtainable from list_joined_teams (teams[].id) or resolve_teams_link (ms_team_id). |
top | number | No | Optional maximum number of channels to return. |
Response
{
"channel_count": 1,
"channels": [
{
"description": "General discussion",
"displayName": "General",
"id": "19:general@thread.tacv2"
}
],
"ms_team_id": "team123",
"status": "success"
}List user chats
List chats for a user.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ms_user_id | string | No | The user ID. Defaults to 'me' (the authenticated user). |
Response
{
"chat_count": 1,
"chats": [
{
"chatType": "group",
"id": "19:abc123@thread.v2",
"topic": "Project Discussion"
}
],
"ms_user_id": "me",
"status": "success"
}Resolve Teams link
Extract team ID, channel ID, and tenant ID from a Microsoft Teams URL.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
link | string | Yes | A Microsoft Teams URL (team or channel link). |
Response
{
"channel_id": "19:abc123@thread.tacv2",
"ms_team_id": "72602e12-78ac-474c-99d6-f619710353a9",
"status": "success",
"tenant_id": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
}Schedule meeting
Schedule a Teams meeting.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organizer_id | string | No | The organizer user ID. Defaults to 'me' (the authenticated user). |
subject | string | Yes | The meeting subject. |
start_datetime | string | Yes | Start date and time (ISO 8601). |
end_datetime | string | Yes | End date and time (ISO 8601). |
timezone | string | Yes | Time zone for the meeting (e.g., 'America/New_York'). |
attendees | array | Yes | List of attendee email addresses. |
Response
{
"meeting_id": "event123",
"organizer_id": "me",
"result": {},
"status": "success"
}Search team members
Search for members of a Teams team by display name.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ms_team_id | string | Yes | The team ID. Obtainable from list_joined_teams (teams[].id) or resolve_teams_link (ms_team_id). |
query | string | Yes | Display name to search for (case-insensitive substring match). |
top | number | No | Optional maximum number of results to return. |
Response
{
"member_count": 1,
"members": [
{
"displayName": "John Doe",
"email": "john@contoso.com",
"id": "user123"
}
],
"ms_team_id": "team123",
"status": "success"
}Send channel message
Send a message to a Teams channel.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ms_team_id | string | Yes | The team ID. Obtainable from list_joined_teams (teams[].id) or resolve_teams_link (ms_team_id). |
channel_id | string | Yes | The channel ID. Obtainable from list_team_channels (channels[].id), resolve_teams_link (channel_id), or create_channel (channel_id). |
message | string | Yes | The message content. |
Response
{
"channel_id": "channel123",
"ms_team_id": "team123",
"result": {},
"status": "success"
}Send chat message
Send a message to a Teams chat.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
chat_id | string | Yes | The chat ID. Obtainable from list_user_chats (chats[].id). |
message | string | Yes | The message content. |
subject | string | No | Optional message subject. |
Response
{
"chat_id": "chat123",
"result": {},
"status": "success"
}