Adapter - Microsoft Teams Bot
This page describes version 2.0.6 of the adapter.
Overview
This adapter interacts with a conversational bot and allows you to send text messages and send, update, or delete adaptive cards to personal chats, channels, and group chats which have added the bot in Microsoft Teams. When users send messages to the bot or press submit action buttons on an adaptive card sent from UIP, the adapter triggers an event to be handled in a workflow.
License
The adapter requires a valid license (i.e. - MS Teams Bot Adapter) in UIP. Without a valid license, the adapter will fail when starting and the reason shown will indicate that a license is required.
Install the bot application manifest in your Microsoft Teams tenant
The bot manifest file can be downloaded from:
| Region | Manifest |
|---|---|
| US | Teams Bot Manifest |
Have your Teams administrator upload this bot manifest as a custom app for your tenant by using Teams administration or 'Submit to app catalog' from the Teams client's 'Apps' gallery and have your Teams administrator review and approve the app.
Configuration
A valid Teams Conversation Bot Connection URL and Teams Conversation Bot Authentication Token is required to use this adapter.
The authentication token is generated by installing the bot application manifest in your Microsoft Teams tenant and either clicking the "Manage" button on the welcome card sent from the bot or sending the "manage" keyword command in a personal chat with the bot. By registering your Microsoft Teams tenant with the bot and generating an authentication token, the adapter is able to connect to the connection URL where it can send and receive messages from the bot.
Registering the tenant requires a valid UIP license that contains the WFMSTBOT MS Teams Bot license feature. To register the bot:
- Click the "Manage" button and you will be prompted with a dialog containing two text fields.
- Copy the secret text from the first field and paste it in UIP's Administration > License page in the Get License Token section. Submitting will copy the license token into your clipboard.
- Paste the text into the second text field of the bot dialog and submit.
- Click Register to enable integration with the Teams UIP application. The settings displayed are used to configure your adapter to communicate with the bot.
- To setup the adapter use the Teams Conversation Bot Connection URL and Teams Conversation Bot Authentication Token provided. You can regenerate the token to invalidate any current connection. Manage is not available in conversations with multiple participants, like group or team chats.
Meeting Configuration
In order to use the meeting commands of this adapter, your Azure Active Directory Administrator must grant the bot permission to start meetings and create calendar events for your Teams tenant. After accepting the permissions, the commands for meetings may be used.
- Follow the first three steps above to access the management dialog.
- Click the Allow Meeting Permissions button. This will open a browser window so the application can request the permissions it needs to start meetings.
- Only an Azure Active Directory Admin account can grant access to the application.
Online meetings require the Teams Bot to create the meeting on behalf of a User. That user can be one or more users in your Azure Active Directory, or it can be a special "service" user you create for UIP to use for these meetings, with limited permissions. In order to create an on-demand online meeting, you additionally need to run the following PowerShell script and specify the User Principal Name (UPN) of the user who will be the organizer for meetings created from UIP:
| Region | PowerShell Script |
|---|---|
| US | Teams Bot Online Meetings |
Unregister the bot
- Follow the first three steps above to access the management dialog.
- Click the Unregister button. This will invalidate any current connection. The users won't be able to receive any messages. Unregistering is possible with an expired MS Teams license feature.
Interacting with the bot
Once registered, the bot can connect to users through individual chats, groups or teams.
To add the bot into a conversation go to the Apps tab and look for the bot inside the store. Click on the app card.
- To start a private conversation press Add.
- To add the bot into a group chat press Add to a chat from the dropdown menu.
- To add the bot into a team press Add to a team from the dropdown menu.
For groups and teams, the bot will create conversation references for all participants, and will be able send messages privately to those users as well.
Message Recipient Limitations
The adapter can easily respond to text messages and adaptive cards sent from private conversations, channels or group chats in Microsoft Teams by using the Conversation ID sent in the event as the Recipient when you respond.
When sending unsolicited messages from UIP, however, the Recipient identifier depends on where the message is being sent:
- Personal - the User Principal Name (UPN) of the user receiving the message should be specified (e.g. - user@company.com)
- Teams Channel - the Teams Channel ID can be found by using the Get link to channel menu option in your Microsoft Teams client (e.g. - https://teams.microsoft.com/l/channel/19%3a12abc34de5679f01ace234b567df890a%40thread.tacv2/Team?groupId=2d48f62c-ef33-474e-8e0c-47852ec7388b&tenantId=149596bc-23e2-435f-80fb-7a7bb2502893)
- Group Chat - the Recipient cannot be found in your Microsoft Teams client. If you need to send unsolicited messages to a group chat, send a message to the bot from the group chat and find the Conversation ID in the Workflow History of UIP.
Messages only send unsolicited messages to recipients where the bot is added in Microsoft Teams.
Message Size Limitation
Due to Microsoft Teams Bot Framework limitations, the text messages and cards commands have size limits. Simple text messages are limited to 28 KB and card messages have a 19 KB limit. This constrain also applies to update cards commands.
Provide Help For Teams Users
The "help" command is a keyword in the Teams Conversation Bot. The bot responds to users with a card that tells the user what commands are available, given their context (i.e. - personal chat, channel, or group).
The "help" keyword is also sent to UIP as a Text Message event so that you can provide additional guidance for commands handled in UIP workflows. Send a card or text message response documenting the capabilities provided in UIP.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| authToken | Teams Bot Authentication Token | True | The Authentication token shown when you Manage Tenant Credentials with the bot in Microsoft Teams. | string | 100 | ||||
| connectionURL | Teams Bot Connection URL | False | The Connection URL shown when you Manage Tenant Credentials with the bot in Microsoft Teams. | string | 100 | ||||
| connectionString1 | Teams Bot Connection String for Primary | False | Connection string for the primary Service Bus. This value can only be set by a engineer. | string | |||||
| connectionString2 | Teams Bot Connection String for Secondary | False | Connection string for the secondary Service Bus. This value can only be set by a engineer. | string |
Commands
Send Text (sendtextmessage)
Sends a text message to a user, group, or team. The message is limited to 28 KB.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Recipient | The ID of the message recipient; either a conversation ID for a team or group, or the UPN of a user. | True | string |
| message | Message | The message sent to a Microsoft Teams conversation. Some markdown formatting is available. | True | string |
| errorContext | Error Context Data | Context data returned to UIP when an error occurs. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
Send Card (sendcardmessage)
Sends a simple adaptive card to a user, group, or team. The message is limited to 19 KB.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Recipient | The ID of the message recipient; either a conversation ID for a team or group, or the UPN of a user. | True | string |
| title | Title | The title of the card, shown in at the top of the card in bold. | True | string |
| message | Message | The message content of the card. Some markdown formatting is available. | True | string |
| backgroundImageUrl | Background Image Url | The URL for a background image of the card. Ensure that the image doesn't obscure your card content. | False | string |
| messageIdentifier | Message ID | An ID for this message which will be returned along with the Card ID from Microsoft Teams in a Card ID Received event. You can store this Message ID along with details about this initial message so you can match the Card ID with it later and update or delete the card in Microsoft Teams. | False | string |
| actions | Buttons | The action buttons at the bottom of the card. The user can press these to respond to UIP. | False | array |
| actions[0].title | Title | The title text of the button. | True | string |
| actions[0].iconurl | Icon Url | The URL of an icon for the button. | False | string |
| actions[0].context | Context Data | Any context data sent back to UIP when the button is pressed. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
| errorContext | Error Context Data | Context data returned to UIP when an error occurs. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
Send Multiple Cards (sendmultiplecardmessage)
Send multiple simple adaptive cards to multiple users. This command is for developers who know the structure of JSON data.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| title | Title | The title of the card, shown in at the top of the card in bold. | True | string |
| message | Message | The message content of the card. Some markdown formatting is available. | True | string |
| backgroundImageUrl | Background Image Url | The URL for a background image of the card. Ensure that the image doesn't obscure your card content. | False | string |
| multipleDatas | Multiple Datas | Array data of Recipient, Message ID, Buttons, Error Context Data. Create this data in workflow. e.g. 'data[0].identifier=aaa, data[0].messageIdentifier=bbb, data[0].actions[0].title=ccc, data[0].actions[0].iconurl=ddd, data[0].actions[0].context=eee, data[0].actions[1].title=fff, data[0].actions[1].iconurl=ggg, data[0].actions[1].context=hhh' | True | string |
Send Custom Card (sendcustomcardmessage)
Sends a custom adaptive card message to a user, group, or team. Custom cards may be designed outside of the adapter (e.g. - https://adaptivecards.io/designer) and their template and data entered for this command. The message is limited to 19 KB.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Recipient | The ID of the message recipient; either a conversation ID for a team or group, or the UPN of a user. | True | string |
| templatejson | Card Template | The template layout of the adaptive card; pass this as a Workflow property to avoid JSON parsing issues. | True | string |
| datajson | Card Data | Any data substituted in the adaptive card; pass this as a Workflow property to avoid JSON parsing issues. | True | string |
| context | Context Data | Any context data sent back to UIP when an Action button in the template is pressed. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
| messageIdentifier | Message ID | An ID for this message which will be returned along with the Card ID from Microsoft Teams in a Card ID Received event. You can store this Message ID along with details about this initial message so you can match the Card ID with it later and update or delete the card in Microsoft Teams. | False | string |
| errorContext | Error Context Data | Context data returned to UIP when an error occurs. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
Update Card (updatecardmessage)
Updates an existing card with a simple adaptive card for a user, group, or team conversation. The message is limited to 19 KB.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Recipient | The ID of the message recipient; either a conversation ID for a team or group, or the UPN of a user. | True | string |
| title | Title | The title of the card, shown in at the top of the card in bold. | True | string |
| message | Message | The message content of the card. Some markdown formatting is available. | True | string |
| backgroundImageUrl | Background Image Url | The URL for a background image of the card. Ensure that the image doesn't obscure your card content. | False | string |
| cardIdentifier | Card ID | The Card ID of the existing card in Microsoft Teams to update. | True | string |
| actions | Buttons | The action buttons at the bottom of the card. The user can press these to respond to UIP. | False | array |
| actions[0].title | Title | The title text of the button. | True | string |
| actions[0].iconurl | Icon Url | The URL of an icon for the button. | False | string |
| actions[0].context | Context Data | Any context data sent back to UIP when the button is pressed. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
| errorContext | Error Context Data | Context data returned to UIP when an error occurs. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
Update Custom Card (updatecustomcardmessage)
Updates an existing card with a custom adaptive card for a user, group, or team conversation. Custom cards may be designed outside of the adapter (e.g. - https://adaptivecards.io/designer) and their template and data entered for this command. The message is limited to 19 KB.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Recipient | The ID of the message recipient; either a conversation ID for a team or group, or the UPN of a user. | True | string |
| templatejson | Card Template | The template layout of the adaptive card; pass this as a Workflow property to avoid JSON parsing issues. | True | string |
| datajson | Card Data | Any data substituted in the adaptive card; pass this as a Workflow property to avoid JSON parsing issues. | True | string |
| context | Context Data | Any context data sent back to UIP when an Action button in the template is pressed. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
| cardIdentifier | Card ID | The Card ID of the existing card in Microsoft Teams to update. | True | string |
| errorContext | Error Context Data | Context data returned to UIP when an error occurs. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
Delete Card (deletecard)
Deletes an existing card in a user, group, or team conversation.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Recipient | The ID of the message recipient; either a conversation ID for a team or group, or the UPN of a user. | True | string |
| cardIdentifier | Card ID | The Card ID of the existing card in Microsoft Teams to delete. | True | string |
| errorContext | Error Context Data | Context data returned to UIP when an error occurs. This can be a simple string or a JSON object (if JSON, pass as a Workflow property to avoid JSON parsing issues). | False | string |
Create Online Meeting (createonlinemeeting)
Create an online meeting call with invited participants.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| subject | Subject | The Subject of the online meeting. | True | string |
| customId | Custom ID | A Custom ID for the online meeting; if a meeting already exists with this Custom ID, it will be reused. | False | string |
| catalogAppId | Catalog Application ID | The App ID of the bot installed in your Microsoft Teams admin center (view the app details in https://admin.teams.microsoft.com). This is required to send meessages and cards to the meeting's chat. | False | string |
| organizer | Organizer | The UPN of the user organizing the meeting. The bot creates the meeting on behalf of this user, and the PowerShell script found in the adapter documentation is required to be run for this user. | True | string |
| participants | Participants | The meeting's participants. | False | array |
| participants[0].upn | User Principal Name | The participant user's UPN. | True | string |
Get Online Meeting (getonlinemeeting)
Get an online meeting by meeting ID and organizer
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| identifier | Meeting ID | Online meeting identifier | True | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | True | string |
Create Calendar Meeting (createcalendarmeeting)
Create a scheduled meeting and add it to the Outlook calendar.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| organizer | Organizer | The UPN of the user organizing the meeting. The bot creates the meeting on behalf of this user. | True | string |
| startDateTime | Start Date Time | When the meeting starts. This should be in ISO 8601 format without time zone (i.e. - {date}T{time}; for example, 2021-09-01T09:00:00). If 'Is All Day?' is true, the time needs to be set to midnight. | True | string |
| endDateTime | End Date Time | When the meeting ends. This should be in ISO 8601 format without time zone (i.e. - {date}T{time}; for example, 2021-09-01T10:00:00). If 'Is All Day?' is true, the time needs to be set to midnight, and the date must be later than the Start Date Time. | True | string |
| timeZone | Time Zone | Specify a time zone (e.g. - Pacific Standard Time). Only time zones specified in your Outlook configuration are valid. See Windows Default Time Zones or Additional Time Zones for possible values. | True | string |
| isAllDay | Is All Day? | Does the meeting last all day? If 'true', the 'Start Date Time' and 'End Date Time' properties for an all-day event need to be set to midnight and the meeting must be at least 24 hours long. | False | string |
| subject | Subject | Enter the subject of the meeting. | True | string |
| bodyContentType | Body Content Type | Specify whether the Body Content value is Html or Text | True | string |
| bodyContent | Body Content | The body of the message for the meeting in HTML or plain text format. | True | string |
| isOnlineMeeting | Is Online Meeting? | Should an online meeting be created? Set to 'true' if this meeting should be online, 'false' otherwise. | True | string |
| onlineMeetingProvider | Online Meeting Provider | Specify the online meeting service provider: 'teamsForBusiness', 'skypeForBusiness', or 'skypeForConsumer'. | False | string |
| importance | Importance | Set the importance of the meeting: 'low', 'normal', or 'high'. | False | string |
| isReminderOn | Is Reminder On? | Should participants be reminded of the meeting beforehand? | False | string |
| reminderMinutesBeforeStart | Remind Minutes Before | The number of minutes before the event start time that participants are sent a reminder. | False | string |
| allowNewTimeProposals | Allow New Time Proposals? | Set to 'true' to allow participants to propose a new time for the meeting when responding. | False | string |
| hideAttendees | Hide Attendees? | When set to 'true', participants only see themselves in the meeting request and attendee list. | False | string |
| transactionId | Transaction ID | A custom identifier for the meeting which can be reconciled with the event. | False | string |
| participants | Participants | The meeting's participants, up to a maximum of 500. | False | array |
| participants[0].identifier | Participant ID | The participant's UPN or email address. | True | string |
| participants[0].attendeetype | Participant Type | Specify whether the participant is 'Required' or 'Optional'. | True | string |
| locations | Locations | The location of the meeting. | False | array |
| locations[0].displayname | Location Display Name | The name associated with the location. | True | string |
| locations[0].email | Location Email Address | An email address associated with the location. If this is a room resource in your directory, this location will be added as a participant in this meeting. This meeting may be rejected if this resource is already busy at the time being scheduled. | False | string |
Update Calendar Meeting (updatecalendarmeeting)
Update a scheduled meeting in the Outlook calendar.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| eventId | Meeting ID | The Meeting ID of the scheduled event in the calendar. | True | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | True | string |
| startDateTime | Start Date Time | Update when the meeting starts; this must be set if the meeting end is being updated. This should be in ISO 8601 format without time zone (i.e. - {date}T{time}; for example, 2021-09-01T09:00:00). If 'Is All Day?' is true, the time needs to be set to midnight. If left blank, this will not be changed. | False | string |
| endDateTime | End Date Time | Update when the meeting ends; this must be set if the meeting start is being updated. This should be in ISO 8601 format without time zone (i.e. - {date}T{time}; for example, 2021-09-01T10:00:00). If 'Is All Day?' is true, the time needs to be set to midnight, and the date must be later than the Start Date Time. If left blank, this will not be changed. | False | string |
| timeZone | Time Zone | Update the time zone (e.g. - Pacific Standard Time); this must be set if the meeting start and end are also being updated. Only time zones specified in your Outlook configuration are valid. See Windows Default Time Zones or Additional Time Zones for possible values. If left blank, this will not be changed. | False | string |
| isAllDay | Is All Day? | Does the meeting last all day? If 'true', the 'Start Date Time' and 'End Date Time' properties for an all-day event need to be set to midnight and the meeting must be at least 24 hours long. If left blank, this will not be changed. | False | string |
| subject | Subject | Update the subject for the meeting. If left blank, this will not be changed. | False | string |
| importance | Importance | Update the importance of the meeting: 'low', 'normal', or 'high'. If left blank, this will not be changed. | False | string |
| isReminderOn | Is Reminder On? | Update whether participants should be reminded of the meeting beforehand? If left blank, this will not be changed. | False | string |
| reminderMinutesBeforeStart | Remind Minutes Before | Update the number of minutes before the event start time that participants are sent a reminder. If left blank, this will not be changed. | False | string |
| hideAttendees | Hide Attendees? | When set to 'true', participants only see themselves in the meeting request and attendee list. If left blank, this will not be changed. | False | string |
Get Calendar Meeting (getcalendarmeeting)
Get a scheduled meeting from the Outlook calendar.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| eventId | Meeting ID | The Meeting ID of the scheduled event in the calendar. | True | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | True | string |
Delete Calendar Meeting (deletecalendarmeeting)
Delete a scheduled meeting from the Outlook calendar.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| eventId | Meeting ID | The Meeting ID of the scheduled event in the calendar. | True | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | True | string |
Update Calendar Meeting Participants (updatecalendarmeetingparticipants)
Update the participants of a scheduled meeting in the Outlook calendar.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| eventId | Meeting ID | The Meeting ID of the scheduled event in the calendar. | True | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | True | string |
| addParticipants | Added Participants | A JSON array of new participants to add to the meeting. The JSON string format is [{{"Identifier":" |
False | string |
| deleteParticipants | Deleted Participants | A comma-delimited list of participants to delete from the meeting. Participants are matched based on the UPN or email address used when they were added, and those not found are ignored. | False | string |
Events
Text Message Received (textMessageReceived)
A text message was received from a personal, group, or team chat.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| identifier | Conversation ID | The ID of the conversation where the message originated; this can be used as the Recipient when responding. | string |
| type | Conversation Type | The type of conversation where the message was sent: Personal, Channel or GroupChat. | string |
| message | Message | The text message content. | string |
| fromidentifier | From | The UPN of the Teams user who sent the message. | string |
Card Action Received (cardActionMessageReceived)
A submit button was pressed on a card in a personal, group, or team chat.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| identifier | Conversation ID | The ID of the conversation where the message originated; this can be used as the Recipient when responding. | string |
| type | Conversation Type | The type of conversation where the button was pressed: Personal, Channel or GroupChat. | string |
| message | Message | The JSON data of the submit button; this data is flattened and may be accessed as individual properties prefixed with "message". | string |
| message.actiontitle | Button Title | The title of the action button pressed by the user, in case there is more than one on the card. | string |
| message.context | Context Data | Any context data added to the action button from UIP. This can be a simple string or a JSON object (if JSON, it is flattened and may be accessed as individual properties prefixed with "message.context"). | string |
| fromidentifier | From | The UPN of the Teams user who sent the message. | string |
Card ID Received (cardDetailsReceived)
Identification details when a card sent from UIP was posted in a conversation.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| identifier | Conversation ID | The ID of the conversation where the card was added. | string |
| cardIdentifier | Card ID | The ID of the card posted in the conversation. | string |
| messageIdentifier | Message ID | The Message ID from the Send Card or Send Custom Card command. | string |
Meeting Information Received (meetingInfoReceived)
Meeting information received after the meeting was created.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| actionType | Action Type | The type of operation which resulted in this event (AddOnlineMeeting or GetOnlineMeeting). | string |
| id | Meeting ID | Online meeting identifier. | string |
| subject | Subject | The Subject of the online meeting. | string |
| startDateTime | Start Date Time | The meeting's start date time in UTC. | string |
| endDateTime | End Date Time | The meeting's end date time in UTC. | string |
| customId | Custom ID | The Custom ID used when creating the online meeting; if a meeting already exists with this Custom ID, it is reused. | array |
| joinUrl | Join URL | The URL to join the meeting. | string |
| chatId | Chat ID | The meeting's chat ID for sending text or card messages in the meeting. | string |
| conferenceId | Conference ID | The meeting's conference ID for calling into the meeting. | string |
| tollFreeNumber | Toll Free Number | The meeting's toll free phone number. | string |
| tollNumber | Toll Number | The meeting's phone number. | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | string |
| participants | Participants | The meeting's participants. | array |
| participants[0].upn | User Principal Name | The participant user's UPN. | string |
Calendar Meeting Information Received (calendarMeetingInfoReceived)
Calendar Meeting information received.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| actionType | Action Type | The type of operation which resulted in this event (AddCalendarMeeting, GetCalendarMeeting, UpdateCalendarMeeting, UpdateCalendarMeetingParticipants, or DeleteCalendarMeeting). | string |
| eventId | Meeting ID | The Meeting ID of the scheduled event in the calendar. | string |
| organizer | Organizer | The UPN of the user organizing the meeting. | string |
| startDateTime | Start Date Time | When the meeting starts. This will be in ISO 8601 format without time zone (i.e. - {date}T{time}; for example, 2021-09-01T09:00:00). | string |
| startDateTimeTimeZone | Start Time Zone | The time zone of the meeting start (e.g. - Pacific Standard Time). | string |
| endDateTime | End Date Time | When the meeting ends. This will be in ISO 8601 format without time zone (i.e. - {date}T{time}; for example, 2021-09-01T10:00:00). | string |
| endDateTimeTimeZone | End Time Zone | The time zone of the meeting end (e.g. - Pacific Standard Time). | string |
| isAllDay | Is All Day? | Does the meeting last all day? | string |
| subject | Subject | The subject of the meeting. | string |
| bodyContentType | Body Content Type | Whether the Body Content value is Html or Text | string |
| bodyContent | Body Content | The body of the message for the meeting in HTML or plain text format. This may additionally contain online meeting information, if enabled. | string |
| isOnlineMeeting | Is Online Meeting? | Is this an online meeting? | string |
| onlineMeetingProvider | Online Meeting Provider | The online meeting service provider: 'teamsForBusiness', 'skypeForBusiness', or 'skypeForConsumer'. | string |
| importance | Importance | The importance of the meeting: 'low', 'normal', or 'high'. | string |
| isReminderOn | Is Reminder On? | Are participants be reminded of the meeting beforehand? | string |
| reminderMinutesBeforeStart | Remind Minutes Before | The number of minutes before the event start time that participants are sent a reminder. | string |
| allowNewTimeProposals | Allow New Time Proposals? | Participants are allowed to propose a new time for the meeting when responding. | string |
| hideAttendees | Hide Attendees? | Participants only see themselves in the meeting request and attendee list. | string |
| transactionId | Transaction ID | A custom identifier for the meeting which was specified when the meeting was created. | string |
| participants | Participants | The meeting's participants, up to a maximum of 500. | array |
| participants[0].identifier | Participant ID | The participant's UPN or email address. | string |
| participants[0].attendeetype | Participant Type | Whether the participant is 'Required' or 'Optional'. | string |
| locations | Locations | The locations for the meeting. | array |
| locations[0].displayname | Location Display Name | The name associated with the location. | string |
| locations[0].email | Location Email Address | An email address associated with the location. | string |
| conferenceId | Conference ID | The ID of the online meeting conference, if added. | string |
| joinUrl | Join Web URL | An external link that launches the online meeting for participants. | string |
| tollfreenumbers | Toll Free Numbers | The toll free numbers that can be used to join the online meeting conference. | array |
| tollfreenumbers[0].tollfreenumber | Toll Free Number | The toll free number that can be used to join the online meeting conference. | string |
| tollnumber | Toll Number | The toll number that can be used to join the online meeting conference. | string |
| quickdial | Quick Dial Number | The pre-formatted quick-dial number for the online meeting conference. | string |
Send Error Received (sendErrorReceived)
Send error received.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| identifier | Recipient | Destination specified at the time of sending. | string |
| messageIdentifier | Message ID | Message ID specified when sending. | string |
| cardIdentifier | Card ID | Card ID specified when updating or deleting a card. | string |
| errorMessage | Error Message | Details of the error that occurred in AppService. | string |
| errorContext | Error Context Data | Error context data specified when executing the command. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.2 | Feature | Added support for managing Teams online meetings and calendar meetings. | NAP-20789 NAP-20944 |
|
| 2.0.3 | Feature | Added send multiple cards command. | NAP-22401 | |
| 2.0.4 | Feature | Added 'sendErrorReceived' event. | NAP-22728 | |
| 2.0.5 | Feature | Added support for Azure Redundancy | NAP-23282 | |
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |