notify.py

Go to the documentation of this file.

"""Microsoft Teams platform for notify component."""
 
from __future__ import annotations
 
import logging
 
import pymsteams
import voluptuous as vol
 
from homeassistant.components.notify import (
    ATTR_DATA,
    ATTR_TITLE,
    ATTR_TITLE_DEFAULT,
    PLATFORM_SCHEMA as NOTIFY_PLATFORM_SCHEMA,
    BaseNotificationService,
)
from homeassistant.const import CONF_URL
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
_LOGGER = logging.getLogger(__name__)
 
ATTR_FILE_URL = "image_url"
 
PLATFORM_SCHEMA = NOTIFY_PLATFORM_SCHEMA.extend({vol.Required(CONF_URL): cv.url})
 
 
def get_service(
    hass: HomeAssistant,
    config: ConfigType,
    discovery_info: DiscoveryInfoType | None = None,
) -> MSTeamsNotificationService | None:
    """Get the Microsoft Teams notification service."""
    webhook_url = config.get(CONF_URL)
 
    try:
        return MSTeamsNotificationService(webhook_url)
 
    except RuntimeError:
        _LOGGER.exception("Error in creating a new Microsoft Teams message")
        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 = webhook_url
 
    def send_message(self, message=None, **kwargs):
        """Send a message to the webhook."""
 
        teams_message = pymsteams.connectorcard(self._webhook_url_webhook_url)
 
        title = kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)
        data = kwargs.get(ATTR_DATA)
 
        teams_message.title(title)
 
        teams_message.text(message)
 
        if data is not None and (file_url := data.get(ATTR_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)
            teams_message.addSection(message_section)
        try:
            teams_message.send()
        except RuntimeError as err:
            _LOGGER.error("Could not send notification. Error: %s", err)