NapCat

https://napcat.apifox.cn/
Admin
NapCat provides an API documentation for interacting with various QQ features, including account...
Tokens:142,682
Snippets:282
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET Version Information

Source: https://napcat.apifox.cn/226657087e0

Retrieves the current version information of the application, including protocol version and app version.

```APIDOC
## POST /get_version_info

### Description
Retrieves the current version information of the application.

### Method
POST

### Endpoint
/get_version_info

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This endpoint does not require a request body.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request, expected to be 'ok'.
- **retcode** (number) - The return code for the operation.
- **data** (object) - An object containing version details.
  - **app_name** (string) - The name of the application.
  - **protocol_version** (string) - The version of the communication protocol.
  - **app_version** (string) - The version of the application.
- **message** (string) - A message describing the result of the operation.
- **wording** (string) - Additional wording or explanation.
- **echo** (string) - An echo of the request or a related identifier.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "app_name": "Napcat",
    "protocol_version": "1.0.0",
    "app_version": "2.3.1"
  },
  "message": "Success",
  "wording": "Version information retrieved successfully.",
  "echo": ""
}
```
```

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

### OpenAPI Specification for Mini App Ark Endpoint

Source: https://napcat.apifox.cn/227738594e0

This OpenAPI 3.0.1 specification defines the POST endpoint /get_mini_app_ark. It details the request body, which accepts either a 'bili' or 'weibo' type, or a more generic object with specific fields for constructing mini-app cards. It outlines required parameters, optional fields, and example request data. The response is a JSON object.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /get_mini_app_ark:
    post:
      summary: 获取小程序卡片
      deprecated: false
      description: ''
      tags:
        - 账号相关
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      description: 类型
                      enum:
                        - bili
                        - weibo
                      x-apifox-enum:
                        - value: bili
                          name: 哔哩哔哩
                          description: ''
                        - value: weibo
                          name: 微博
                          description: ''
                    title:
                      type: string
                      description: 标题
                    desc:
                      type: string
                      description: 描述
                    picUrl:
                      type: string
                      description: 图片URL
                    jumpUrl:
                      type: string
                      description: 跳转URL
                    webUrl:
                      type: string
                      description: 网页URL
                    rawArkData:
                      type: boolean
                      description: 是否返回原始ark数据
                      default: false
                  x-apifox-orders:
                    - type
                    - title
                    - desc
                    - picUrl
                    - jumpUrl
                    - webUrl
                    - rawArkData
                  required:
                    - type
                    - jumpUrl
                    - picUrl
                    - desc
                    - title
                  x-apifox-ignore-properties: []
                - type: object
                  properties:
                    title:
                      type: string
                      description: 标题
                    desc:
                      type: string
                      description: 描述
                    picUrl:
                      type: string
                      description: 图片URL
                    jumpUrl:
                      type: string
                      description: 跳转URL
                    iconUrl:
                      type: string
                      description: 图标URL
                    webUrl:
                      type: string
                      description: 网页URL
                    appId:
                      type: string
                      description: 应用ID
                    scene:
                      $ref: '#/components/schemas/number%20%7C%20string'
                      description: 场景
                    templateType:
                      $ref: '#/components/schemas/number%20%7C%20string'
                    businessType:
                      $ref: '#/components/schemas/number%20%7C%20string'
                    verType:
                      $ref: '#/components/schemas/number%20%7C%20string'
                    shareType:
                      $ref: '#/components/schemas/number%20%7C%20string'
                    versionId:
                      type: string
                      description: 版本ID
                    sdkId:
                      type: string
                      description: SDK ID
                    withShareTicket:
                      $ref: '#/components/schemas/number%20%7C%20string'
                    rawArkData:
                      type: boolean
                      description: 是否返回原始ark数据
                      default: false
                  x-apifox-orders:
                    - title
                    - desc
                    - picUrl
                    - jumpUrl
                    - iconUrl
                    - webUrl
                    - appId
                    - scene
                    - templateType
                    - businessType
                    - verType
                    - shareType
                    - versionId
                    - sdkId
                    - withShareTicket
                    - rawArkData
                  required:
                    - title
                    - withShareTicket
                    - sdkId
                    - versionId
                    - appId
                    - iconUrl
                    - jumpUrl
                    - picUrl
                    - desc
                    - shareType
                    - verType
                    - businessType
                    - templateType
                    - scene
                  x-apifox-ignore-properties: []
            example:
              type: bili
              title: 拾雪的一天
              desc: vlog记录一天的生活
              picUrl: >-
                https://thirdqq.qlogo.cn/g?b=oidb&k=09ElpZZZUTHFhoIlvs0lFg&kti=ZyBvjxHhVOI&s=640
              jumpUrl: pages/video/video?bvid=BV1GJ411x7h7/
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                x-apifox-refs:

```

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

### Send Message Request Example (YAML)

Source: https://napcat.apifox.cn/226656652e0

This snippet demonstrates an example request body for the `/send_msg` endpoint in YAML format. It shows how to specify message type (private or group), recipient IDs, and the message content, which can be a text message.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /send_msg:
    post:
      summary: send_msg
      deprecated: false
      description: ''
      tags:
        - 其他/保留
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message_type:
                  oneOf:
                    - type: string
                      const: group
                    - type: string
                      const: private
                group_id:
                  $ref: '#/components/schemas/group_id'
                user_id:
                  $ref: '#/components/schemas/user_id'
                message:
                  type: array
                  items:
                    anyOf:
                      - $ref: >-
                          #/components/schemas/%E6%96%87%E6%9C%AC%E6%B6%88%E6%81%AF
                      - $ref: >-
                          #/components/schemas/%E8%89%BE%E7%89%B9%E6%B6%88%E6%81%AF
                      - $ref: >-
                          #/components/schemas/%E8%A1%A8%E6%83%85%E6%B6%88%E6%81%AF
                      - $ref: >-
                          #/components/schemas/%E5%9B%BE%E7%89%87%E6%B6%88%E6%81%AF
                      - $ref: >-
                          #/components/schemas/%E5%9B%9E%E5%A4%8D%E6%B6%88%E6%81%AF
                      - $ref: '#/components/schemas/JSON%E6%B6%88%E6%81%AF'
                      - $ref: >-
                          #/components/schemas/%E8%AF%AD%E9%9F%B3%E6%B6%88%E6%81%AF
                      - $ref: >-
                          #/components/schemas/%E8%A7%86%E9%A2%91%E6%B6%88%E6%81%AF
                      - $ref: '#/components/schemas/markdown%E6%B6%88%E6%81%AF'
              x-apifox-orders:
                - message_type
                - group_id
                - user_id
                - message
              required:
                - group_id
                - message
                - message_type
                - user_id
              x-apifox-ignore-properties: []
            example: "{\r\n    \"message_type\": \"private\", //group | private\r\n    \"group_id\": \"480972475\",\r\n    \"user_id\": \"480972475\", // type为group时不填写\r\n    \"message\": [\r\n        {\r\n            \"type\": \"text\",\r\n            \"data\": {\r\n                \"text\": \"用面才务。定比眼表县。写单写加很研科。打王运土照。化知金步家你龙。全展标新。\"\r\n            }\r\n        }\r\n    ]\r\n}"
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                x-apifox-refs:
                  01JB1Q69T4RDCE649BD88FSA0R:
                    $ref: '#/components/schemas/result'
                    x-apifox-overrides:
                      data:
                        type: object
                        properties:
                          message_id: &ref_0
                            type: number
                            title: 消息ID
                            description: 消息ID
                        x-apifox-orders: &ref_1
                          - message_id
                        required:
                          - message_id
                    required:
                      - data
                x-apifox-orders:
                  - 01JB1Q69T4RDCE649BD88FSA0R
                properties:
                  status:
                    type: string
                    const: ok
                  retcode:
                    type: number
                  data:
                    type: object
                    properties:
                      message_id: *ref_0
                    x-apifox-orders: *ref_1
                    required:
                      - message_id
                    x-apifox-ignore-properties: []
                  message:
                    type: string
                  wording:
                    type: string
                  echo:
                    type: string
                    nullable: true
                required:
                  - status
                  - retcode
                  - data
                  - message
                  - wording
                  - echo
                x-apifox-ignore-properties:
                  - status
                  - retcode
                  - data
                  - message
                  - wording
                  - echo
          headers: {}
          x-apifox-name: 成功
      security: []
      x-apifox-folder: 其他/保留
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/5348325/apis/api-226656652-run
components:
  schemas:
    markdown消息:
      type: object
      properties:
        type:
          type: string
          const: record
        data:
          type: object
          properties:
            content:
              type: string
          x-apifox-orders:

```

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

### POST /create_collection

Source: https://napcat.apifox.cn/226659178e0

This endpoint allows users to create a new collection. It requires 'rawData' and 'brief' as parameters in the request body.

```APIDOC
## POST /create_collection

### Description
This endpoint allows users to create a new collection. It requires 'rawData' and 'brief' as parameters in the request body.

### Method
POST

### Endpoint
/create_collection

### Parameters
#### Request Body
- **rawData** (string) - Required - Content
- **brief** (string) - Required - Title

### Request Example
```json
{
  "rawData": "http://localhost:2017/",
  "brief": "123"
}
```

### Response
#### Success Response (200)
- **status** (string) - ok
- **retcode** (number) - API return code
- **data** (object) - Data returned by the API
- **message** (string) - Message returned by the API
- **wording** (string) - Wording returned by the API
- **echo** (string) - Echo returned by the API

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "result": 0,
    "errMsg": ""
  },
  "message": "",
  "wording": "",
  "echo": ""
}
```
```

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

### POST /.handle_quick_operation

Source: https://napcat.apifox.cn/226658889e0

This endpoint allows for performing quick operations on events. It takes event data and an operation object as input.

```APIDOC
## POST /.handle_quick_operation

### Description
Performs quick operations on events. This is equivalent to an HTTP quick operation.

### Method
POST

### Endpoint
/.handle_quick_operation

### Parameters
#### Request Body
- **context** (object) - Required - Event data object.
- **operation** (object) - Required - Quick operation object.

### Request Example
```json
{
  "context": {},
  "operation": {}
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation (e.g., "ok").
- **retcode** (number) - The return code of the operation.
- **data** (object | null) - The data returned by the operation.
- **message** (string) - A message describing the result of the operation.
- **wording** (string) - Wording related to the operation result.
- **echo** (string) - Echoed value from the request.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": null,
  "message": "Operation successful",
  "wording": "Success",
  "echo": ""
}
```
```

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

### Get Sticker Details API

Source: https://napcat.apifox.cn/54406081f0

Retrieves detailed information about a specific sticker.

```APIDOC
## GET /api/stickers/{stickerId}

### Description
Fetches detailed information about a specific sticker.

### Method
GET

### Endpoint
/api/stickers/{stickerId}

### Parameters
#### Path Parameters
- **stickerId** (string) - Required - The ID of the sticker.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **stickerId** (string) - The ID of the sticker.
- **name** (string) - The name of the sticker.
- **imageUrl** (string) - The URL of the sticker image.

#### Response Example
```json
{
  "stickerId": "sticker123",
  "name": "Happy Face",
  "imageUrl": "https://example.com/stickers/happy.png"
}
```
```

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

### Online Client Management APIs

Source: https://napcat.apifox.cn/54405734f0

APIs for managing and querying online client devices.

```APIDOC
## GET /api/clients/online

### Description
Gets the list of online client devices for the current account.

### Method
GET

### Endpoint
/api/clients/online

### Response
#### Success Response (200)
- **clients** (array) - A list of online client objects.
  - **client_id** (string) - The unique identifier for the client.
  - **device_type** (string) - The type of device (e.g., 'pc', 'mobile').
  - **last_active** (string) - The timestamp of the last activity.

#### Response Example
{
  "clients": [
    {
      "client_id": "client_web_1",
      "device_type": "pc",
      "last_active": "2023-10-27T10:00:00Z"
    }
  ]
}

## GET /api/clients/online/models

### Description
Retrieves the online device models for the account.

### Method
GET

### Endpoint
/api/clients/online/models

### Response
#### Success Response (200)
- **models** (array) - A list of online device model names.

#### Response Example
{
  "models": [
    "Windows PC",
    "iPhone"
  ]
}

## POST /api/clients/online/model

### Description
Sets the online device model for the account.

### Method
POST

### Endpoint
/api/clients/online/model

### Parameters
#### Request Body
- **model_name** (string) - Required - The name of the device model to set.

### Request Example
{
  "model_name": "Android Phone"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
{
  "success": true
}
```

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

### Get Message Details API

Source: https://napcat.apifox.cn/54406081f0

Retrieves detailed information about a specific message.

```APIDOC
## GET /api/messages/{messageId}

### Description
Fetches detailed information about a specific message.

### Method
GET

### Endpoint
/api/messages/{messageId}

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the message to retrieve details for.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **messageId** (string) - The ID of the message.
- **senderId** (string) - The ID of the sender.
- **conversationId** (string) - The ID of the conversation.
- **type** (string) - The type of message (e.g., text, image).
- **content** (object) - The message content details.
- **timestamp** (string) - The time the message was sent.

#### Response Example
```json
{
  "messageId": "msg123",
  "senderId": "user456",
  "conversationId": "conv789",
  "type": "text",
  "content": {
    "text": "This is the message content."
  },
  "timestamp": "2023-10-27T11:00:00Z"
}
```
```

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

### System Operations APIs

Source: https://napcat.apifox.cn/index

APIs for system-level operations and information retrieval.

```APIDOC
## System Operations APIs

### Description
APIs for system-level operations and information retrieval.

### POST /api/get_robot_account_scope

#### Description
Retrieves the scope of robot accounts.

### POST /api/account_logout

#### Description
Logs out the account.

### POST /api/send_custom_packet

#### Description
Sends a custom packet.

### POST /api/get_packet_status

#### Description
Retrieves the status of a packet.

### POST /api/get_version_info

#### Description
Retrieves version information.
```

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

### GET /get_unidirectional_friend_list

Source: https://napcat.apifox.cn/266151878e0

Retrieves a list of unidirectional friends. This endpoint is currently under development.

```APIDOC
## POST /get_unidirectional_friend_list

### Description
Retrieves a list of unidirectional friends. This endpoint is currently under development.

### Method
POST

### Endpoint
/get_unidirectional_friend_list

### Parameters

#### Query Parameters
None

#### Request Body
This endpoint does not require a request body.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation, expected to be 'ok'.
- **retcode** (number) - The return code for the operation.
- **data** (array) - A list of unidirectional friend objects.
  - **uin** (number) - The unique identifier for the friend.
  - **uid** (string) - The user ID of the friend.
  - **nick_name** (string) - The nickname of the friend.
  - **age** (number) - The age of the friend.
  - **source** (string) - The source of the friend connection.
- **message** (string) - A message describing the result of the operation.
- **wording** (string) - A human-readable description of the result.
- **echo** (string) - An optional echo field.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": [
    {
      "uin": 123456789,
      "uid": "user123",
      "nick_name": "Friend One",
      "age": 30,
      "source": "added"
    },
    {
      "uin": 987654321,
      "uid": "user456",
      "nick_name": "Friend Two",
      "age": 25,
      "source": "invited"
    }
  ],
  "message": "Success",
  "wording": "Successfully retrieved friend list.",
  "echo": null
}
```
```

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

### POST /get_credentials

Source: https://napcat.apifox.cn/226657054e0

Retrieves credentials for QQ related interfaces. Requires a domain parameter in the request body.

```APIDOC
## POST /get_credentials

### Description
Retrieves credentials for QQ related interfaces. Requires a domain parameter in the request body.

### Method
POST

### Endpoint
/get_credentials

### Parameters
#### Request Body
- **domain** (string) - Required - The domain for which to obtain credentials.

### Request Example
```json
{
  "domain": "your_domain"
}
```

### Response
#### Success Response (200)
- **status** (string) - 'ok'
- **retcode** (number) - The return code.
- **data** (object) - Contains the credentials.
  - **cookies** (string) - The cookies for the interface.
  - **token** (number) - The token for the interface.
- **message** (string) - A message indicating the result of the operation.
- **wording** (string) - A descriptive wording of the result.
- **echo** (string) - Echo of the request.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "cookies": "your_cookies",
    "token": 123456789
  },
  "message": "Success",
  "wording": "Credentials obtained successfully.",
  "echo": "your_domain"
}
```
```

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

### Get Forwarded Message Details API

Source: https://napcat.apifox.cn/54406081f0

Retrieves detailed information about a forwarded message.

```APIDOC
## GET /api/messages/forwarded/{messageId}

### Description
Fetches detailed information about a forwarded message.

### Method
GET

### Endpoint
/api/messages/forwarded/{messageId}

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the forwarded message.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **originalMessageId** (string) - The ID of the original message.
- **forwardedMessageId** (string) - The ID of this forwarded message.
- **forwarderId** (string) - The ID of the user who forwarded the message.
- **originalSenderId** (string) - The ID of the original sender.

#### Response Example
```json
{
  "originalMessageId": "origMsg456",
  "forwardedMessageId": "fwdMsg789",
  "forwarderId": "user101",
  "originalSenderId": "user102"
}
```
```

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

### Get Image Message Details API

Source: https://napcat.apifox.cn/54406081f0

Retrieves detailed information about a specific image message.

```APIDOC
## GET /api/messages/image/{messageId}

### Description
Fetches detailed information about a specific image message.

### Method
GET

### Endpoint
/api/messages/image/{messageId}

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the image message.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **messageId** (string) - The ID of the image message.
- **url** (string) - The URL to the image file.
- **width** (integer) - The width of the image.
- **height** (integer) - The height of the image.

#### Response Example
```json
{
  "messageId": "imgMsg456",
  "url": "https://example.com/images/photo.jpg",
  "width": 1920,
  "height": 1080
}
```
```

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

### POST /set_qq_avatar

Source: https://napcat.apifox.cn/226658980e0

This endpoint allows users to set their QQ avatar by providing a local path, network link, or base64 encoded image data.

```APIDOC
## POST /set_qq_avatar

### Description
Sets the user's QQ avatar. Accepts a file path (local or network), or base64 encoded image data.

### Method
POST

### Endpoint
/set_qq_avatar

### Parameters
#### Request Body
- **file** (string) - Required - The path or URL to the image file, or base64 encoded data.

### Request Example
```json
{
    "file": "D:/a.jpg"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates 'ok' for success.
- **retcode** (number) - The return code.
- **data** (object) - Null for this operation.
- **message** (string) - A message describing the result.
- **wording** (string) - Wording related to the result.
- **echo** (string) - Echo field, may be null.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": null,
  "message": "Success",
  "wording": "Operation successful.",
  "echo": ""
}
```
```

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

### POST /_get_model_show

Source: https://napcat.apifox.cn/227233981e0

Retrieves a list of online models with their details, including whether a payment is required.

```APIDOC
## POST /_get_model_show

### Description
This endpoint allows you to retrieve information about available online models. It returns details such as the model's display name and whether it requires payment.

### Method
POST

### Endpoint
/_get_model_show

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **model** (string) - Required - The name of the model to query. Defaults to 'napcat'.

### Request Example
```json
{
  "model": "napcat"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request, expected to be 'ok'.
- **retcode** (number) - The return code for the operation.
- **data** (array) - An array of model objects.
  - **variants** (object) - Contains details about the model variants.
    - **model_show** (string) - The display name of the model.
    - **need_pay** (boolean) - Indicates if payment is required for this model.
- **message** (string) - A message describing the result of the operation.
- **wording** (string) - A descriptive text for the user.
- **echo** (string) - Optional field for echoing request data.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": [
    {
      "variants": {
        "model_show": "Example Model",
        "need_pay": false
      }
    }
  ],
  "message": "Success",
  "wording": "Model data retrieved successfully.",
  "echo": null
}
```
```

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

### Get Voice Message Details API

Source: https://napcat.apifox.cn/54406081f0

Retrieves detailed information about a specific voice message.

```APIDOC
## GET /api/messages/voice/{messageId}

### Description
Fetches detailed information about a specific voice message.

### Method
GET

### Endpoint
/api/messages/voice/{messageId}

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the voice message.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **messageId** (string) - The ID of the voice message.
- **url** (string) - The URL to the voice message audio file.
- **duration** (integer) - The duration of the voice message in seconds.

#### Response Example
```json
{
  "messageId": "voiceMsg123",
  "url": "https://example.com/audio/voice.mp3",
  "duration": 30
}
```
```

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

### POST /download_file

Source: https://napcat.apifox.cn/226658887e0

Downloads a file to the cache directory. You can specify the file by providing a URL or a base64 encoded string.

```APIDOC
## POST /download_file

### Description
Downloads a file to the cache directory. You can specify the file by providing a URL or a base64 encoded string. Custom file names and request headers can also be provided.

### Method
POST

### Endpoint
/download_file

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the file to download.
- **base64** (string) - Required - The base64 encoded content of the file. Mutually exclusive with `url`.
- **name** (string) - Optional - A custom name for the downloaded file.
- **headers** (string or array of strings) - Optional - Request headers to be used during the download.

### Request Example
```json
{
  "url": "http://example.com/file.zip",
  "name": "my_custom_file.zip",
  "headers": [
    "Authorization: Bearer YOUR_TOKEN"
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation (e.g., "ok").
- **retcode** (number) - The return code.
- **data** (object) - Contains details about the downloaded file.
  - **file** (string) - The path to the downloaded file in the cache directory.
- **message** (string) - A human-readable message about the operation.
- **wording** (string) - A more descriptive message.
- **echo** (string, nullable) - Additional information or identifier.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "file": "/path/to/cache/my_custom_file.zip"
  },
  "message": "File downloaded successfully.",
  "wording": "Download complete.",
  "echo": "unique_id"
}
```
```

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

### Get Friend History Messages API

Source: https://napcat.apifox.cn/54406081f0

Retrieves a history of messages from a specific friend chat.

```APIDOC
## GET /api/messages/friend/history

### Description
Fetches the message history for a chat with a specific friend.

### Method
GET

### Endpoint
/api/messages/friend/history

### Parameters
#### Path Parameters
None

#### Query Parameters
- **friendId** (string) - Required - The ID of the friend.
- **limit** (integer) - Optional - The maximum number of messages to retrieve.
- **offset** (integer) - Optional - The number of messages to skip.

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **messages** (array) - An array of message objects.
  - **messageId** (string) - The ID of the message.
  - **senderId** (string) - The ID of the sender.
  - **content** (string) - The message content.
  - **timestamp** (string) - The time the message was sent.

#### Response Example
```json
{
  "messages": [
    {
      "messageId": "msg002",
      "senderId": "user456",
      "content": "How are you?",
      "timestamp": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

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

### Other APIs

Source: https://napcat.apifox.cn/index

Miscellaneous APIs, including placeholders and specific interface calls.

```APIDOC
## Other APIs

### Description
Miscellaneous APIs, including placeholders and specific interface calls.

### Reserved APIs

#### POST /api/send_private_msg

##### Description
Sends a private message (reserved).

#### POST /api/send_group_msg

##### Description
Sends a group message (reserved).

#### POST /api/send_msg

##### Description
Sends a message (reserved).

### Interface APIs

#### POST /api/unknown

##### Description
An unknown interface endpoint.

#### POST /api/get_guild_list

##### Description
Retrieves the guild list.

#### POST /api/get_guild_service_profile

##### Description
Retrieves the guild service profile.

#### POST /api/check_link_security

##### Description
Checks the security of a link.

### Bug Related APIs

#### POST /api/get_like_list

##### Description
Retrieves the list of likes (potentially related to bug reporting).

#### POST /api/get_filtered_join_group_requests

##### Description
Retrieves filtered join group requests (potentially related to bug reporting).
```

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

### Get Group History Messages API

Source: https://napcat.apifox.cn/54406081f0

Retrieves a history of messages from a specific group chat.

```APIDOC
## GET /api/messages/group/history

### Description
Fetches the message history for a given group chat.

### Method
GET

### Endpoint
/api/messages/group/history

### Parameters
#### Path Parameters
None

#### Query Parameters
- **groupId** (string) - Required - The ID of the group.
- **limit** (integer) - Optional - The maximum number of messages to retrieve.
- **offset** (integer) - Optional - The number of messages to skip.

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **messages** (array) - An array of message objects.
  - **messageId** (string) - The ID of the message.
  - **senderId** (string) - The ID of the sender.
  - **content** (string) - The message content.
  - **timestamp** (string) - The time the message was sent.

#### Response Example
```json
{
  "messages": [
    {
      "messageId": "msg001",
      "senderId": "user123",
      "content": "Hello everyone!",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### Get Group Info Ex

Source: https://napcat.apifox.cn/226659229e0

Retrieves extended information for a specific group, identified by its group ID.

```APIDOC
## POST /get_group_info_ex

### Description
Retrieves extended information for a specific group chat.

### Method
POST

### Endpoint
/get_group_info_ex

### Parameters
#### Request Body
- **group_id** (string) - Required - The unique identifier of the group.

### Request Example
```json
{
  "group_id": "string"
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **retcode** (number) - The return code indicating the result of the operation.
- **data** (object) - An object containing the group's extended information.
  - **groupCode** (string) - The group's unique code.
  - **resultCode** (number) - The result code for the data retrieval.
  - **extInfo** (object) - Extended information about the group.
    - **groupInfoExtSeq** (number) - Sequence number for group info extension.
    - **reserve** (number) - Reserved field.
    - **luckyWordId** (string) - ID of the lucky word feature.
    - **lightCharNum** (number) - Number of light characters.
    - **luckyWord** (string) - The lucky word text.
    - **starId** (number) - Star ID associated with the group.
    - **essentialMsgSwitch** (number) - Switch state for essential messages.
    - **todoSeq** (number) - Sequence number for to-do items.
    - **blacklistExpireTime** (number) - Expiration time for the blacklist.
    - **isLimitGroupRtc** (number) - Flag indicating if group RTC is limited.
    - **companyId** (number) - Company ID associated with the group.
    - **hasGroupCustomPortrait** (number) - Flag indicating if custom portraits are available.
    - **bindGuildId** (string) - ID of the bound guild.
    - **groupOwnerId** (object) - Information about the group owner.
      - **memberUin** (string) - User's UIN.
      - **memberUid** (string) - User's UID.
      - **memberQid** (string) - User's QID.
    - **essentialMsgPrivilege** (number) - Privilege level for essential messages.
    - **msgEventSeq** (string) - Sequence number for message events.
    - **inviteRobotSwitch** (number) - Switch state for inviting robots.
    - **gangUpId** (string) - Gang up ID.
    - **qqMusicMedalSwitch** (number) - Switch state for QQ Music medal.
    - **showPlayTogetherSwitch** (number) - Switch state for showing 'Play Together'.
    - **groupFlagPro1** (string) - Group flag professional version 1.
    - **groupBindGuildIds** (object) - IDs of bound guilds.
      - **guildIds** (array) - List of guild IDs.
    - **viewedMsgDisappearTime** (string) - Time when viewed messages disappear.
    - **groupExtFlameData** (object) - Flame data for group extensions.
      - **switchState** (integer) - Switch state of the flame data.
      - **state** (integer) - State of the flame data.
      - **dayNums** (array) - Array of day numbers.
      - **version** (integer) - Version of the flame data.
      - **updateTime** (string) - Timestamp of the last update.

#### Response Example
```json
{
  "status": "success",
  "retcode": 0,
  "data": {
    "groupCode": "123456789",
    "resultCode": 0,
    "extInfo": {
      "groupInfoExtSeq": 1,
      "reserve": 0,
      "luckyWordId": "",
      "lightCharNum": 0,
      "luckyWord": "",
      "starId": 0,
      "essentialMsgSwitch": 0,
      "todoSeq": 0,
      "blacklistExpireTime": 0,
      "isLimitGroupRtc": 0,
      "companyId": 0,
      "hasGroupCustomPortrait": 0,
      "bindGuildId": "",
      "groupOwnerId": {
        "memberUin": "1234567890",
        "memberUid": "abcdef123456",
        "memberQid": "123456789"
      },
      "essentialMsgPrivilege": 0,
      "msgEventSeq": "",
      "inviteRobotSwitch": 0,
      "gangUpId": "",
      "qqMusicMedalSwitch": 0,
      "showPlayTogetherSwitch": 0,
      "groupFlagPro1": "",
      "groupBindGuildIds": {
        "guildIds": []
      },
      "viewedMsgDisappearTime": "",
      "groupExtFlameData": {
        "switchState": 0,
        "state": 0,
        "dayNums": [],
        "version": 0,
        "updateTime": ""
      }
    }
  }
}
```
```

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

### Account Information APIs

Source: https://napcat.apifox.cn/54405734f0

Endpoints for retrieving account and login information.

```APIDOC
## GET /api/account/info

### Description
Retrieves the information of the current logged-in account.

### Method
GET

### Endpoint
/api/account/info

### Response
#### Success Response (200)
- **user_id** (string) - The user ID.
- **username** (string) - The username.
- **nickname** (string) - The user's nickname.
- **avatar_url** (string) - The URL of the user's avatar.

#### Response Example
{
  "user_id": "current_user",
  "username": "testuser",
  "nickname": "Test User",
  "avatar_url": "http://example.com/avatar.png"
}

## GET /api/account/login_info

### Description
Retrieves information about the current login session.

### Method
GET

### Endpoint
/api/account/login_info

### Response
#### Success Response (200)
- **login_time** (string) - The time of login.
- **device_type** (string) - The type of device used for login.

#### Response Example
{
  "login_time": "2023-10-27T10:00:00Z",
  "device_type": "web"
}
```

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

### Send Poke API

Source: https://napcat.apifox.cn/54406081f0

Allows sending a 'poke' or 'nudge' to another user, often used to get attention.

```APIDOC
## POST /api/messages/poke

### Description
Sends a 'poke' to a user, typically to get their attention.

### Method
POST

### Endpoint
/api/messages/poke

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **userId** (string) - Required - The ID of the user to poke.

### Request Example
```json
{
  "userId": "user789"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success of the poke operation.

#### Response Example
```json
{
  "status": "poke_sent"
}
```
```

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

### POST /get_rkey - Get Rkey

Source: https://napcat.apifox.cn/283136230e0

This endpoint is used to retrieve an rkey. It requires no specific parameters in the request body.

```APIDOC
## POST /get_rkey

### Description
This endpoint is used to retrieve an rkey. It requires no specific parameters in the request body.

### Method
POST

### Endpoint
/get_rkey

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **(object)** - Required - Empty object is expected.

### Request Example
```json
{
  "": ""
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation, expected to be 'ok'.
- **retcode** (number) - The return code for the operation.
- **data** (array) - An array of objects, where each object contains rkey details.
  - **type** (string) - The type of the rkey.
  - **rkey** (string) - The retrieved rkey.
  - **created_at** (number) - The timestamp when the rkey was created.
  - **ttl** (string) - The time-to-live for the rkey.
- **message** (string) - A message describing the result of the operation.
- **wording** (string) - A descriptive wording for the operation result.
- **echo** (string) - An echo field, possibly for tracking.

#### Response Example
```json
{
  "status": "ok",
  "retcode": 0,
  "data": [
    {
      "type": "some_type",
      "rkey": "example_rkey_123",
      "created_at": 1678886400,
      "ttl": "24h"
    }
  ],
  "message": "Successfully retrieved rkey",
  "wording": "Operation successful.",
  "echo": ""
}
```
```

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

### Account Settings API

Source: https://napcat.apifox.cn/54405734f0

Endpoints for managing account information, including profile details, avatar, and signature.

```APIDOC
## POST /api/account/settings

### Description
Sets account information for the current user.

### Method
POST

### Endpoint
/api/account/settings

### Parameters
#### Request Body
- **key** (string) - Required - The key of the account information to set.
- **value** (string) - Required - The value to set for the account information.

### Request Example
{
  "key": "nickname",
  "value": "New Nickname"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
{
  "success": true
}

## POST /api/account/avatar

### Description
Sets the avatar for the current user.

### Method
POST

### Endpoint
/api/account/avatar

### Parameters
#### Request Body
- **avatar_url** (string) - Required - The URL of the new avatar.

### Request Example
{
  "avatar_url": "http://example.com/new_avatar.png"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
{
  "success": true
}

## POST /api/account/signature

### Description
Sets the personalized signature for the current user.

### Method
POST

### Endpoint
/api/account/signature

### Parameters
#### Request Body
- **signature** (string) - Required - The new personalized signature.

### Request Example
{
  "signature": "Hello, world!"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
{
  "success": true
}
```
Tokens:
Raw