In this article
You can use this Snap to send/reply to a message in the specified channel.
Teams - Send Channel Message Snap is a Write-type Snap that sends a text message to a channel.
None.
Works in Ultra Pipelines.
Does not work with application-based accounts.
You can send up to a maximum of 3000 messages per app per day, to a given channel.
None.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| A document containing the body of the message, team ID, or channel ID. |
Output | Document |
|
| A document containing details of the message such as the message ID. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. | |||
|
Field Name | Field Type | Description | |
|---|---|---|---|
Label*
Default Value: Send Channel Message | String | Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |
Message* Default Value: N/A | String/Expression | Specify the message to send to the specified channel. You can either use plain text or rich text using the markdown supported by Microsoft Teams. See the input for the Message field of Send Channel Message Snap in the Example Pipeline below, for more details. | |
Team ID* Default Value: N/A | String/Expression/Suggestion | Specify the ID of the team. Alternatively, click the | |
Channel ID* Default Value: N/A | String/Expression/Suggestion | Specify the ID of the target channel. Alternatively, click the | |
Existing Message ID (if reply) Default Value: N/A | String/Expression | Specify the ID of the message for which to post a reply. | |
Number of Retries Default Value: 0 | String/Expression | Specify the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts.
| |
Retry Interval (seconds) Default Value: 1 | String/Expression | Specify the time interval in seconds between retry attempts.
| |
Snap Execution Default Value: Execute only | Dropdown list | Select one of the three following modes in which the Snap executes:
|
Error | Reason | Resolution |
|---|---|---|
InvalidChannelIdError | This error occurs when the specified channel ID provided in the Snap is invalid or does not exist. | Ensure that the channel ID you provided in the Snap is correct and corresponds to an existing channel in your Microsoft Teams workspace. |
Channel does not exist or archived | This error occurs when attempting to send a message to an archived channel, which is read-only and does not allow new messages. | Choose an active, non-archived channel as the recipient for the message or consider unarchiving the channel if necessary. |
The following example Pipeline demonstrates how you can use the Send Channel Message Snap and some other Snaps in the Teams Snap Pack to begin team's activity within your Microsoft Teams instance. This example assumes that you have:
Set up your application in Azure Portal with necessary permissions.
Configured the required Snap account with necessary scopes.
Created a public or private channel using the Create Channel Snap.
This Pipeline uses the OAuth2 user account (authorization code grant type) to create a team on behalf of a signed-in user and to allow begin their collaboration efforts. It demonstrates the following activities:
Creating a team
Adding members to the new team
Creating a public channel within the team
Collaboration through the channel
Use the Create Team Snap from the Teams Snap Pack to create the new team, as needed. For this Pipeline demonstration, the inputs for creating a team are passed using a Mapper Snap.
Mapper Snap | Output |
|---|---|
 |  |
The values for Team and Team_Desc are passed to the Create Team Snap. The Snap creates a new team in your Teams instance and returns the team's id and a confirmation message about the operation.
Create Team Snap | Output |
|---|---|
 |  |
To add members to the team, connect a Team Operations Snap. Select Add Members as the Operation and provide the user IDs of the members and owners for the team, as needed.
Team Operations Snap to add members to a team | Output |
|---|---|
 |  |
Now, let us create a channel within this new team (using Create Channel Snap) and add members to this channel, as necessary.
Create Channel Snap | Output |
|---|---|
 |  |
This Snap creates a new channel under the team and returns the channel details in its output.
Let us use these details to send our first message in the channel. To do so, we must connect a Send Channel Message Snap and pass the Team ID and Channel ID from the above output as inputs. The Send Channel Message Snap allows you to draft messages to the channel members using HTML markup. See the input for the Message field in the Snap.
Send Channel Message Snap | Output |
|---|---|
 |  |
Similarly, you can use the Send Channel Message Snap to reply to a specific message in the channel (conversation) using its message ID. For demo purposes, we are using the id of the message sent above to reply to it.
Send Channel Message as a reply | Output |
|---|---|
 |  |
Important steps to successfully reuse Pipelines
|
): Indicates a list that is dynamically populated based on the configuration.