SAP Help Home SAP Intelligent RPA Help Portal SAP Intelligent RPA Community

Table of Contents

Authorization
Cloud Files Management (Microsoft OneDrive and SharePoint)
Excel Online
Outlook Online
Sharepoint List
Design Only
Teams
OneNote
Enumerations
Error

Module - Teams

Set of activities to be used to interact with MS Teams.

Activities

Send Chat Message

Send a message in a chat


Technical Name Type Minimal Agent Version
chat.sendChatMessage asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
chatId string mandatory ID of the chat to send the message to
messageToSend string mandatory Message to send in the chat
renderType irpa_365online.enums.teams.message.renderType optional renderAsText Render as HTML or render as plain text
importance irpa_365online.enums.teams.message.importance optional normal Message importance

Note:

To mention a user in a message use "<@user:email_adress_of_the_user>". And set renderType as renderAsHtml.

Errors:

Error Class Package Description
RequestError irpa_core Error during request.
NotFound irpa_core User was not found on this tenant.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.


Get Chat List

Get the list of available chats


Technical Name Type Minimal Agent Version
chat.getChatList asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
filter Array.<irpa_365online.chatListFilter> optional Elements used to filter
chatType irpa_365online.enums.teams.searchCriterion.chatType optional any Chat type used to filter
size number optional 5 Maximum number of results to be retrieved. Maximum accepted is 20

Output Parameters:

Name Type Description
chatList Array.<irpa_365online.chatListResult> List of chats for current user

Errors:

Error Class Package Description
RequestError irpa_core Error during request.
NotFound irpa_core User was not found on this tenant.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.


Get Message List

Get a list of messages from a chat (from newer to older)


Technical Name Type Minimal Agent Version
chat.getMessageList asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
chatId string mandatory ID of the chat from which you want to get messages
size number optional 20 Maximum number of results to be retrieved. Maximum accepted is 500

Output Parameters:

Name Type Description
messageList Array.<irpa_365online.chatMessageDetail> List of messages

Errors:

Error Class Package Description
RequestError irpa_core Error during request.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.
NotFound irpa_core User was not found on this tenant.


Create Chat

Create a chat with selected members


Technical Name Type Minimal Agent Version
chat.createChat asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
chatMembers Array.<irpa_365online.chatMember> mandatory List of Azure active directory members to add to the chat
title string optional Title of chat (this is ignored if there is only one member in the chat)

Output Parameters:

Name Type Description
createdChatDetails irpa_365online.chatDetails Details of the created chat

Note:

Members added are owner by default.

Errors:

Error Class Package Description
RequestError irpa_core Error during request.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.
NotFound irpa_core User was not found on this tenant.


Get User Availability

Get the availability of the current user in MS Teams


Technical Name Type Minimal Agent Version
user.getAvailability asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
userMail string optional Mail address of the user

Output Parameters:

Name Type Description
availability irpa_365online.enums.teams.user.availability Availbility of user

Errors:

Error Class Package Description
RequestError irpa_core Error during request.
NotFound irpa_core User was not found on this tenant.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.


Send Channel Message

Send a message to the channel of a team


Technical Name Type Minimal Agent Version
teams.sendChannelMessage asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
teamName string mandatory Name of the team containing the channel
channelName string mandatory Name of the channel to send the message to
messageToSend string mandatory Message to send to the channel
renderType irpa_365online.enums.teams.message.renderType optional renderAsText Render as HTML or render as plain text
importance irpa_365online.enums.teams.message.importance optional normal Message importance

Output Parameters:

Name Type Description
messageChannelId string ID of the channel message

Note:

To mention a user in a message use "<@user:email_adress_of_the_user>". And set renderType as renderAsHtml.

Errors:

Error Class Package Description
RequestError irpa_core Error during request.
NotFound irpa_core Channel or team not found.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.