WeCom Bot Notifications

Overview

• Source: https://weixin.qq.com/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 32768

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.

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

Send a WeCom Bot Notification:

# Assuming our {botkey} is abc123
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "wecombot://abc123"