slack_update_user_profile.py

"""
Script: Slack Update User Profile for Out of Office/Vacation with Do Not Disturb (DND) Mode

Description:
This script updates a user's Slack profile to reflect their out-of-office or vacation status. 
It sets the user's display name, status text, status emoji, and status expiration. Additionally, 
the script activates Slack's Do Not Disturb (DND) mode to pause notifications for a specified 
duration.

Functions:
- get_slack_token: Reads the Slack token from a specified file.
- set_profile: Updates the user's Slack profile with the provided display name, status text, 
  status emoji, and status expiration.
- set_snooze: Pauses notifications for the specified number of minutes using Slack's 
  Do Not Disturb (DND) feature.

Usage:
1. Run the script.
2. Enter the path to your Slack access token file when prompted.
3. Enter the user ID, display name, status text, status emoji, status expiration, and 
   snooze duration (in minutes).
4. The script will update the user's profile and pause their notifications for the 
   specified time.

Notes:
- Ensure that the Slack token has the necessary permissions to update user profiles 
  and manage Do Not Disturb settings.
- Handle the Slack token securely and do not expose it in the code.
- Customize the input prompts and error handling as needed for your organization.
- This script includes both profile updates and snoozing notifications in Slack.

Author: Chad Ramey
Date: August 2, 2024
Last Updated: October 1, 2024 (Added DND/Notification Snooze functionality)
"""

import requests

def get_slack_token(token_path):
    """Reads the Slack token from a specified file.

    Args:
        token_path: The path to the file containing the Slack token.

    Returns:
        The Slack token as a string.
    """
    with open(token_path, 'r') as token_file:
        return token_file.read().strip()

def set_profile(access_token, user_id, display_name, status_text, status_emoji, status_expiration):
    """Updates the user's profile with the provided information.

    Args:
        access_token: The Slack access token.
        user_id: The ID of the user whose profile needs to be updated.
        display_name: The new display name.
        status_text: The new status text.
        status_emoji: The new status emoji.
        status_expiration: The expiration time for the status in Unix format.
    """
    url = "https://slack.com/api/users.profile.set"
    
    payload = {
        'profile': {
            'display_name': display_name,
            'status_text': status_text,
            'status_emoji': status_emoji,
            'status_expiration': int(status_expiration)
        },
        'user': user_id
    }

    headers = {
        'Authorization': f'Bearer {access_token}',
        'Content-Type': 'application/json'
    }

    response = requests.post(url, headers=headers, json=payload)
    data = response.json()

    if response.ok and data.get('ok'):
        print("Profile status successfully updated.")
    else:
        print("Failed to update profile status.")
        if data.get('error'):
            print("Error message:", data['error'])

def set_snooze(access_token, snooze_minutes):
    """Sets the user's Do Not Disturb (DND) mode for the specified duration.

    Args:
        access_token: The Slack access token.
        snooze_minutes: The number of minutes to snooze notifications.
    """
    url = "https://slack.com/api/dnd.setSnooze"
    
    payload = {
        'num_minutes': snooze_minutes
    }

    headers = {
        'Authorization': f'Bearer {access_token}',
        'Content-Type': 'application/json'
    }

    response = requests.post(url, headers=headers, json=payload)
    data = response.json()

    if response.ok and data.get('ok'):
        print(f"Notifications snoozed for {snooze_minutes} minutes.")
    else:
        print("Failed to snooze notifications.")
        if data.get('error'):
            print("Error message:", data['error'])

# Prompt the user for input
token_path = input("Please enter the path to your Slack access token file: ")
access_token = get_slack_token(token_path)
user_id = input("Enter user ID: ")
display_name = input("Enter display name: ")
status_text = input("Enter status text: ")
status_emoji = input("Enter status emoji: ")
status_expiration = input("Enter status expiration (Unix Time - 0 for indefinite): ")
snooze_duration = input("Enter snooze duration in minutes (e.g., 1440 for 24 hours): ")

# Update the user's profile
set_profile(access_token, user_id, display_name, status_text, status_emoji, status_expiration)

# Set the snooze (Do Not Disturb) for the user
set_snooze(access_token, int(snooze_duration))