Build Your Own QQ Bot

· / , , ·

320

reads

AI TranslationSimplified ChineseEnglish

Key Insights

AI · GEN

Foreword

Recently I found that the WebUI of NapCatQQ has been improved, making it quite suitable for beginners, so I wrote this article.

This article only covers basic usage and may lack some advanced features. However, you also need to understand the following basics: command line, HTTP protocol, Docker, Python; it's not completely zero-basis. (If you only want to use Webhook for notifications or use existing NoneBot plugins, you don't need Python programming.)

The tools used are NapCatQQ and NoneBot. The former runs QQ and connects to protocols like OneBot11, while the latter is a framework based on Python that calls the protocol. You can refer to the official documentation when encountering problems. (If you only want to use Webhook for notifications, you can stop after setting up NapCatQQ.)

Preparation

A server, whether internal or external network.
A QQ account to serve as the QQ bot; it is not recommended to use your main account.

QQ can detect whether a plugin is used, and your account may encounter the following issues: forced logout, login restrictions, freezing.
Please evaluate and decide whether to continue based on your own situation. The author is not responsible for any consequences of building a bot by following this article.

NapCatQQ

Installation

There are many ways to install NapCatQQ, but since it's a service, I still recommend using Docker to install the Shell version: https://napneko.github.io/guide/boot/Shell#napcat-docker-linux容器化部署
The Docker container comes with the NTQQ itself, so you don't need to install the corresponding version of QQ separately.

CodeBlock Loading...

At this point, visit http://[IP]:6099/webui to see the NTQQ web page, where you can log in and configure settings. The login password can be found in the log file (default: napcat); it is recommended to change it after logging in.
Alternatively, you can use docker logs napcat to view the logs and scan the QR code to log in to QQ.
When scanning the QR code to log in, it is recommended to check the option for no further phone verification.

Enable HTTP Protocol

In the WebUI, go to Network Configuration -> New -> HTTP Server. The name, Host, and port can be arbitrary. For the message format, it is recommended to choose Array. In practice, it is compatible with String and can send mixed text and image messages. It is strongly recommended to fill in a Token to prevent malicious requests.

After enabling, you can test it in Interface Debugging -> HTTP or with any API testing tool you are comfortable with. The API reference can be found at: https://napcat.apifox.cn/

There are two ways to use the Token:

Add Authorization: [Token] in the request header.

CodeBlock Loading...

Add ?access_token=[Token] in the URL.

CodeBlock Loading...

Using Webhook for Notifications

The most important interfaces here are naturally sending private messages and sending group messages. You can find the corresponding API in Interface Debugging -> HTTP, which also has a message construction feature; it's quite simple.
Here is an example of sending a private message:

CodeBlock Loading...

Some applications use shoutrrr as the Webhook implementation, and you can refer to the following configuration:

CodeBlock Loading...

Some applications may already support the OneBot11 protocol; in that case, simply fill in http://[IP]:3000, the Token, and the target QQ number.

nginx Reverse Proxy

If you have a domain name, you can refer to the following nginx configuration example for NapCatQQ:

CodeBlock Loading...

NoneBot

The documentation is already very comprehensive, so I won't elaborate further here.

Foreword

Recently I found that the WebUI of NapCatQQ has been improved, making it quite suitable for beginners, so I wrote this article.

Preparation

A server, whether internal or external network.
A QQ account to serve as the QQ bot; it is not recommended to use your main account.

NapCatQQ

Installation

BASH

docker run -d \
    -v /data/napcat/QQdata:/app/.config/QQ \      # QQ数据目录
    -v /data/napcat/logs:/app/napcat/logs \       # 日志目录
    -v /data/napcat/config:/app/napcat/config \   # 配置目录
    -v /etc/localtime:/etc/localtime:ro \
    --net=host \    # 建议使用host网络，以便连接后续的NoneBot
    --name napcat \
    --restart=always \
    mlikiowa/napcat-docker:latest

CodeBlock Loading...

Enable HTTP Protocol

After enabling, you can test it in Interface Debugging -> HTTP or with any API testing tool you are comfortable with. The API reference can be found at: https://napcat.apifox.cn/

There are two ways to use the Token:

Add Authorization: [Token] in the request header.

BASH

curl -X GET 'http://[IP]:3000/get_friend_list' -H 'Authorization: [Token]'

CodeBlock Loading...

Add ?access_token=[Token] in the URL.

BASH

curl -X GET 'http://[IP]:3000/get_friend_list?access_token=[Token]'

CodeBlock Loading...

Using Webhook for Notifications

BASH

curl -X POST 'http://[IP]:3000/send_private_msg' -H 'Content-Type: application/json' -H 'Authorization: [Token]' -d '{
  "user_id": "[TargetQQ]",
  "message": [
    {
      "type": "text",
      "data": {
        "text": "Hello World!"
      }
    },
    {
      "type": "face",
      "data": {
        "id": "63"
      }
    },
    {
      "type": "image",
      "data": {
        "file": "https://napneko.github.io/assets/newlogo.png"
      }
    }
  ]
}'

CodeBlock Loading...

Some applications use shoutrrr as the Webhook implementation, and you can refer to the following configuration:

generic://[IP]:3000/send_private_msg?access_token=[Token]&template=json&titleKey=user_id&messageKey=message&@Content-Type=application/json&$user_id=[TargetQQ]

CodeBlock Loading...

Some applications may already support the OneBot11 protocol; in that case, simply fill in http://[IP]:3000, the Token, and the target QQ number.

nginx Reverse Proxy

If you have a domain name, you can refer to the following nginx configuration example for NapCatQQ:

NGINX

server {
    listen 80;
    listen [::]:80;
    listen 443 ssl;
    listen [::]:443 ssl;
    server_name qq.example.cn;
    access_log /var/log/nginx/access.qq.log;
    error_log /var/log/nginx/error.qq.log;
    location /webui {
        proxy_pass http://127.0.0.1:6099$request_uri;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
    location /api {
        proxy_pass http://127.0.0.1:6099$request_uri;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
    location /files {
        proxy_pass http://127.0.0.1:6099$request_uri;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
    location / {
        if ($request_method = POST) {
            access_log /var/log/nginx/post.qq.log postdata;
        }
        proxy_pass http://127.0.0.1:3000$request_uri;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

CodeBlock Loading...

NoneBot

The documentation is already very comprehensive, so I won't elaborate further here.