Skip to content

Standard Actions

get_self_info Get Bot Self Information

Request Parameters

None.

Response Data

FieldData TypeDefaultDescription
user_idstring-Bot user ID
user_namestring-Bot name/nickname
platformstring-Platform name
user_displaynamestring-Bot account display name, empty string if not set

Request Example

json
{
  "action": "get_self_info",
  "params": {}
}

Response Example

json
{
    "status": "ok",
    "retcode": 0,
    "data": {
        "user_id": "123456",
        "user_name": "My Bot",
        "platform": "qq",
        "user_displayname": ""
    },
    "message": ""
}

get_user_info Get User Information

Request Parameters

FieldData TypeDefaultDescription
user_idstring-User ID, can be friend or stranger

Response Data

FieldData TypeDefaultDescription
user_idstring-User ID
user_namestring-User name/nickname
user_displaynamestring-User display name, empty string if not set
user_remarkstring-Bot account remark name for this user, empty string if not set

Request Example

json
{
  "action": "get_user_info",
  "params": {
    "user_id": "123456"
  }
}

send_message Send Message

Request Parameters

FieldData TypeDefaultDescription
detail_typestring-Message detail type: private, group, channel
user_idstring-Target user ID (required for private)
group_idstring-Target group ID (required for group)
guild_idstring-Target guild ID (required for channel)
channel_idstring-Target channel ID (required for channel)
messagemessage-Message content

Response Data

FieldData TypeDescription
message_idstringMessage ID