Skip to main content

​
get_login_info

Get the bot’s own account information.

​
Request

No parameters required.

​
Response

​
user_id
number
Bot’s QQ number
​
nickname
string
Bot’s nickname

​
Example

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "user_id": 123456789,
    "nickname": "My Bot"
  }
}

​
get_stranger_info

Get information about a user (go-cqhttp extension).

​
Request

​
user_id
string
required
User QQ number
​
no_cache
boolean | string
default:"false"
Bypass cache and fetch fresh data

​
Response

​
user_id
number
User QQ number
​
nickname
string
User nickname
​
sex
string
Gender: male, female, or unknown
​
age
number
Age
​
qid
string
QQ ID (QID)
​
level
number
QQ level
​
login_days
number
Login days

​
Example

// Request
{
  "user_id": "987654321"
}

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "user_id": 987654321,
    "nickname": "User Name",
    "sex": "male",
    "age": 20,
    "qid": "user_qid",
    "level": 64,
    "login_days": 1000
  }
}

​
get_friend_list

Get the bot’s friend list.

​
Request

​
no_cache
boolean | string
default:"false"
Bypass cache and fetch fresh data

​
Response

​
data
array
Array of friend objects
Each friend object contains:
  • user_id (number): Friend QQ number
  • nickname (string): Friend nickname
  • remark (string): Friend remark/note
  • sex (string): Gender
  • level (number): QQ level
  • age (number): Age
  • qid (string): QQ ID
  • login_days (number): Login days
  • category_id (number): Friend category ID
  • categoryName (string): Friend category name

​
Example

// Request
{
  "no_cache": false
}

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": [
    {
      "user_id": 111111,
      "nickname": "Friend 1",
      "remark": "Best Friend",
      "sex": "male",
      "level": 64,
      "age": 20,
      "qid": "friend1_qid",
      "category_id": 1,
      "categoryName": "Friends"
    },
    {
      "user_id": 222222,
      "nickname": "Friend 2",
      "remark": "Classmate",
      "sex": "female",
      "level": 32,
      "age": 19,
      "qid": "friend2_qid",
      "category_id": 2,
      "categoryName": "School"
    }
  ]
}

​
send_like

Send a “like” (thumbs up) to a user’s profile.

​
Request

​
user_id
string
required
Target user QQ number
​
times
number | string
default:"1"
Number of likes to send (1-10)

​
Response

​
result
null
Returns null on success

​
Example

// Request
{
  "user_id": "987654321",
  "times": 10
}

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": null
}
Sending likes too frequently may result in failure. The error code 1400 indicates rate limiting or the user doesn’t exist.

​
set_friend_add_request

Approve or reject a friend request.

​
Request

​
flag
string
required
Request flag from friend request event
​
approve
boolean | string
default:"true"
Approve (true) or reject (false)
​
remark
string
default:""
Friend remark/note (only used when approving)

​
Response

​
result
null
Returns null on success

​
Example

// Request - Approve with remark
{
  "flag": "request_flag_12345",
  "approve": true,
  "remark": "New Friend"
}

// Request - Reject
{
  "flag": "request_flag_12345",
  "approve": false
}

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": null
}

​
get_cookies

Get cookies for QQ web interface (NapCat extension).

​
Request

​
domain
string
Cookie domain (optional)

​
Response

​
cookies
string
Cookie string

​
Example

// Request
{
  "domain": "qun.qq.com"
}

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": {
    "cookies": "uin=123456; skey=...; ..."
  }
}

​
get_recent_contact

Get recent contacts (NapCat extension).

​
Request

​
count
number
default:"10"
Number of contacts to retrieve

​
Response

​
data
array
Array of recent contact objects
Each contact contains:
  • user_id (number): Contact QQ number (for private chats)
  • group_id (number): Group number (for group chats)
  • time (number): Last contact time
  • message_type (string): Contact type (private or group)
  • message (array): Last message content
  • raw_message (string): Last message text
  • sender (object): Sender information

​
Example

// Request
{
  "count": 5
}

// Response
{
  "status": "ok",
  "retcode": 0,
  "data": [
    {
      "user_id": 111111,
      "time": 1234567890,
      "message_type": "private",
      "raw_message": "Hello",
      "sender": {
        "user_id": 111111,
        "nickname": "Friend"
      }
    },
    {
      "group_id": 222222,
      "time": 1234567800,
      "message_type": "group",
      "raw_message": "Hi group",
      "sender": {
        "user_id": 333333,
        "nickname": "Member",
        "card": "Card Name"
      }
    }
  ]
}

​
Additional User Actions

​
set_friend_remark

Set or update a friend’s remark/note.
​
user_id
string
required
Friend QQ number
​
remark
string
required
New remark/note text

​
get_friend_with_category

Get friend list with category information (NapCat extension). Returns friends organized by categories/groups.

​
get_unidirectional_friend_list

Get list of one-way friends (users who added you but you haven’t added back).

​
delete_friend

Delete a friend from your friend list (go-cqhttp extension).
​
user_id
string
required
Friend QQ number to delete

​
get_profile_like

Get the list of users who liked your profile (NapCat extension).

​
get_user_status

Get a user’s online status (NapCat extension).
​
user_id
string
required
User QQ number

Build docs developers (and LLMs) love

Get started for freeTalk to us