Принцип работы ботов Microsoft Teams

ОБЛАСТЬ ПРИМЕНЕНИЯ: ПАКЕТ SDK версии 4

Эта статья основана на том, что вы узнали в том, как боты работают и беседы на основе событий. Прежде чем продолжить, вы должны ознакомиться с этими статьями.

Основное отличие ботов, разработанных для Microsoft Teams, заключается в том, как обрабатываются действия. Обработчик действий Teams является производным от обработчика действий и обрабатывает типы действий, относящиеся к Teams, прежде чем обрабатывать более общие типы действий.

Примечание.

Пакеты SDK для JavaScript, C# и Python для Bot Framework по-прежнему будут поддерживаться, однако пакет SDK java отменяется с окончательной долгосрочной поддержкой, заканчивающейся в ноябре 2023 года. В этом репозитории будут выполняться только критически важные исправления безопасности и ошибок.

Существующие боты, созданные с помощью пакета SDK для Java, будут продолжать функционировать.

Для создания нового бота рекомендуется использовать Power Virtual Agent и ознакомиться с выбором подходящего решения чат-бота.

Дополнительные сведения см. в статье "Будущее создания бота".

Обработчик действий Teams

Чтобы создать бот для Teams, наследуйте бот из класса обработчика действий Teams. Когда такой бот получает действие, он направляет действие через различные обработчики действий. Начальный базовый обработчик — это обработчик поворота, который направляет действие обработчику на основе типа действия. Обработчик поворота вызывает обработчик, предназначенный для обработки определенного типа полученного действия. Класс обработчика действий Teams является производным от класса обработчика действий. Помимо типов действий, которые может обрабатывать обработчик действий, класс обработчика действий Teams включает дополнительные обработчики для действий, относящихся к Teams.

Бот, производный от обработчика действий Teams, аналогичен боту, который является производным непосредственно от класса обработчика действий. Однако Teams включает дополнительные сведения в conversationUpdate действия и отправляет действия и event действия, относящиеся invoke к Teams.

C#

Когда обработчик действий Teams — бот получает действие сообщения, обработчик поворота направляет входящие действия сообщения обработчику OnMessageActivityAsync сообщений, аналогично тому, как бот на основе обработчика действий. Однако, когда бот Teams получает действие обновления беседы, версия обработчика OnConversationUpdateActivityAsync Teams обрабатывает действие.

Для большинства обработчиков действий, зависящих от Teams, не существует базовой реализации. Вам потребуется переопределить эти обработчики и предоставить соответствующую логику для бота.

JavaScript

Когда обработчик действий Teams — бот получает действие сообщения, обработчик поворота направляет входящие действия сообщения обработчику onMessage сообщений, аналогично тому, как бот на основе обработчика действий. Однако, когда бот Teams получает действие обновления беседы, версия обработчика dispatchConversationUpdateActivity Teams обрабатывает действие.

Для большинства обработчиков действий, зависящих от Teams, не существует базовой реализации. Вам потребуется переопределить эти обработчики и предоставить соответствующую логику для бота.

При переопределении этих обработчиков действий, относящихся к Teams, определите логику бота, а затем обязательно вызовите next() в конце. При вызове next()убедитесь, что следующий обработчик выполняется.

Java

Когда обработчик действий Teams — бот получает действие сообщения, обработчик поворота направляет входящие действия сообщения обработчику onMessageActivity сообщений, аналогично тому, как бот на основе обработчика действий. Однако, когда бот Teams получает действие обновления беседы, версия обработчика onConversationUpdateActivity Teams обрабатывает действие.

Для большинства обработчиков действий, зависящих от Teams, не существует базовой реализации. Вам потребуется переопределить эти обработчики и предоставить соответствующую логику для бота.

Python

Когда обработчик действий Teams — бот получает действие сообщения, обработчик поворота направляет входящие действия сообщения обработчику on_message_activity сообщений, аналогично тому, как бот на основе обработчика действий. Однако, когда бот Teams получает действие обновления беседы, версия обработчика on_conversation_update_activity Teams обрабатывает действие.

Для большинства обработчиков действий, зависящих от Teams, не существует базовой реализации. Вам потребуется переопределить эти обработчики и предоставить соответствующую логику для бота.

Все обработчики действий, описанные в разделе обработки действий бесед на основе событий с помощью статьи обработчика действий, будут продолжать работать так, как они выполняются с ботом, отличным от Teams, за исключением обработки добавленных и удаленных действий, эти действия будут отличаться в контексте команды, где новый член добавляется в команду в отличие от потока сообщений. Дополнительные сведения см. в разделе "Действия по обновлению бесед Teams".

Чтобы реализовать логику для этих обработчиков действий, относящихся к Teams, вы переопределите методы в боте.

Логика бота Teams

Логика бота обрабатывает входящие действия из одного или нескольких каналов бота и создает исходящие действия в ответ. Этот механизм сохраняется и для бота, производного от класса обработчика действий Teams, который первым делом проверяет действия для Teams, а затем передает все остальные действия обработчику действий Bot Framework.

Действия по обновлению установки Teams

Добавьте обработчик события обновления установки, чтобы позволить боту:

• Отправьте вводное сообщение при установке в потоке беседы.
• Очистка данных пользователей и потоков при удалении из потока.

Дополнительные сведения см . в разделе "Обновление установки" в документации Teams.

Действие обновления диалога Teams

В следующей таблице перечислены события Teams, создающие действие обновления беседы в боте. В статье о событиях обновления бесед Microsoft Teams описывается использование каждого из этих событий.

C#

Ниже приведен список всех обработчиков действий Teams, вызываемых из OnConversationUpdateActivityAsync метода обработчика действий Teams .

EventType	Обработчик	Condition	Документация по Teams
channelCreated	OnTeamsChannelCreatedAsync	Отправляется всякий раз, когда новый канал создается в команде бота.	Канал создан.
channelDeleted	OnTeamsChannelDeletedAsync	Отправляется каждый раз, когда канал удаляется в команде, в которую установлен бот.	Канал удален.
channelRenamed	OnTeamsChannelRenamedAsync	Отправляется всякий раз, когда канал переименован в команде, в которую установлен бот.	Канал переименован.
channelRestored	OnTeamsChannelRestoredAsync	Отправляется всякий раз, когда канал, который ранее был удален, восстанавливается в команде, в которую уже установлен бот.	Канал восстановлен.
membersAdded	OnTeamsMembersAddedAsync	По умолчанию вызывает ActivityHandler.OnMembersAddedAsync метод. Отправляется при первом добавлении бота в беседу и каждый раз, когда новый пользователь добавляется в группу или групповый чат, в котором установлен бот.	Добавлены члены команды.
membersRemoved	OnTeamsMembersRemovedAsync	По умолчанию вызывает ActivityHandler.OnMembersRemovedAsync метод. Отправляется, если бот удаляется из команды, и каждый раз, когда любой пользователь удаляется из команды, в которую входит ваш бот.	Члены команды удалены.
teamArchived	OnTeamsTeamArchivedAsync	Отправляется при установке бота в архиве.	Команда архивирована.
teamDeleted	OnTeamsTeamDeletedAsync	Отправляется при удалении бота.	Команда удалена.
teamRenamed	OnTeamsTeamRenamedAsync	Отправляется при переименовании команды бота.	Команда переименована.
TeamRestored	OnTeamsTeamRestoredAsync	Отправляется при восстановлении ранее удаленной команды бота.	Команда восстановлена.
teamUnarchived	OnTeamsTeamUnarchivedAsync	Отправляется при установке бота в неархивном виде.	Команда неархивирована.

JavaScript

Разработчики могут обрабатывать действия обновления бесед, отправленные из Microsoft Teams с помощью двух методов:

1. Чтобы передать обратный вызов, используйте методы, которые начинаются и заканчиваются Event (например, методомonTeamsMembersAddedEvent).on
2. При создании производного класса переопределите методы, которые начинаются on и не заканчиваются Event (например, методом onTeamsMembersAdded ).

Разработчики должны использовать только один из следующих вариантов: 1 или 2, а не для одного и того же действия. Это означает, что разработчики должны либо передать обратный вызов методу onTeamsMembersAddedEvent, либо переопределить onTeamsMembersAdded метод в производном классе, а не делать оба.

Методы регистрации обратного вызова

Ниже приведен список всех обработчиков действий Teams, вызываемых из dispatchConversationUpdateActivity метода обработчика действий Teams .

EventType	Метод регистрации	Condition	Документация по Teams
channelCreated	onTeamsChannelCreatedEvent	Отправляется всякий раз, когда новый канал создается в команде бота.	Канал создан.
channelDeleted	onTeamsChannelDeletedEvent	Отправляется каждый раз, когда канал удаляется в команде, в которую установлен бот.	Канал удален.
channelRenamed	onTeamsChannelRenamedEvent	Отправляется всякий раз, когда канал переименован в команде, в которую установлен бот.	Канал переименован.
channelRestored	onTeamsChannelRestoredEvent	Отправляется всякий раз, когда канал, который ранее был удален, восстанавливается в команде, в которую уже установлен бот.	Канал восстановлен.
membersAdded	onTeamsMembersAddedEvent	Отправляется при первом добавлении бота в беседу и каждый раз, когда новый пользователь добавляется в группу или групповый чат, в котором установлен бот.	Добавлены члены команды.
membersRemoved	onTeamsMembersRemovedEvent	Отправляется, если бот удаляется из команды, и каждый раз, когда любой пользователь удаляется из команды, в которую входит ваш бот.	Члены команды удалены.
teamArchived	onTeamsTeamArchivedEvent	Отправляется при установке бота в архиве.	Команда архивирована.
teamDeleted	onTeamsTeamDeletedEvent	Отправляется при удалении бота.	Команда удалена.
teamRenamed	onTeamsTeamRenamedEvent	Отправляется при переименовании команды бота.	Команда переименована.
TeamRestored	onTeamsTeamrestoredEvent	Отправляется при восстановлении ранее удаленной команды бота.	Команда восстановлена.
teamUnarchived	onTeamsTeamUnarchivedEvent	Отправляется при установке бота в неархивном виде.	Команда неархивирована.

Методы переопределения в производном классе

Ниже приведен список всех обработчиков действий Teams, которые можно переопределить для обработки действий обновления бесед Teams.

EventType	Обработчик	Condition	Документация по Teams
channelCreated	onTeamsChannelCreated	Отправляется всякий раз, когда новый канал создается в команде бота.	Канал создан.
channelDeleted	onTeamsChannelDeleted	Отправляется каждый раз, когда канал удаляется в команде, в которую установлен бот.	Канал удален.
channelRenamed	onTeamsChannelRenamed	Отправляется всякий раз, когда канал переименован в команде, в которую установлен бот.	Канал переименован.
channelRestored	onTeamsChannelRestored	Отправляется всякий раз, когда канал, который ранее был удален, восстанавливается в команде, в которую уже установлен бот.	Канал восстановлен.
membersAdded	onTeamsMembersAdded	По умолчанию вызывает ActivityHandler.onMembersAdded метод. Отправляется при первом добавлении бота в беседу и каждый раз, когда новый пользователь добавляется в группу или групповый чат, в котором установлен бот.	Добавлены члены команды.
membersRemoved	onTeamsMembersRemoved	По умолчанию вызывает ActivityHandler.onMembersRemoved метод. Отправляется, если бот удаляется из команды, и каждый раз, когда любой пользователь удаляется из команды, в которую входит ваш бот.	Члены команды удалены.
teamArchived	onTeamsTeamArchived	Отправляется при установке бота в архиве.	Команда архивирована.
teamDeleted	onTeamsTeamDeleted	Отправляется при удалении бота.	Команда удалена.
teamRenamed	onTeamsTeamRenamed	Отправляется при переименовании команды бота.	Команда переименована.
TeamRestored	onTeamsTeamRestored	Отправляется при восстановлении ранее удаленной команды бота.	Команда восстановлена.
teamUnarchived	onTeamsTeamUnarchived	Отправляется при установке бота в неархивном виде.	Команда неархивирована.

Java

Ниже приведен список всех обработчиков действий Teams, вызываемых из onConversationUpdateActivity метода обработчика действий Teams .

EventType	Обработчик	Condition	Документация по Teams
channelCreated	onTeamsChannelCreated	Отправляется всякий раз, когда новый канал создается в команде бота.	Канал создан.
channelDeleted	onTeamsChannelDeleted	Отправляется каждый раз, когда канал удаляется в команде, в которую установлен бот.	Канал удален.
channelRenamed	onTeamsChannelRenamed	Отправляется всякий раз, когда канал переименован в команде, в которую установлен бот.	Канал переименован.
channelRestored	onTeamsChannelRestored	Отправляется всякий раз, когда канал, который ранее был удален, восстанавливается в команде, в которую уже установлен бот.	Канал восстановлен.
membersAdded	onTeamsMembersAdded	По умолчанию вызывает ActivityHandler.onMembersAdded метод. Отправляется при первом добавлении бота в беседу и каждый раз, когда новый пользователь добавляется в группу или групповый чат, в котором установлен бот.	Добавлены члены команды.
membersRemoved	onTeamsMembersRemoved	По умолчанию вызывает ActivityHandler.onMembersRemoved метод. Отправляется, если бот удаляется из команды, и каждый раз, когда любой пользователь удаляется из команды, в которую входит ваш бот.	Члены команды удалены.
teamArchived	onTeamsTeamArchived	Отправляется при установке бота в архиве.	Команда архивирована.
teamDeleted	onTeamsTeamDeleted	Отправляется при удалении бота.	Команда удалена.
teamRenamed	onTeamsTeamRenamed	Отправляется при переименовании команды бота.	Команда переименована.
TeamRestored	onTeamsTeamRestored	Отправляется при восстановлении ранее удаленной команды бота.	Команда восстановлена.
teamUnarchived	onTeamsTeamUnarchived	Отправляется при установке бота в неархивном виде.	Команда неархивирована.

Python

Ниже приведен список всех обработчиков действий Teams, вызываемых из on_conversation_update_activity метода обработчика действий Teams .

EventType	Обработчик	Condition	Документация по Teams
channelCreated	on_teams_channel_created	Отправляется всякий раз, когда новый канал создается в команде бота.	Канал создан.
channelDeleted	on_teams_channel_deleted	Отправляется каждый раз, когда канал удаляется в команде, в которую установлен бот.	Канал удален.
channelRenamed	on_teams_channel_renamed	Отправляется всякий раз, когда канал переименован в команде, в которую установлен бот.	Канал переименован.
channelRestored	on_teams_channel_restored	Отправляется всякий раз, когда канал, который ранее был удален, восстанавливается в команде, в которую уже установлен бот.	Канал восстановлен.
membersAdded	on_teams_members_added	По умолчанию вызывает метод базового класса on_members_added_activity . Отправляется при первом добавлении бота в беседу и каждый раз, когда новый пользователь добавляется в группу или групповый чат, в котором установлен бот.	Добавлены члены команды.
membersRemoved	on_teams_members_removed	По умолчанию вызывает метод базового класса on_members_removed_activity . Отправляется, если бот удаляется из команды, и каждый раз, когда любой пользователь удаляется из команды, в которую входит ваш бот.	Члены команды удалены.
teamArchived	on_teams_team_archived	Отправляется при установке бота в архиве.	Команда архивирована.
teamDeleted	on_teams_team_deleted	Отправляется при удалении бота.	Команда удалена.
teamRenamed	on_teams_team_renamed	Отправляется при переименовании команды бота.	Команда переименована.
TeamRestored	on_teams_team_restored	Отправляется при восстановлении ранее удаленной команды бота.	Команда восстановлена.
teamUnarchived	on_teams_team_unarchived	Отправляется при установке бота в неархивном виде.	Команда неархивирована.

Действия по событиям Teams

В следующей таблице перечислены действия, связанные с событиями Teams, отправляются боту. Перечисленные события предназначены для беседных ботов в Teams.

C#

Это обработчики действий, относящиеся к Teams, вызываемые обработчиком OnEventActivityAsyncдействий Teams .

Типы событий	Обработчик	Description
application/vnd.microsoft.meetingEnd	OnTeamsMeetingEndAsync	Бот связан с собранием, которое только что закончилось.
application/vnd.microsoft.meetingStart	OnTeamsMeetingStartAsync	Бот связан с собранием, которое только что началось.

JavaScript

Это обработчики действий, относящиеся к Teams, вызываемые обработчиком onEventActivityдействий Teams .

Типы событий	Обработчик	Description
application/vnd.microsoft.meetingEnd	onTeamsMeetingEnd	Бот связан с собранием, которое только что закончилось.
application/vnd.microsoft.meetingStart	onTeamsMeetingStart	Бот связан с собранием, которое только что началось.

Java

Это обработчики действий, относящиеся к Teams, вызываемые обработчиком onEventActivityдействий Teams .

Типы событий	Обработчик	Description
application/vnd.microsoft.meetingEnd	onTeamsMeetingEnd	Бот связан с собранием, которое только что закончилось.
application/vnd.microsoft.meetingStart	onTeamsMeetingStart	Бот связан с собранием, которое только что началось.

Python

Это обработчики действий, относящиеся к Teams, вызываемые обработчиком on_event_activityдействий Teams .

Типы событий	Обработчик	Description
application/vnd.microsoft.meetingEnd	on_teams_meeting_end_event	Бот связан с собранием, которое только что закончилось.
application/vnd.microsoft.meetingStart	on_teams_meeting_start_event	Бот связан с собранием, которое только что началось.

Команды, вызывающие Teams

В следующей таблице перечислены действия, связанные с Teams, которые вызывают Teams, отправляются боту. Перечисленные действия вызова предназначены для общения ботов в Teams. Пакет SDK для Bot Framework также поддерживает вызовы, относящиеся к расширениям для обмена сообщениями. Дополнительные сведения см. в статье "Что такое расширения обмена сообщениями Teams".

Примечание.

Документация по платформе Microsoft Teams и клиентская библиотека JavaScript Teams (TeamsJS) относятся к модулям задач в качестве модальных диалогов. Дополнительные сведения см . в диалогах .

C#

Ниже приведен список всех обработчиков действий Teams, вызываемых обработчиком OnInvokeActivityAsyncдействий Teams :

Вызываемые типы	Обработчик	Description
actionableMessage/executeAction	OnTeamsO365ConnectorCardActionAsync	Teams O365 Connector Card Action.
CardAction.Invoke	OnTeamsCardActionInvokeAsync	Teams Card Action Invoke.
fileConsent/invoke	OnTeamsFileConsentAcceptAsync	Teams File Consent Accept.
fileConsent/invoke	OnTeamsFileConsentAsync	Teams File Consent.
fileConsent/invoke	OnTeamsFileConsentDeclineAsync	Teams File Consent.
signin/verifyState	OnTeamsSigninVerifyStateAsync	Teams Sign in Verify State.
task/fetch	OnTeamsTaskModuleFetchAsync	Teams Task Module Fetch.
task/submit	OnTeamsTaskModuleSubmitAsync	Teams Task Module Submit.

JavaScript

Ниже приведен список всех обработчиков действий Teams, вызываемых обработчиком onInvokeActivityдействий Teams :

Вызываемые типы	Обработчик	Description
actionableMessage/executeAction	handleTeamsO365ConnectorCardAction	Teams O365 Connector Card Action.
CardAction.Invoke	handleTeamsCardActionInvoke	Teams Card Action Invoke.
fileConsent/invoke	handleTeamsFileConsentAccept	Teams File Consent Accept.
fileConsent/invoke	handleTeamsFileConsent	Teams File Consent.
fileConsent/invoke	handleTeamsFileConsentDecline	Teams File Consent.
signin/verifyState	handleTeamsSigninVerifyState	Teams Sign in Verify State.
task/fetch	handleTeamsTaskModuleFetch	Получение модуля задач Teams (модальное диалоговое окно).
task/submit	handleTeamsTaskModuleSubmit	Отправка модуля задач Teams (модальное диалоговое окно).

Java

Ниже приведен список всех обработчиков действий Teams, вызываемых обработчиком onInvokeActivityдействий Teams :

Вызываемые типы	Обработчик	Description
fileConsent/invoke	onTeamsFileConsent	Teams File Consent.
actionableMessage/executeAction	onTeamsO365ConnectorCardAction	Teams O365 Connector Card Action.
task/fetch	onTeamsTaskModuleFetch	Teams Task Module Fetch.
task/submit	onTeamsTaskModuleSubmit	Teams Task Module Submit.
tab/fetch	onTeamsTabFetch	Выборка вкладок Teams.
вкладка или отправка	onTeamsTabSubmit	Отправить вкладку Teams.
CardAction.Invoke	onTeamsCardActionInvoke	Teams Card Action Invoke.
fileConsent/invoke	onTeamsFileConsentAccept	Teams File Consent Accept.
fileConsent/invoke	onTeamsFileConsentDecline	Teams File Consent.
signin/verifyState	onTeamsSigninVerifyState	Teams Sign in Verify State.

Python

Ниже приведен список всех обработчиков действий Teams, вызываемых обработчиком on_invoke_activityдействий Teams :

Вызываемые типы	Обработчик	Description
actionableMessage/executeAction	on_teams_o365_connector_card_action	Teams O365 Connector Card Action.
CardAction.Invoke	on_teams_card_action_invoke	Teams Card Action Invoke.
fileConsent/invoke	on_teams_file_consent_accept	Teams File Consent Accept.
fileConsent/invoke	on_teams_file_consent	Teams File Consent.
fileConsent/invoke	on_teams_file_consent_decline	Teams File Consent Decline.
signin/verifyState	on_teams_signin_verify_state	Teams Sign in Verify State.
task/fetch	on_teams_task_module_fetch	Teams Task Module Fetch.
task/submit	on_teams_task_module_submit	Teams Task Module Submit.

Следующие шаги

Сведения о создании ботов для Teams см. в документации для разработчика Microsoft Teams.