Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New platform for Microsoft Teams (#27981)
* New Microsoft Teams notification service * Updated codeowners * Updated requirements_all * Changed from WEBHOOK_ID to URL * Moved try/except block
- Loading branch information
Showing
6 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
"""The Microsoft Teams component.""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"domain": "msteams", | ||
"name": "Microsoft Teams", | ||
"documentation": "https://www.home-assistant.io/integrations/msteams", | ||
"requirements": ["pymsteams==0.1.12"], | ||
"dependencies": [], | ||
"codeowners": ["@peroyvind"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
"""Microsoft Teams platform for notify component.""" | ||
import logging | ||
|
||
import pymsteams | ||
import voluptuous as vol | ||
|
||
from homeassistant.components.notify import ( | ||
ATTR_DATA, | ||
ATTR_TITLE, | ||
ATTR_TITLE_DEFAULT, | ||
PLATFORM_SCHEMA, | ||
BaseNotificationService, | ||
) | ||
from homeassistant.const import CONF_URL | ||
import homeassistant.helpers.config_validation as cv | ||
|
||
_LOGGER = logging.getLogger(__name__) | ||
|
||
ATTR_FILE_URL = "image_url" | ||
|
||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({vol.Required(CONF_URL): cv.url}) | ||
|
||
|
||
def get_service(hass, config, discovery_info=None): | ||
"""Get the Microsoft Teams notification service.""" | ||
webhook_url = config.get(CONF_URL) | ||
|
||
try: | ||
return MSTeamsNotificationService(webhook_url) | ||
|
||
except RuntimeError as err: | ||
_LOGGER.exception("Error in creating a new Microsoft Teams message: %s", err) | ||
return None | ||
|
||
|
||
class MSTeamsNotificationService(BaseNotificationService): | ||
"""Implement the notification service for Microsoft Teams.""" | ||
|
||
def __init__(self, webhook_url): | ||
"""Initialize the service.""" | ||
self._webhook_url = webhook_url | ||
self.teams_message = pymsteams.connectorcard(self._webhook_url) | ||
|
||
def send_message(self, message=None, **kwargs): | ||
"""Send a message to the webhook.""" | ||
title = kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT) | ||
data = kwargs.get(ATTR_DATA) | ||
|
||
self.teams_message.title(title) | ||
|
||
self.teams_message.text(message) | ||
|
||
if data is not None: | ||
file_url = data.get(ATTR_FILE_URL) | ||
|
||
if file_url is not None: | ||
if not file_url.startswith("http"): | ||
_LOGGER.error("URL should start with http or https") | ||
return | ||
|
||
message_section = pymsteams.cardsection() | ||
message_section.addImage(file_url) | ||
self.teams_message.addSection(message_section) | ||
try: | ||
self.teams_message.send() | ||
except RuntimeError as err: | ||
_LOGGER.error("Could not send notification. Error: %s", err) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters