Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added WeCom Bot Support #1016

Merged
merged 1 commit into from
Dec 16, 2023
Merged

Added WeCom Bot Support #1016

merged 1 commit into from
Dec 16, 2023

Conversation

caronc
Copy link
Owner

@caronc caronc commented Dec 16, 2023

Description:

Related issue (if applicable): #917

Added WeCom Bot Support:\

  • Source: https://weixin.qq.com/
  • Icon Support: No
  • Message Format: Text
  • Message Limit: 32768 Characters per message

Account Setup

Sign up for WeChat from here. You will be provided to create a user and password to associate with your account. This is all you need to use this through Apprise.

WeCom for PC

  1. On WeCom for PC, find the target WeCom group for receiving alarm notifications.
  2. Right-click the WeCom group. In the window that appears, click "Add Group Bot".
  3. In the window that appears, click Create a Bot.
  4. In the window that appears, enter a custom bot name and click Add.
  5. You will be provided a Webhook URL that looks like:
    • https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd

WeCom for Web

  1. On WebCom for Web, open the target WeCom group for receiving alarm notifications.
  2. Click the group settings icon in the upper-right corner.
  3. On the group settings page, choose Group Bots > Add a Bot.
  4. On the management page for adding bots, enter a custom name for the new bot.
  5. Click Add
  6. You will be provided a Webhook URL that looks like:
    • https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd

Syntax

Valid syntax is as follows:

  • wecombot://{botkey}
  • https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd

Parameter Breakdown

Variable Required Description
key No Can optionally use the ?key instead of passing the key in the hostname field. This has more value when defining configuration files.

New Service Completion Status

  • apprise/plugins/NotifyWeComBot.py
  • KEYWORDS
    • add new service into this file (alphabetically).
  • README.md
    • add entry for new service to table (as a quick reference)
  • packaging/redhat/python-apprise.spec
    • add new service into the %global common_description

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • No lint errors (use flake8)
  • 100% test coverage

Testing

Anyone can help test this source code as follows:

# Create a virtual environment to work in as follows:
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@917-wecom-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
  "wecombot://botkey'

@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a8e24ea) 99.52% compared to head (20092ae) 99.52%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1016   +/-   ##
=======================================
  Coverage   99.52%   99.52%           
=======================================
  Files         128      129    +1     
  Lines       17126    17189   +63     
  Branches     3502     3510    +8     
=======================================
+ Hits        17044    17107   +63     
  Misses         70       70           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@caronc caronc merged commit 524eba6 into master Dec 16, 2023
12 checks passed
@caronc caronc deleted the 917-wecom-support branch December 29, 2023 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants