OneBot (QQ) Notifications


Account Setup
Section titled “Account Setup”OneBot 11 is supported by QQ bot programs such as NapCat, LLOneBot, Lagrange.OneBot, and go-cqhttp. Apprise connects to the program’s HTTP server and sends notifications from your QQ account.
- Install one of the bot programs above and log in with the QQ account that should send your notifications.
- In its settings, turn on the OneBot 11 HTTP server. Note the port it listens on (NapCat often uses
3000, go-cqhttp uses5700). - Optionally set an access token, then include it in your Apprise URL.
- Find the QQ number of each person you want to message, and the group number of each group. The bot account must be a friend of each person and a member of each group.
Images, voice clips and videos are sent as QQ media. Any other file is sent as a QQ file, which NapCat, LLOneBot and Lagrange support. Each attachment arrives as its own message.
Syntax
Section titled “Syntax”Valid syntax is as follows:
onebot://{host}/{user_id}onebot://{host}:{port}/@{user_id}/#{group_id}onebot://{token}@{host}:{port}/@{user_id}/#{group_id}onebots://{token}@{host}:{port}/@{user_id}/#{group_id}
You can mix as many users and groups as you like:
onebot://{token}@{host}:{port}/@{user_id1}/@{user_id2}/#{group_id1}/#{group_idN}
Use onebots:// when your bot is available over HTTPS, such as through a reverse proxy. This encrypts the access token and message while they travel to the bot.
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| host | Yes | The hostname or IP address of the machine running your OneBot program. |
| port | No | The port of the OneBot HTTP server. Defaults to 80 for onebot:// and 443 for onebots://. |
| token | No | The access token you set in your OneBot program, if any. |
| user_id | *Yes | The QQ number of a person to message, up to 19 digits. The @ in front is optional. |
| group_id | *Yes | The number of a QQ group to message, up to 19 digits. It must start with #. |
| to | No | Another way to list users and groups, separated by commas. Write a group’s # as %23 here, for example ?to=12345,%2367890. |
*At least one user or group is required.
Global Parameters
Section titled “Global Parameters”| Variable | Description |
|---|---|
| overflow | Controls messages that exceed a service’s documented limit. The default is upstream.👉 upstream: Send one message without splitting or truncating it for that limit.👉 truncate: Keep the portion that fits and discard the rest.👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order.Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document. |
| 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 evaluates as 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
Section titled “Examples”Send a message to one QQ user through NapCat on the same machine:
# Assuming our OneBot HTTP server listens on localhost:3000# Assuming the QQ number to notify is 12345678apprise -vv -t "Test Message Title" -b "Test Message Body" \ "onebot://localhost:3000/12345678"Send to a user and a group, using an access token:
# Assuming our {token} is abc123secret# Assuming the QQ number is 12345678 and the group number is 87654321apprise -vv -t "Alert" -b "Server is down!" \ "onebot://abc123secret@localhost:3000/@12345678/#87654321"Send a picture to a group over HTTPS:
# Assuming our bot is reachable at bot.example.com (HTTPS)apprise -vv -b "Today's graph" --attach=graph.png \ "onebots://abc123secret@bot.example.com/#87654321"Questions or Feedback?
Technical Issues
Having trouble with the code? Open an issue on GitHub: