- Release notes
- Overview
- Getting started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Publishing Guidelines for Process Mining app templates
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams scope
- Create team
- Create team from group
- Get team
- Get teams
- Channels
- Create channel
- Delete channel
- Get channel
- Get channels
- Update channel
- Chats
- Get chat
- Get chats
- Get chat members
- Messages
- Get message
- Get messages
- Get message replies
- Reply to message
- Send message
- Events
- Create event
- Delete event
- Get event
- Get events
- Users
- Get user presence
- How it works
- Technical references
- Get started
- About
- Setup
- Technical references
- Azure Form Recognizer scope
- Activities
- Analyze form
- Analyze form async
- Get analyze form result
- Analyze receipt
- Analyze receipt async
- Get analyze receipt result
- Analyze layout
- Analyze layout async
- Get analyze layout result
- Train model
- Get models
- Get model keys
- Get model info
- Delete model
- Connectors
- How to create activities
- Build Your Integration
Marketplace user guide
Send message
Overview
The Send Message activity calls the Microsoft Graph CreateChatMessage or CreateChatMessage - in a channel API to send a message (Body, BodyType, Importance, Subject) to a specified chat (ChatId) or channel (ChannelId) and team (TeamID).
After sending the message, the activity outputs the id of the sent message (MessageId) as a String that you can use as an input variable in subsequent activities (for example, Get Message Replies, Get Message, and so on).
How it works
The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
- Complete one of the following two options (A or B):
A. Add an activity or run an external process that outputs a Chat.Id value (for example, Get Chats).
B. Add an activity or run an external process that outputs a Team.Id value (for example, Get Teams) AND an activity or external process that outputs a Channel.Id value (for example, Get Channels).
- Add the Send Message activity inside the Microsoft Teams Scope activity.
- Enter values for the Channel and Message properties.
- Create and enter a
Stringvariable for your Output property. - Run the activity.
-
Your input property values are sent to the CreateChatMessage or CreateChatMessage - in a channel API.
-
The API returns the
Stringvalue to your output property variable.
-
Properties
The values for the following properties are specified when adding this activity to your project in UiPath Studio.
Common
DisplayName
The display name of the activity.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Send Message |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
Channel
TeamId
The Id of the Team object that contains the channel you want to send a message to.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (for example, Get Teams or external API call) |
ChannelId
The Id of the Channel object that you want to send a message to.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Channel.Id value, use an external process or activity that includes the Channel.Id value in its output (for example, Get Channels or external API call) |
Chat
ChatId
The Id of the Chat object that you want to send the message to.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes (if TeamId and ChannelId are empty) |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Chat.Id value, use an external process or activity that includes the Chat.Id value in its output (for example, Get Chats or external API call) Either (ChatId) or (TeamId and ChannelId) are required. |
Message
Body
The message content that you to send.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | Enter your value according to the BodyType value (BodyType.Text or BodyType.Html). |
BodyType
The type of content that you want to send in your Body.
| Attributes | Details |
|---|---|
| Type |
|
| Required | No |
| Default value | Empty |
| Allowed values | Enter a BodyType or BodyType variable |
| Notes | Enter one of the following two accepted values:
|
Importance
The importance of the reply message.
| Attributes | Details |
|---|---|
| Type |
|
| Required | No |
| Default value | Empty |
| Allowed values | Enter a ChatMessageImportance or ChatMessageImportance variable. |
| Notes | Enter one of the following three accepted values:
|
Subject
The subject of the reply message.
| Attributes | Details |
|---|---|
| Type | String |
| Required | No |
| Default value | Empty |
| Allowed values | Enter a String or String variable |
| Notes | N/A |
Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
| Attributes | Details |
|---|---|
| Type | Checkbox |
| Required | No |
| Default value | Not Selected |
| Allowed values | Selected or Not Selected |
| Notes | N/A |
Output
MessageId
The id of the sent message.
| Attributes | Details |
|---|---|
| Type | String |
| Required | No (required if you plan to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a String variable. |
| Notes | The variable you create for this property can be used as an input variable in subsequent activities (for example, Get Message Replies, Get Message, and so on). |
Example
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the guides.
