ByteChef LogoByteChef
Components

Microsoft Teams

Microsoft Teams is a collaboration platform that combines workplace chat, video meetings, file storage, and application integration.

Categories: Communication

Type: microsoftTeams/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue
tenantIdTenant IdSTRINGtrue

Actions

Create Channel

Name: createChannel

Creates a new channel within a team.

Properties

NameLabelTypeDescriptionRequired
teamIdTeam IDSTRINGID of the team where the channel will be created.true
displayNameChannel NameSTRINGtrue
descriptionDescriptionSTRINGDescription for the channel.false

Example JSON Structure

{
  "label" : "Create Channel",
  "name" : "createChannel",
  "parameters" : {
    "teamId" : "",
    "displayName" : "",
    "description" : ""
  },
  "type" : "microsoftTeams/v1/createChannel"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the channel.
createdDateTimeDATE_TIMEThe date and time when the channel was created.
displayNameSTRINGName of the channel that will appear to the user in Microsoft Teams.
descriptionSTRINGDescription of the channel.
isFavoriteByDefaultBOOLEAN
Options true, false
Indicates whether the channel is marked as favorite by default.
webUrlSTRINGURL to access the channel in a web browser.
isArchivedBOOLEAN
Options true, false
Indicates whether the channel is archived.

Output Example

{
  "id" : "",
  "createdDateTime" : "2021-01-01T00:00:00",
  "displayName" : "",
  "description" : "",
  "isFavoriteByDefault" : false,
  "webUrl" : "",
  "isArchived" : false
}

Send Channel Message

Name: sendChannelMessage

Sends a message to a channel.

Properties

NameLabelTypeDescriptionRequired
teamIdTeam IDSTRINGID of the team where the channel is located.true
channelIdChannel IDSTRING
Depends On teamId
Channel to send message to.true
contentTypeMessage Text FormatSTRING
Options text, html
true
contentMessage TextSTRINGtrue

Example JSON Structure

{
  "label" : "Send Channel Message",
  "name" : "sendChannelMessage",
  "parameters" : {
    "teamId" : "",
    "channelId" : "",
    "contentType" : "",
    "content" : ""
  },
  "type" : "microsoftTeams/v1/sendChannelMessage"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the message.
bodyOBJECT
Properties {STRING(contentType), STRING(content)}
Plaintext/HTML representation of the content of the chat message.
channelIdentityOBJECT
Properties {STRING(teamId), STRING(channelId)}
Represents identity of the channel.

Output Example

{
  "id" : "",
  "body" : {
    "contentType" : "",
    "content" : ""
  },
  "channelIdentity" : {
    "teamId" : "",
    "channelId" : ""
  }
}

Send Chat Message

Name: sendChatMessage

Sends a message in an existing chat.

Properties

NameLabelTypeDescriptionRequired
chatIdChat IDSTRINGtrue
contentTypeMessage Text FormatSTRING
Options text, html
true
contentMessage TextSTRINGtrue

Example JSON Structure

{
  "label" : "Send Chat Message",
  "name" : "sendChatMessage",
  "parameters" : {
    "chatId" : "",
    "contentType" : "",
    "content" : ""
  },
  "type" : "microsoftTeams/v1/sendChatMessage"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the message.
chatIdSTRINGID of the chat.
bodyOBJECT
Properties {STRING(contentType), STRING(content)}
Plaintext/HTML representation of the content of the chat message.

Output Example

{
  "id" : "",
  "chatId" : "",
  "body" : {
    "contentType" : "",
    "content" : ""
  }
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.