mirror of
https://github.com/caronc/apprise.git
synced 2024-12-04 05:54:35 +01:00
Page:
Notify_wecombot
Pages
CLI_Usage
DemoPlugin_Basic
DemoPlugin_WebRequest
Development_API
Development_Apprise_Details
Development_Contribution
Development_LogCapture
Home
Notification_Graveyard
Notify_Custom_Form
Notify_Custom_JSON
Notify_Custom_XML
Notify_Revolt
Notify_africas_talking
Notify_apprise_api
Notify_aprs
Notify_bark
Notify_boxcar
Notify_bulksms
Notify_bulkvs
Notify_burst_sms
Notify_chantify
Notify_clicksend
Notify_d7networks
Notify_dapnet
Notify_dbus
Notify_dingtalk
Notify_discord
Notify_email Fastmail
Notify_email
Notify_emby
Notify_enigma2
Notify_faast
Notify_fcm
Notify_feishu
Notify_flock
Notify_freemobile
Notify_gitter
Notify_gnome
Notify_googlechat
Notify_gotify
Notify_growl
Notify_guilded
Notify_homeassistant
Notify_httpsms
Notify_ifttt
Notify_join
Notify_kavenegar
Notify_kodi
Notify_kumulos
Notify_lametric
Notify_line
Notify_lunasea
Notify_macosx
Notify_mailgun
Notify_mastodon
Notify_matrix
Notify_mattermost
Notify_messagebird
Notify_misskey
Notify_mqtt
Notify_msg91
Notify_msteams
Notify_nexmo
Notify_nextcloud
Notify_nextcloudtalk
Notify_notica
Notify_notifiarr
Notify_notifico
Notify_ntfy
Notify_office365
Notify_onesignal
Notify_opsgenie
Notify_pagerduty
Notify_pagertree
Notify_parseplatform
Notify_plivo
Notify_popcornnotify
Notify_prowl
Notify_pushalot
Notify_pushbullet
Notify_pushdeer
Notify_pushed
Notify_pushjet
Notify_pushme
Notify_pushover
Notify_pushsafer
Notify_pushy
Notify_reddit
Notify_rocketchat
Notify_rsyslog
Notify_ryver
Notify_sendgrid
Notify_serverchan
Notify_ses
Notify_seven
Notify_sfr
Notify_signal
Notify_simplepush
Notify_sinch
Notify_slack
Notify_sms_manager
Notify_smseagle
Notify_smtp2go
Notify_sns
Notify_sparkpost
Notify_splunk
Notify_spontit
Notify_streamlabs
Notify_stride
Notify_synology_chat
Notify_syslog
Notify_techulus
Notify_telegram
Notify_threema
Notify_toasty
Notify_twilio
Notify_twist
Notify_twitter
Notify_voipms
Notify_wecombot
Notify_whatsapp
Notify_windows
Notify_workflows
Notify_wxpusher
Notify_wxteams
Notify_xbmc
Notify_xmpp
Notify_zulip
Sponsors
Troubleshooting
URLBasics
config
config_text
config_yaml
decorator_notify
persistent_storage
showcase
1
Notify_wecombot
Chris Caron edited this page 2023-12-16 17:03:40 -05:00
Table of Contents
WeCom Bot
- 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
- On WeCom for PC, find the target WeCom group for receiving alarm notifications.
- Right-click the WeCom group. In the window that appears, click "Add Group Bot".
- In the window that appears, click Create a Bot.
- In the window that appears, enter a custom bot name and click Add.
- You will be provided a Webhook URL that looks like:
https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd
WeCom for Web
- On WebCom for Web, open the target WeCom group for receiving alarm notifications.
- Click the group settings icon in the upper-right corner.
- On the group settings page, choose Group Bots > Add a Bot.
- On the management page for adding bots, enter a custom name for the new bot.
- Click Add
- 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. |
Example
Send a WeCom Bot Notification:
# Assuming our {botkey} is abc123
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"wecombot://abc123"