WxPusher

https://wxpusher.zjiecode.com/docs/
Admin
WxPusher is a real-time message push platform that uses WeChat Official Accounts as a channel to...
Tokens:14,564
Snippets:127
Trust Score:3.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### HTML Copy Button Example

Source: https://wxpusher.zjiecode.com/docs

This example demonstrates how to create a copy button within an HTML message. The `data-clipboard-text` attribute specifies the content to be copied.

```html
<copy style="这里可以写复制按钮的style" data-clipboard-text="需要复制到剪贴板的内容">
      复制按钮的文字
</copy>

一个例子如下，style默认可以不写：
<copy data-clipboard-text="被复制的内容">
      复制
</copy>
```

--------------------------------

### Send Message (Simple Push - GET)

Source: https://wxpusher.zjiecode.com/docs

Send a message using the simplified push method by directly requesting a URL with your SPT and message content.

```APIDOC
## GET /api/send/message/{spt}/{content}

### Description
Send a message using the simplified push method by directly requesting a URL with your SPT and message content.

### Method
GET

### Endpoint
https://wxpusher.zjiecode.com/api/send/message/{spt}/{content}

### Parameters
#### Path Parameters
- **spt** (string) - Required - Your Simple Push Token (SPT).
- **content** (string) - Required - The message content to send.

### Response
#### Success Response (200)
(Details not provided in source, typically a success indicator)

### Response Example
(Example not provided in source)
```

--------------------------------

### Send Message (GET)

Source: https://wxpusher.zjiecode.com/docs

A simplified GET endpoint for sending text messages. Primarily for convenience in certain scenarios.

```APIDOC
## GET /api/send/message

### Description
A simplified GET endpoint for sending text messages. Primarily for convenience in certain scenarios. Only supports text content (contentType=1).

### Method
GET

### Endpoint
https://wxpusher.zjiecode.com/api/send/message/

### Parameters
#### Query Parameters
- **appToken** (string) - Required - Your application's authentication token.
- **uid** (string) - Required - The user UID to send the message to. Only one UID is supported.
- **topicId** (integer) - Optional - The topic ID to send the message to. Only one topic ID is supported.
- **content** (string) - Required - The text message content. Must be URL-encoded.
- **url** (string) - Optional - A URL to link to. Must be URL-encoded.
- **verifyPayType** (integer) - Optional - Controls message delivery based on subscription status. 0: no verification, 1: send to paid users only, 2: send to unpaid or expired users only.

### Request Example
```
https://wxpusher.zjiecode.com/api/send/message/?appToken=AT_qHT0cTQfLwYOlBV9cJj9zDSyEmspsmyM&content=123&uid=c1BcpqxEbD8irqlGUh9BhOqR2BvH8yWZ&url=http%3a%2f%2fwxpusher.zjiecode.com
```

### Note
GET interface only supports sending to one uid or topicId. The POST interface is recommended.
```

--------------------------------

### Query User List V2 Response Example

Source: https://wxpusher.zjiecode.com/docs

This JSON structure represents the response when querying a list of users who have followed an application or topic. It includes pagination details and a list of user records with their subscription information.

```json
{
 "code": 1000,
 "msg": "处理成功",
 "data": {
     "total": 40,
     "page": 1,
     "pageSize": 20,
     "records": [
         {
             "uid": "UID_xxx",
             "appOrTopicId":111,
             "headImg": "",
             "createTime": 1603540859285,
             "nickName": "",
             "reject": false,
             "id": 47361,
             "type": 0,
             "target": "WxPusher官方",
             "payEndTime":0
         }
     ]
 },
 "success": true
}
```

--------------------------------

### Send SPT Message via GET

Source: https://wxpusher.zjiecode.com/docs/spt.html

Use this GET request to send a simple message using your SPT. Ensure both the SPT and message content are URL-encoded to prevent parsing issues.

```http
https://wxpusher.zjiecode.com/api/send/message/SPT_xxx/任务执行完成
```

--------------------------------

### Send Message via GET

Source: https://wxpusher.zjiecode.com/docs/spt.html

A simple GET request to send a message using SPT. The SPT token and message content should be URL-encoded.

```APIDOC
## GET /api/send/message/{spt}/{content}

### Description
Sends a simple text message to a specified SPT.

### Method
GET

### Endpoint
`https://wxpusher.zjiecode.com/api/send/message/{spt}/{content}`

### Parameters
#### Path Parameters
- **spt** (string) - Required - Your Simple Push Token (e.g., `SPT_xxx`).
- **content** (string) - Required - The message content to send. Should be URL-encoded.

### Request Example
`https://wxpusher.zjiecode.com/api/send/message/SPT_xxx/任务执行完成`

### Response
(Success response details not explicitly provided in source, but implies message delivery)
```

--------------------------------

### HMAC-SHA256 Signature Verification in Java

Source: https://wxpusher.zjiecode.com/docs

Example of how to verify the HMAC-SHA256 signature for incoming requests in Java. This is crucial for ensuring the authenticity and integrity of data when '验证密钥' is configured.

```java
String canonical = "nonce=" + nonce + "&sv=" + sv + "&ts=" + ts + "&uid=" + uid; 
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec(settingSignKey.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
byte[] bytes = mac.doFinal(canonical.getBytes(StandardCharsets.UTF_8));
StringBuilder sb = new StringBuilder();
for (byte b : bytes) sb.append(String.format("%02x", b));
String sign = sb.toString();
```

--------------------------------

### HMAC-SHA256 Signature Verification in Python

Source: https://wxpusher.zjiecode.com/docs

Example of how to verify the HMAC-SHA256 signature for incoming requests in Python. This is crucial for ensuring the authenticity and integrity of data when '验证密钥' is configured.

```python
import hmac, hashlib
canonical = f"nonce={nonce}&sv={sv}&ts={ts}&uid={uid}"
sign = hmac.new(settingSignKey.encode(), canonical.encode(), hashlib.sha256).hexdigest()
```

--------------------------------

### Payment Status Callback Example

Source: https://wxpusher.zjiecode.com/docs

This JSON structure represents a callback notification received when a user's payment or refund status changes. It includes details about the transaction, amount, and user.

```json
{
    "action":"order_pay",
    "data":{
        "addTime":86400000,
        "amount":50,
        "appId":30630,
        "createTime":1664118481675,
        "prodId":12,
        "tradeNo":"202209252308016755383125546",
        "type":1,
        "uid":"UID_xxxxxxx"
    }
}
```

--------------------------------

### HMAC-SHA256 Signature Verification in Node.js

Source: https://wxpusher.zjiecode.com/docs

Example of how to verify the HMAC-SHA256 signature for incoming requests in Node.js. This is crucial for ensuring the authenticity and integrity of data when '验证密钥' is configured.

```javascript
const crypto = require('crypto');
const canonical = `nonce=${nonce}&sv=${sv}&ts=${ts}&uid=${uid}`;
const sign = crypto.createHmac('sha256', settingSignKey).update(canonical).digest('hex');
```

--------------------------------

### Upstream Message Callback Example

Source: https://wxpusher.zjiecode.com/docs

This JSON structure is received when a user sends an upstream message to your WxPusher application. It contains the user's identifier, the application details, and the message content.

```json
{
    "action":"send_up_cmd",
    "data":{
        "uid":"UID_xxx",
        "appId":97,
        "appName":"WxPusher演示",
        "time":1603002697386,
        "content":"内容"
    }
}
```

--------------------------------

### Delete User Response Example

Source: https://wxpusher.zjiecode.com/docs

This JSON object indicates a successful deletion of a user's subscription to an application or topic. The 'data' field confirms the success message.

```json
{
    "code": 1000,
    "msg": "处理成功",
    "data": "删除成功",
    "success": true
}
```

--------------------------------

### Send Message (GET)

Source: https://wxpusher.zjiecode.com/docs

A simplified GET request for sending plain text messages. Content and URL parameters must be URL-encoded. This method only supports sending to a single UID or topicId.

```http
https://wxpusher.zjiecode.com/api/send/message/?appToken=AT_qHT0cTQfLwYOlBV9cJj9zDSyEmspsmyM&content=123&uid=c1BcpqxEbD8irqlGUh9BhOqR2BvH8yWZ&url=http%3a%2f%2fwxpusher.zjiecode.com
```

--------------------------------

### Query User UID by QR Code Scan

Source: https://wxpusher.zjiecode.com/docs

Retrieve the UID of the last user who scanned a parameter QR code. This GET request requires the `code` obtained from the 'Create Parameter QR Code' endpoint. Polling intervals must be at least 10 seconds, and continuous polling is prohibited to avoid account suspension.

```http
https://wxpusher.zjiecode.com/api/fun/scan-qrcode-uid?code=xxxxx
```

--------------------------------

### Query Message Status

Source: https://wxpusher.zjiecode.com/docs

Use this GET request to query the delivery status of a message using the `sendRecordId` obtained from the send message response. The cache for status information is 7 days.

```http
https://wxpusher.zjiecode.com/api/send/query/status?sendRecordId={sendRecordId}
```

--------------------------------

### 设置 WxPusher SPT 环境变量

Source: https://wxpusher.zjiecode.com/docs/qinglong-wxpusher-spt.html

在脚本中主动发送通知时，可以通过设置 `WXPUSHER_SPT_LIST` 环境变量来指定 SPT。

```shell
export WXPUSHER_SPT_LIST="SPT_xxxxxxxxxxxxxxxxx"
```

--------------------------------

### Create Parameter QR Code

Source: https://wxpusher.zjiecode.com/docs

Create a QR code that carries custom parameters, useful for identifying users who scan the code.

```APIDOC
## POST /api/fun/create/qrcode

### Description
Create a QR code that carries custom parameters. When a user scans this QR code, the parameters will be included in the callback.

### Method
POST

### Endpoint
https://wxpusher.zjiecode.com/api/fun/create/qrcode

### Parameters
#### Request Body
- **appToken** (string) - Required - Your application's authentication token.
- **extra** (string) - Required - Custom parameters to be carried by the QR code (max 64 characters).
- **validTime** (integer) - Optional - The validity period of the QR code in seconds. Defaults to 30 minutes (1800 seconds), maximum 30 days.

### Request Example
```json
{
    "appToken": "xxx",
    "extra": "xxx",
    "validTime": 1800
}
```
```

--------------------------------

### App Subscribe Callback

Source: https://wxpusher.zjiecode.com/docs

Callback triggered when a user subscribes to your application. WxPusher sends an HTTP POST request to your configured callback URL with user subscription details.

```APIDOC
## Callback: App Subscribe

### Description
Callback triggered when a user subscribes to your application. WxPusher sends an HTTP POST request to your configured callback URL with user subscription details.

### Method
POST

### Endpoint
(Your configured callback URL)

### Parameters
#### Request Body
- **action** (string) - The action type, `app_subscribe` indicates a user subscribed to an app.
- **data** (object) - Subscription details.
  - **appId** (integer) - The ID of the subscribed application.
  - **appKey** (string) - The appKey of the subscribed application (deprecated, do not use).
  - **appName** (string) - The name of the subscribed application.
  - **source** (string) - The channel through which the user subscribed: `scan` (QR code scan), `link` (link subscription), `command` (via message command), etc.
  - **userName** (string) - User's nickname (new WeChat users may not return this, forced to return empty).
  - **userHeadImg** (string) - User's avatar URL (new WeChat users may not return this, forced to return empty).
  - **time** (integer) - Timestamp of when the subscription occurred.
  - **uid** (string) - The user's UID.
  - **extra** (string) - Parameters carried by a QR code when scanned; empty for default QR codes.

### Response Example
```json
{
  "action":"app_subscribe",
  "data":{
      "appId":123,
      "appKey":"AK_xxxxxx",
      "appName":"应用名字",
      "source":"scan",
      "userName":"",
      "userHeadImg":"",
      "time":1569416451573,
      "uid":"UID_xxxxxx",
      "extra":"xxx"
  }
}
```
```

--------------------------------

### Send Message (Simple Push - POST)

Source: https://wxpusher.zjiecode.com/docs

Send a message using the simplified push method via a POST request with a JSON body containing message details.

```APIDOC
## POST /api/send/message/simple-push

### Description
Send a message using the simplified push method via a POST request with a JSON body containing message details.

### Method
POST

### Endpoint
https://wxpusher.zjiecode.com/api/send/message/simple-push

### Parameters
#### Request Body
- **content** (string) - Required - The message content, HTML is recommended.
- **summary** (string) - Optional - Message summary, max 100 characters. Defaults to a truncated version of `content`.
- **contentType** (integer) - Optional - Content type: `1` for text, `2` for HTML (recommended, only body content needed), `3` for Markdown.
- **spt** (string) - Optional - The SPT to send the message to (for a single recipient).
- **sptList** (array of strings) - Optional - A list of SPTs to send the message to (max 10 recipients).
- **url** (string) - Optional - A URL link associated with the message.

### Request Example
```json
{
    "content":"<h1>极简推送</h1><br/><p style=\"color:red;\">欢迎你使用WxPusher，推荐使用HTML发送</p>",
    "summary":"消息摘要",
    "contentType":2,
    "spt":"SPT_xx1",
    "sptList":["SPT_xx1","SPT_xx2"],
    "url":"https://wxpusher.zjiecode.com"
}
```

### Response
#### Success Response (200)
(Details not provided in source, typically a success indicator)

### Response Example
(Example not provided in source)
```

--------------------------------

### Send Message (POST)

Source: https://wxpusher.zjiecode.com/docs

Send messages to users or topics. Supports text, HTML, and Markdown content types. Recommended for full functionality.

```APIDOC
## POST /api/send/message

### Description
Send messages to users or topics. Supports text, HTML, and Markdown content types. Recommended for full functionality.

### Method
POST

### Endpoint
https://wxpusher.zjiecode.com/api/send/message

### Parameters
#### Request Body
- **appToken** (string) - Required - Your application's authentication token.
- **content** (string) - Required - The message content. Supports HTML, text, and Markdown based on `contentType`.
- **summary** (string) - Optional - A short summary of the message, used for notifications. Defaults to a truncated version of `content`.
- **contentType** (integer) - Optional - The type of content. 1: text, 2: html (recommended), 3: markdown. Defaults to 1.
- **topicIds** (array) - Optional - An array of topic IDs to send the message to (for group sending).
- **uids** (array) - Optional - An array of user UIDs to send the message to (for single sending).
- **url** (string) - Optional - A URL to link to, often used with HTML content.
- **verifyPay** (boolean) - Optional - Deprecated. Use `verifyPayType` instead.
- **verifyPayType** (integer) - Optional - Controls message delivery based on subscription status. 0: no verification, 1: send to paid users only, 2: send to unpaid or expired users only.

### Request Example
```json
{
  "appToken": "AT_xxx",
  "content": "<h1>H1标题</h1><br/><p style=\"color:red;\">欢迎你使用WxPusher，推荐使用HTML发送</p>",
  "summary": "消息摘要",
  "contentType": 2,
  "topicIds": [
    123
  ],
  "uids": [
    "UID_xxxx"
  ],
  "url": "https://wxpusher.zjiecode.com",
  "verifyPay": false,
  "verifyPayType": 0
}
```

### Response
#### Success Response (200)
- **code** (integer) - Status code. 1000 indicates success.
- **msg** (string) - Processing message.
- **data** (array) - Array of send status for each UID/topicId.
  - **uid** (string) - User UID.
  - **topicId** (integer) - Topic ID.
  - **messageId** (integer) - Deprecated.
  - **messageContentId** (integer) - ID for the message content, can be used to delete the message.
  - **sendRecordId** (integer) - ID for the message send record, used for querying status.
  - **code** (integer) - Send status code for this recipient. 1000 indicates success.
  - **status** (string) - Status message for this recipient.
- **success** (boolean) - Indicates if the overall operation was successful.

#### Response Example
```json
{
    "code": 1000,
    "msg": "处理成功",
    "data": [
        {
            "uid": "UID_xxx",
            "topicId": null,
            "messageId": 121,
            "messageContentId": 2123,
            "sendRecordId": 12313,
            "code": 1000,
            "status": "创建发送任务成功"
        }
    ],
    "success": true
}
```
```

--------------------------------

### User Subscription Callback Data

Source: https://wxpusher.zjiecode.com/docs

This JSON structure is sent to your specified callback URL when a user subscribes to your application. It provides details about the user and the subscription event.

```json
{
  "action":"app_subscribe",
  "data":{
      "appId":123,
      "appKey":"AK_xxxxxx", 
      "appName":"应用名字",
      "source":"scan", 
      "userName":"", 
      "userHeadImg":"",
      "time":1569416451573, 
      "uid":"UID_xxxxxx", 
      "extra":"xxx"    
  }
}
```

--------------------------------

### Create Parameter QR Code

Source: https://wxpusher.zjiecode.com/docs

Generate a QR code with custom parameters using this POST request. The `extra` field can carry up to 64 characters of custom data, which will be included in the callback when the user scans the code. The `validTime` parameter sets the QR code's expiration.

```json
{
    "appToken":"xxx",   //必填，appToken,前面有说明，应用的标志
    "extra":"xxx",      //必填，二维码携带的参数，最长64位
    "validTime":1800    //可选，二维码的有效期，默认30分钟，最长30天，单位是秒
}
```

--------------------------------

### Query User Subscription Expiry Time

Source: https://wxpusher.zjiecode.com/docs

This API retrieves the subscription expiry time for a user on a specific product resource. It's used to verify if a user is within their paid subscription period.

```HTTP
GET https://wxpusher.zjiecode.com/api/product/query-pay-end-time?uid={uid}&prodId={产品id}
```

--------------------------------

### Response for Querying User Subscription Expiry Time

Source: https://wxpusher.zjiecode.com/docs

This JSON structure represents the response from the query-pay-end-time API, detailing the resource type, resource ID, and the user's payment subscription end time in milliseconds.

```JSON
{
    "code": 1000,
    "msg": "处理成功",
    "data": [
        {
            "resourceType": 2, //资源类型，1对1uid发送的应用为1，群发主题为2
            "resourceID": 123, //应用id或者主题id
            "payEndTime": 1737560859272 //用户付费订阅到期时间，毫秒级的时间戳
        }
    ],
    "success": true
}
```

--------------------------------

### Send Message (POST)

Source: https://wxpusher.zjiecode.com/docs

Use this POST request for full-featured message sending. It supports HTML, markdown, and plain text. Ensure to remove comments from the JSON payload before sending. The 'contentType' field determines the message format.

```json
{
  "appToken":"AT_xxx",//必传
  "content":"<h1>H1标题</h1><br/><p style=\"color:red;\">欢迎你使用WxPusher，推荐使用HTML发送</p>",//必传
  //消息摘要；接口侧最长100，可以不传，不传默认截取 content 前面内容。各端通知/卡片实际展示可能更短（如部分场景约20字）。
  "summary":"消息摘要",
  //内容类型 1表示文字  2表示html(只发送body标签内部的数据即可，不包括body标签，推荐使用这种) 3表示markdown 
  "contentType":2,
  //发送目标的topicId，是一个数组！！！，也就是群发，使用uids单发的时候， 可以不传。
  "topicIds":[
      123
  ],
  //发送目标的UID，是一个数组。注意uids和topicIds可以同时填写，也可以只填写一个。
  "uids":[
      "UID_xxxx"
  ],
  //原文链接，可选参数
  "url":"https://wxpusher.zjiecode.com", 
  //是否验证订阅时间，true表示只推送给付费订阅用户，false表示推送的时候，不验证付费，不验证用户订阅到期时间，用户订阅过期了，也能收到。
  //verifyPay字段即将被废弃，请使用verifyPayType字段，传verifyPayType会忽略verifyPay
  "verifyPay":false,
  //是否验证订阅时间，0：不验证，1:只发送给付费的用户，2:只发送给未订阅或者订阅过期的用户
  "verifyPayType":0
}
```

--------------------------------

### Query Scan User UID

Source: https://wxpusher.zjiecode.com/docs

Query the UID of the user who last scanned a parameter QR code.

```APIDOC
## GET /api/fun/scan-qrcode-uid

### Description
Query the UID of the user who last scanned a parameter QR code. This is an alternative to using callbacks for simple scenarios or client-side applications.

### Method
GET

### Endpoint
https://wxpusher.zjiecode.com/api/fun/scan-qrcode-uid

### Parameters
#### Query Parameters
- **code** (string) - Required - The `code` parameter returned from the Create Parameter QR Code interface.

### Request Example
```
https://wxpusher.zjiecode.com/api/fun/scan-qrcode-uid?code=xxxxx
```

### Note
Polling interval must be at least 10 seconds. Do not use infinite loops. Stop polling when the user exits. Failure to comply may result in account suspension.
```

--------------------------------

### Configure Multiple SPTs for MoviePilot

Source: https://wxpusher.zjiecode.com/docs/moviepilot-wxpusher-spt.html

When notifying a small number of family members, you can use a comma-separated list of SPTs. This method supports up to 10 SPTs per notification.

```text
SPT_xxx1,SPT_xxx2,SPT_xxx3
```

--------------------------------

### Query Pay End Time

Source: https://wxpusher.zjiecode.com/docs

This endpoint allows you to query the subscription expiration time for a user on a specific product. It's useful for verifying if a user has an active paid subscription.

```APIDOC
## Query Pay End Time

### Description
Queries the expiration time of a user's subscription for a given product. This is essential for verifying active paid subscriptions.

### Method
GET

### Endpoint
https://wxpusher.zjiecode.com/api/product/query-pay-end-time?uid={uid}&prodId={prodId}

### Parameters
#### Path Parameters
None

#### Query Parameters
- **uid** (string) - Required - The user's unique identifier.
- **prodId** (string) - Required - The product's unique identifier. Note that the ID is case-sensitive.

### Request Example
None provided in source.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response. 1000 indicates success.
- **msg** (string) - A message describing the result of the operation.
- **data** (array) - An array of objects, each containing resource details and payment end time.
  - **resourceType** (integer) - The type of resource. 1 for 1-on-1 application, 2 for broadcast topic.
  - **resourceID** (integer) - The ID of the application or topic.
  - **payEndTime** (integer) - The user's paid subscription expiration time, in milliseconds (timestamp).
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
    "code": 1000,
    "msg": "处理成功",
    "data": [
        {
            "resourceType": 2,
            "resourceID": 123,
            "payEndTime": 1737560859272
        }
    ],
    "success": true
}
```
```

--------------------------------

### Send Message

Source: https://wxpusher.zjiecode.com/docs/api-reference.html

Send a message to specified users or topics. The request type is application/json. Supports text, HTML, and Markdown content types.

```APIDOC
## POST /api/send/message

### Description
Sends a message to specified recipients. Supports single user (UID) or group (Topic) messaging.

### Method
POST

### Endpoint
https://wxpusher.zjiecode.com/api/send/message

### Parameters
#### Request Body
- **appToken** (string) - Required - Application authentication key.
- **content** (string) - Required - The message body.
- **contentType** (integer) - Required - Type of content: 1 for text, 2 for HTML, 3 for Markdown.
- **uids** (array of string) - Optional - Array of recipient user UIDs for direct or batch sending.
- **topicIds** (array of integer) - Optional - Array of topic IDs for group sending. Can be used with `uids`.
- **summary** (string) - Optional - Notification summary, max 100 characters.
- **url** (string) - Optional - Link to the original message content.

### Request Example
```json
{
  "appToken": "AT_xxx",
  "content": "服务器 CPU 使用率超过 90%",
  "summary": "服务器告警",
  "contentType": 1,
  "uids": ["UID_xxx"]
}
```

### Response
#### Success Response (200)
- **code** (integer) - Business response code. 1000 indicates success.
- **message** (string) - Response message.
- **data** (object) - Contains sending record details.
  - **sendRecordId** (string) - ID for tracking the sending status of individual recipients.
  - **messageContentId** (string) - ID for deleting message landing page content.

#### Response Example
```json
{
  "code": 1000,
  "message": "OK",
  "data": {
    "sendRecordId": "SR_xxx",
    "messageContentId": "MC_xxx"
  }
}
```
```

--------------------------------

### Send Message via POST

Source: https://wxpusher.zjiecode.com/docs/spt.html

A POST request to send a message using SPT, supporting additional fields like summary and content type.

```APIDOC
## POST /api/send/message/simple-push

### Description
Sends a message using SPT with support for more detailed message fields.

### Method
POST

### Endpoint
`https://wxpusher.zjiecode.com/api/send/message/simple-push`

### Parameters
#### Request Body
- **spt** (string) - Required - Your Simple Push Token (e.g., `SPT_xxx`).
- **content** (string) - Required - The main message content.
- **summary** (string) - Optional - A brief summary or title for the message.
- **contentType** (integer) - Optional - The type of content (e.g., 1 for text). Default is text.

### Request Example
```json
{
  "content": "备份任务执行完成",
  "summary": "任务通知",
  "contentType": 1,
  "spt": "SPT_xxx"
}
```

### Response
(Success response details not explicitly provided in source, but implies message delivery)
```

--------------------------------

### Query User List V2

Source: https://wxpusher.zjiecode.com/docs

Retrieve a paginated list of users who have subscribed to your App or topics. Note that a single WeChat user may appear multiple times if they subscribe to both the app and topics.

```APIDOC
## GET /api/fun/wxuser/v2

### Description
Retrieve a paginated list of users who have subscribed to your App or topics. A single WeChat user may appear multiple times if they subscribe to both the app and topics.

### Method
GET

### Endpoint
https://wxpusher.zjiecode.com/api/fun/wxuser/v2

### Parameters
#### Query Parameters
- **appToken** (string) - Required - Application secret key identifier.
- **page** (integer) - Required - The page number for requesting data.
- **pageSize** (integer) - Required - The page size, cannot exceed 100.
- **uid** (string) - Optional - The user's UID. If not provided, all users are queried. If a UID is provided, information for that specific user is queried.
- **isBlock** (boolean) - Optional - Query for blocked users. If not provided, all users are queried. `true` queries blocked users, `false` queries non-blocked users.
- **type** (integer) - Optional - Subscription type. If not provided, all users are queried. `0` for App subscriptions, `1` for topic subscriptions.

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **msg** (string) - Response message.
- **data** (object) - Response data.
  - **total** (integer) - Total number of users.
  - **page** (integer) - Current page number.
  - **pageSize** (integer) - Page size.
  - **records** (array) - List of user records.
    - **uid** (string) - User's UID.
    - **appOrTopicId** (integer) - The ID of the subscribed app or topic, determined by the `type` parameter.
    - **headImg** (string) - User's avatar URL (new WeChat users may not return this, forced to return empty).
    - **createTime** (integer) - Timestamp of when the user subscribed.
    - **nickName** (string) - User's nickname (new WeChat users may not return this, forced to return empty).
    - **reject** (boolean) - Indicates if the user is blocked.
    - **id** (integer) - The ID required for delete or block operations.
    - **type** (integer) - Subscription type: `0` for App, `1` for topic.
    - **target** (string) - The name of the subscribed app or topic.
    - **payEndTime** (integer) - `0` if the user is not a paid subscriber, otherwise it's the expiration timestamp in milliseconds.

### Response Example
```json
{
 "code": 1000,
 "msg": "处理成功",
 "data": {
     "total": 40,
     "page": 1,
     "pageSize": 20,
     "records": [
         {
             "uid": "UID_xxx",
             "appOrTopicId":111,
             "headImg": "",
             "createTime": 1603540859285,
             "nickName": "",
             "reject": false,
             "id": 47361,
             "type": 0,
             "target": "WxPusher官方",
             "payEndTime":0
         }
     ]
 },
 "success": true
}
```
```

--------------------------------

### Send a Text Message

Source: https://wxpusher.zjiecode.com/docs/api-reference.html

Use this snippet to send a text message to one or more users. Ensure you have your appToken and the recipient's UID. The `contentType` is set to 1 for text.

```curl
curl -X POST https://wxpusher.zjiecode.com/api/send/message \
  -H 'Content-Type: application/json' \
  -d '{
    "appToken": "AT_xxx",
    "content": "服务器 CPU 使用率超过 90%",
    "summary": "服务器告警",
    "contentType": 1,
    "uids": ["UID_xxx"]
  }'
```

--------------------------------

### Send SPT Message via POST

Source: https://wxpusher.zjiecode.com/docs/spt.html

This POST request allows sending messages with more fields, including content, summary, and content type, using your SPT. It's suitable for richer notifications.

```curl
curl -X POST https://wxpusher.zjiecode.com/api/send/message/simple-push \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "备份任务执行完成",
    "summary": "任务通知",
    "contentType": 1,
    "spt": "SPT_xxx"
  }'
```

--------------------------------

### Block User

Source: https://wxpusher.zjiecode.com/docs

Block a user, preventing them from sending messages and re-subscribing unless unblocked. Blocking a user negates the need for the delete operation.

```APIDOC
## PUT /api/fun/reject

### Description
Block a user, preventing them from sending messages and re-subscribing unless unblocked. Blocking a user negates the need for the delete operation.

### Method
PUT

### Endpoint
https://wxpusher.zjiecode.com/api/fun/reject

### Parameters
#### Query Parameters
- **appToken** (string) - Required - Application secret key identifier.
- **id** (integer) - Required - The user ID, obtainable from the user query interface.
- **reject** (boolean) - Required - `true` to block the user, `false` to unblock.

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **msg** (string) - Response message.
- **data** (string) - Confirmation message, e.g., "删除成功".
- **success** (boolean) - Indicates if the operation was successful.

### Response Example
```json
{
    "code": 1000,
    "msg": "处理成功",
    "data": "删除成功",
    "success": true
}
```
```

--------------------------------

### Send Simple Message POST Request Body

Source: https://wxpusher.zjiecode.com/docs

This JSON payload is used for sending messages via the simplified push method. It supports various content types and can target single or multiple recipients using SPTs.

```json
{
    "content":"<h1>极简推送</h1><br/><p style=\"color:red;\">欢迎你使用WxPusher，推荐使用HTML发送</p>",
    "summary":"消息摘要",
    "contentType":2,
    "spt":"SPT_xx1",
    "sptList":["SPT_xx1","SPT_xx2"],
    "url":"https://wxpusher.zjiecode.com"
}
```

--------------------------------

### Delete Message

Source: https://wxpusher.zjiecode.com/docs

This DELETE request allows you to remove a message using its `messageContentId` and your `appToken`. Note that this only deletes the landing page content; messages already delivered to users cannot be removed.

```http
https://wxpusher.zjiecode.com/api/send/message?messageContentId=${messageContentId}&appToken=${appToken}
```

--------------------------------

### Delete User Subscription

Source: https://wxpusher.zjiecode.com/docs

Delete a user's subscription to an App or topic. After deletion, the user can re-subscribe. If you do not want the user to re-subscribe, use the block user interface.

```APIDOC
## DELETE /api/fun/remove

### Description
Delete a user's subscription to an App or topic. After deletion, the user can re-subscribe. If you do not want the user to re-subscribe, use the block user interface.

### Method
DELETE

### Endpoint
https://wxpusher.zjiecode.com/api/fun/remove

### Parameters
#### Query Parameters
- **appToken** (string) - Required - Application secret key identifier.
- **id** (integer) - Required - The user ID, obtainable from the user query interface.

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **msg** (string) - Response message.
- **data** (string) - Confirmation message, e.g., "删除成功".
- **success** (boolean) - Indicates if the operation was successful.

### Response Example
```json
{
    "code": 1000,
    "msg": "处理成功",
    "data": "删除成功",
    "success": true
}
```
```

--------------------------------

### Send Message Response Structure

Source: https://wxpusher.zjiecode.com/docs

This JSON structure represents the response from the message sending API. It includes status codes, messages, and detailed send status for each recipient.

```json
{
    "code": 1000, //状态码，非1000表示有异常
    "msg": "处理成功",//提示消息
    "data": [
        {
            "uid": "UID_xxx",//用户uid
            "topicId": null, //主题ID
            "messageId": 121,//废弃⚠️，请不要再使用，后续会删除这个字段
            "messageContentId": 2123,//消息内容id，调用一次接口，生成一个，你可以通过此id调用删除消息接口，删除消息。本次发送的所有用户共享此消息内容。
            "sendRecordId": 12313,//消息发送id，每个uid用户或者topicId生成一个，可以通过这个id查询对某个用户的发送状态
            "code": 1000, //1000表示发送成功
            "status": "创建发送任务成功"
        }
    ],
    "success": true
}
```

--------------------------------

### Query Message Status

Source: https://wxpusher.zjiecode.com/docs

Query the sending status of a message using its sendRecordId.

```APIDOC
## GET /api/send/query/status

### Description
Query the sending status of a message using its sendRecordId. Message cache is valid for 7 days.

### Method
GET

### Endpoint
https://wxpusher.zjiecode.com/api/send/query/status

### Parameters
#### Query Parameters
- **sendRecordId** (string) - Required - The send record ID returned from the message sending interface.

### Note
Querying messages older than 7 days may result in 'message not found'.
```

--------------------------------

### Delete Message

Source: https://wxpusher.zjiecode.com/docs

Delete a message using its messageContentId. This only affects the landing page content, not messages already delivered to users.

```APIDOC
## DELETE /api/send/message

### Description
Delete a message using its messageContentId. This only affects the landing page content, not messages already delivered to users.

### Method
DELETE

### Endpoint
https://wxpusher.zjiecode.com/api/send/message

### Parameters
#### Query Parameters
- **messageContentId** (string) - Required - The message content ID returned from the send message interface. All users sharing this ID will have the message content deleted.
- **appToken** (string) - Required - Your application's authentication token.

### Note
Once deleted, users will no longer be able to view the message content via the landing page.
```
Tokens:
Raw