WeChat (WeCom Application) Notifications

Overview

• Source: https://work.weixin.qq.com/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 2048
• Build Your Apprise URL

Account Setup

This plugin uses the WeCom Application Message API to deliver notifications directly to users, departments, or tags within a WeCom (WeChat Work / Enterprise WeChat) organisation. No third-party service is required.

You will need three credentials from your WeCom admin console:

1. Sign in to the WeCom admin console at https://work.weixin.qq.com/.
2. Go to “Applications & Mini Programs” -> “Applications” and create a new self-built application, or select an existing one.
3. Copy the AgentID shown on the application details page.
4. Go to “My Enterprise” -> “Enterprise Information” and copy the CorpID.
5. Back on the application page, click “View” next to Secret and copy the App Secret.

Note

The App Secret is only shown once after it is generated. Store it securely.

Syntax

Valid syntax is as follows:

• wechat://{corpid}:{corpsecret}@{agentid}/@all
• wechat://{corpid}:{corpsecret}@{agentid}/@{userid}
• wechat://{corpid}:{corpsecret}@{agentid}/@{user1}/@{user2}
• wechat://{corpid}:{corpsecret}@{agentid}/%23{deptid}
• wechat://{corpid}:{corpsecret}@{agentid}/+{tagid}
• wechat://{corpid}:{corpsecret}@{agentid}/@{user}/%23{dept}/+{tag}

Recipient prefix rules:

Prefix	Recipient type	Example
@	WeCom user ID (optional input, always emitted)	@johndoe
@all	All users in the organisation	@all
%23 (URL-encoded #)	Department ID (numeric)	%23100
+	Tag ID (numeric)	+7

Note

@all is a reserved keyword that broadcasts to every member of the organisation. The bare form all (without @) is also accepted and treated identically. Both forms send to everyone, not to a user named “all”.

The @ prefix on regular user IDs is optional when typing a URL by hand — johndoe and @johndoe are both accepted. Apprise always emits the @ prefix in generated URLs to keep all target types visually distinct.

You can combine multiple recipients of different types in a single URL. At least one recipient must be specified.

Parameter Breakdown

Variable	Required	Description
corpid	*Yes	The Corporation ID found under “My Enterprise” -> “Enterprise Information” in the WeCom admin console.
corpsecret	*Yes	The App Secret generated for the self-built application.
agentid	*Yes	The numeric Agent ID shown on the application details page.
targets	No	One or more recipients in the URL path. Use no prefix for user IDs, @all for the whole org, %23 prefix for department IDs, and + prefix for tag IDs.
to	No	Comma-separated recipient list supplied as a query parameter (?to=) instead of in the URL path.
format	No	Set to markdown to send the notification body as a WeCom Markdown message; default is plain text.

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.
redirect	By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this 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.
retry	The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait	The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value.
optional	When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still returns True even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Examples

Send to all users in the organisation:

# Replace with your actual CorpID, App Secret, and AgentID
apprise -vv -t "Test Title" -b "Test Message" \
   "wechat://wwCORPID:APPSECRET@1000002/@all"

Send to a specific user:

apprise -vv -t "Test Title" -b "Test Message" \
   "wechat://wwCORPID:APPSECRET@1000002/@johndoe"

Send to multiple users:

apprise -vv -t "Test Title" -b "Test Message" \
   "wechat://wwCORPID:APPSECRET@1000002/@alice/@bob/@charlie"

Send to a department (department ID 42):

apprise -vv -t "Test Title" -b "Test Message" \
   "wechat://wwCORPID:APPSECRET@1000002/%2342"

Send a Markdown-formatted notification:

apprise -vv -t "Test Title" -b "## Alert\nSomething happened." \
   "wechat://wwCORPID:APPSECRET@1000002/@all?format=markdown"

See Also

Apprise also provides two related WeCom/WeChat integrations:

• WeCom Bot — sends to a WeCom group chat via a webhook key; simpler to set up but delivers to a group rather than individual users or departments.
• PushPlus — routes notifications through the PushPlus platform, which supports WeChat, WeCom, email, and SMS delivery from a single personal token.