Interface IOnebotExports

interface IOnebotExports {
    .handle_quick_operation(params: {
        context: object;
        operation: object;
    }): void;
    can_send_image(): {
        yes: boolean;
    };
    can_send_record(): {
        yes: boolean;
    };
    clean_cache(): void;
    delete_msg(params: {
        message_id: number;
    }): void;
    download_file(params: {
        base64?: string;
        headers: string | string[];
        thread_count: number;
        url: string;
    }): {
        file: string;
    };
    forward_friend_single_msg(params: {
        message_id: number;
        user_id: number;
    }): void;
    forward_group_single_msg(params: {
        group_id: number;
        message_id: number;
    }): void;
    get_cookies(params: {
        domain?: string;
    }): {
        cookies: string;
    };
    get_credentials(params: {
        domain?: string;
    }): {
        cookies: string;
        token: number;
    };
    get_csrf_token(): {
        token: number;
    };
    get_file(params: {
        file_id: string;
    }): TFileInfo;
    get_forward_msg(params: {
        id: string;
    }): TSegment[];
    get_friend_list(): TFriendInfo[];
    get_friends_with_category(): TFriendWithCategoryInfo;
    get_group_honor_info(params: {
        group_id: number;
        type:
            | "talkative"
            | "performer"
            | "legend"
            | "strong_newbie"
            | "emotion"
            | "all";
    }): TGroupHonorInfo;
    get_group_ignore_add_request(): TGroupIngoreAddRequestInfo;
    get_group_info(params: {
        group_id: number;
        no_cache?: boolean;
    }): TGroupInfo;
    get_group_list(): TGroupInfo[];
    get_group_member_info(params: {
        group_id: number;
        no_cache?: boolean;
        user_id: number;
    }): TGroupMemberInfo;
    get_group_member_list(params: {
        group_id: number;
    }): TGroupMemberInfo[];
    get_group_msg_history(params: {
        group_id: number;
        message_seq?: number;
    }): TSegment[];
    get_image(params: {
        file: string;
    }): {
        file: string;
    };
    get_login_info(): TLoginInfo;
    get_msg(params: {
        message_id: number;
    }): TMessage;
    get_record(params: {
        file: string;
        out_format: string;
    }): {
        file: string;
    };
    get_status(): TStatus;
    get_stranger_info(params: {
        no_cache?: boolean;
        user_id: number;
    }): TStrangerInfo;
    get_version_info(): {
        app_name: string;
        app_version: string;
        protocol_version: string;
    };
    send_forward_msg(): any;
    send_group_forward_msg(params: {
        group_id: number;
        messages: TSegment[];
    }): {
        forward_id: number;
        message_id: number;
    };
    send_group_msg(params: {
        auto_escape?: boolean;
        group_id: number;
        message: TElements;
    }): number;
    send_like(params: {
        times?: number;
        user_id: number;
    }): void;
    send_msg(params: {
        auto_escape?: boolean;
        group_id?: number;
        message: TElements;
        message_type?: "private" | "group";
        user_id?: number;
    }): number;
    send_private_forward_msg(params: {
        messages: TSegment[];
        user_id: number;
    }): {
        forward_id: number;
        message_id: number;
    };
    send_private_msg(params: {
        auto_escape?: boolean;
        message: TElements;
        user_id: number;
    }): number;
    set_friend_add_request(params: {
        approve?: boolean;
        flag: string;
        remark?: string;
    }): void;
    set_group_add_request(params: {
        approve?: boolean;
        flag: string;
        reason?: string;
        sub_type: "add" | "invite";
    }): void;
    set_group_admin(params: {
        enable?: boolean;
        group_id: number;
        user_id: number;
    }): void;
    set_group_anonymous(params: {
        enable?: boolean;
        group_id: number;
    }): void;
    set_group_anonymous_ban(params: {
        anonymous?: TAnonymous;
        anonymous_flag?: string;
        duration?: number;
        group_id: number;
    }): void;
    set_group_ban(params: {
        duration?: number;
        group_id: number;
        user_id: number;
    }): void;
    set_group_card(params: {
        card?: string;
        group_id: number;
        user_id: number;
    }): void;
    set_group_kick(params: {
        group_id: number;
        reject_add_request?: boolean;
        user_id: number;
    }): void;
    set_group_leave(params: {
        group_id: number;
        is_dismiss?: boolean;
    }): void;
    set_group_name(params: {
        group_id: number;
        group_name: string;
    }): void;
    set_group_special_title(params: {
        duration?: number;
        group_id: number;
        special_title?: string;
        user_id: number;
    }): void;
    set_group_whole_ban(params: {
        enable?: boolean;
        group_id: number;
    }): void;
    set_msg_emoji_like(params: {
        emoji_id: number;
        message_id: number;
    }): void;
    set_qq_avatar(params: {
        file: string;
    }): void;
    set_restart(params: {
        delay?: number;
    }): void;
    upload_group_file(params: {
        file: string;
        folder?: string;
        group_id: number;
        name: string;
    }): void;
}

Methods

.handle_quick_operation can_send_image can_send_record clean_cache delete_msg download_file forward_friend_single_msg forward_group_single_msg get_cookies get_credentials get_csrf_token get_file get_forward_msg get_friend_list get_friends_with_category get_group_honor_info get_group_ignore_add_request get_group_info get_group_list get_group_member_info get_group_member_list get_group_msg_history get_image get_login_info get_msg get_record get_status get_stranger_info get_version_info send_forward_msg send_group_forward_msg send_group_msg send_like send_msg send_private_forward_msg send_private_msg set_friend_add_request set_group_add_request set_group_admin set_group_anonymous set_group_anonymous_ban set_group_ban set_group_card set_group_kick set_group_leave set_group_name set_group_special_title set_group_whole_ban set_msg_emoji_like set_qq_avatar set_restart upload_group_file

Methods

.handle_quick_operation

  • .handle_quick_operation(params): void

  • Parameters

    • params: {
          context: object;
          operation: object;
      }
      • context: object
      • operation: object

    Returns void

can_send_image

  • can_send_image(): {
        yes: boolean;
    }

  • Returns {
        yes: boolean;
    }

    • yes: boolean

can_send_record

  • can_send_record(): {
        yes: boolean;
    }

  • Returns {
        yes: boolean;
    }

    • yes: boolean

clean_cache

delete_msg

  • delete_msg(params): void

  • Parameters

    • params: {
          message_id: number;
      }
      • message_id: number

    Returns void

download_file

  • download_file(params): {
        file: string;
    }

  • Parameters

    • params: {
          base64?: string;
          headers: string | string[];
          thread_count: number;
          url: string;
      }
      • Optionalbase64?: string
      • headers: string | string[]
      • thread_count: number
      • url: string

    Returns {
        file: string;
    }

    • file: string

forward_friend_single_msg

  • forward_friend_single_msg(params): void

  • Parameters

    • params: {
          message_id: number;
          user_id: number;
      }
      • message_id: number
      • user_id: number

    Returns void

forward_group_single_msg

  • forward_group_single_msg(params): void

  • Parameters

    • params: {
          group_id: number;
          message_id: number;
      }
      • group_id: number
      • message_id: number

    Returns void

get_cookies

  • get_cookies(params): {
        cookies: string;
    }

  • Parameters

    • params: {
          domain?: string;
      }
      • Optionaldomain?: string

    Returns {
        cookies: string;
    }

    • cookies: string

get_credentials

  • get_credentials(params): {
        cookies: string;
        token: number;
    }

  • Parameters

    • params: {
          domain?: string;
      }
      • Optionaldomain?: string

    Returns {
        cookies: string;
        token: number;
    }

    • cookies: string
    • token: number

get_csrf_token

  • get_csrf_token(): {
        token: number;
    }

  • Returns {
        token: number;
    }

    • token: number

get_file

get_forward_msg

get_friend_list

get_friends_with_category

get_group_honor_info

  • get_group_honor_info(params): TGroupHonorInfo

  • Parameters

    • params: {
          group_id: number;
          type:
              | "talkative"
              | "performer"
              | "legend"
              | "strong_newbie"
              | "emotion"
              | "all";
      }
      • group_id: number
      • type:
            | "talkative"
            | "performer"
            | "legend"
            | "strong_newbie"
            | "emotion"
            | "all"

    Returns TGroupHonorInfo

get_group_ignore_add_request

get_group_info

  • get_group_info(params): TGroupInfo

  • Parameters

    • params: {
          group_id: number;
          no_cache?: boolean;
      }
      • group_id: number
      • Optionalno_cache?: boolean

    Returns TGroupInfo

get_group_list

get_group_member_info

get_group_member_list

get_group_msg_history

  • get_group_msg_history(params): TSegment[]

  • Parameters

    • params: {
          group_id: number;
          message_seq?: number;
      }
      • group_id: number
      • Optionalmessage_seq?: number

    Returns TSegment[]

get_image

  • get_image(params): {
        file: string;
    }

  • Parameters

    • params: {
          file: string;
      }
      • file: string

    Returns {
        file: string;
    }

    • file: string

get_login_info

get_msg

get_record

  • get_record(params): {
        file: string;
    }

  • Parameters

    • params: {
          file: string;
          out_format: string;
      }
      • file: string
      • out_format: string

    Returns {
        file: string;
    }

    • file: string

get_status

get_stranger_info

get_version_info

  • get_version_info(): {
        app_name: string;
        app_version: string;
        protocol_version: string;
    }

  • Returns {
        app_name: string;
        app_version: string;
        protocol_version: string;
    }

    • app_name: string
    • app_version: string
    • protocol_version: string

send_forward_msg

send_group_forward_msg

  • send_group_forward_msg(params): {
        forward_id: number;
        message_id: number;
    }

  • Parameters

    • params: {
          group_id: number;
          messages: TSegment[];
      }

    Returns {
        forward_id: number;
        message_id: number;
    }

    • forward_id: number
    • message_id: number

send_group_msg

  • send_group_msg(params): number

  • Parameters

    • params: {
          auto_escape?: boolean;
          group_id: number;
          message: TElements;
      }
      • Optionalauto_escape?: boolean
      • group_id: number
      • message: TElements

    Returns number

send_like

  • send_like(params): void

  • Parameters

    • params: {
          times?: number;
          user_id: number;
      }
      • Optionaltimes?: number
      • user_id: number

    Returns void

send_msg

  • send_msg(params): number

  • Parameters

    • params: {
          auto_escape?: boolean;
          group_id?: number;
          message: TElements;
          message_type?: "private" | "group";
          user_id?: number;
      }
      • Optionalauto_escape?: boolean
      • Optionalgroup_id?: number
      • message: TElements
      • Optionalmessage_type?: "private" | "group"
      • Optionaluser_id?: number

    Returns number

send_private_forward_msg

  • send_private_forward_msg(params): {
        forward_id: number;
        message_id: number;
    }

  • Parameters

    • params: {
          messages: TSegment[];
          user_id: number;
      }

    Returns {
        forward_id: number;
        message_id: number;
    }

    • forward_id: number
    • message_id: number

send_private_msg

  • send_private_msg(params): number

  • Parameters

    • params: {
          auto_escape?: boolean;
          message: TElements;
          user_id: number;
      }
      • Optionalauto_escape?: boolean
      • message: TElements
      • user_id: number

    Returns number

set_friend_add_request

  • set_friend_add_request(params): void

  • Parameters

    • params: {
          approve?: boolean;
          flag: string;
          remark?: string;
      }
      • Optionalapprove?: boolean
      • flag: string
      • Optionalremark?: string

    Returns void

set_group_add_request

  • set_group_add_request(params): void

  • Parameters

    • params: {
          approve?: boolean;
          flag: string;
          reason?: string;
          sub_type: "add" | "invite";
      }
      • Optionalapprove?: boolean
      • flag: string
      • Optionalreason?: string
      • sub_type: "add" | "invite"

    Returns void

set_group_admin

  • set_group_admin(params): void

  • Parameters

    • params: {
          enable?: boolean;
          group_id: number;
          user_id: number;
      }
      • Optionalenable?: boolean
      • group_id: number
      • user_id: number

    Returns void

set_group_anonymous

  • set_group_anonymous(params): void

  • Parameters

    • params: {
          enable?: boolean;
          group_id: number;
      }
      • Optionalenable?: boolean
      • group_id: number

    Returns void

set_group_anonymous_ban

  • set_group_anonymous_ban(params): void

  • Parameters

    • params: {
          anonymous?: TAnonymous;
          anonymous_flag?: string;
          duration?: number;
          group_id: number;
      }
      • Optionalanonymous?: TAnonymous
      • Optionalanonymous_flag?: string
      • Optionalduration?: number
      • group_id: number

    Returns void

set_group_ban

  • set_group_ban(params): void

  • Parameters

    • params: {
          duration?: number;
          group_id: number;
          user_id: number;
      }
      • Optionalduration?: number
      • group_id: number
      • user_id: number

    Returns void

set_group_card

  • set_group_card(params): void

  • Parameters

    • params: {
          card?: string;
          group_id: number;
          user_id: number;
      }
      • Optionalcard?: string
      • group_id: number
      • user_id: number

    Returns void

set_group_kick

  • set_group_kick(params): void

  • Parameters

    • params: {
          group_id: number;
          reject_add_request?: boolean;
          user_id: number;
      }
      • group_id: number
      • Optionalreject_add_request?: boolean
      • user_id: number

    Returns void

set_group_leave

  • set_group_leave(params): void

  • Parameters

    • params: {
          group_id: number;
          is_dismiss?: boolean;
      }
      • group_id: number
      • Optionalis_dismiss?: boolean

    Returns void

set_group_name

  • set_group_name(params): void

  • Parameters

    • params: {
          group_id: number;
          group_name: string;
      }
      • group_id: number
      • group_name: string

    Returns void

set_group_special_title

  • set_group_special_title(params): void

  • Parameters

    • params: {
          duration?: number;
          group_id: number;
          special_title?: string;
          user_id: number;
      }
      • Optionalduration?: number
      • group_id: number
      • Optionalspecial_title?: string
      • user_id: number

    Returns void

set_group_whole_ban

  • set_group_whole_ban(params): void

  • Parameters

    • params: {
          enable?: boolean;
          group_id: number;
      }
      • Optionalenable?: boolean
      • group_id: number

    Returns void

set_msg_emoji_like

set_qq_avatar

  • set_qq_avatar(params): void

  • Parameters

    • params: {
          file: string;
      }
      • file: string

    Returns void

set_restart

  • set_restart(params): void

  • Parameters

    • params: {
          delay?: number;
      }
      • Optionaldelay?: number

    Returns void

upload_group_file

  • upload_group_file(params): void

  • Parameters

    • params: {
          file: string;
          folder?: string;
          group_id: number;
          name: string;
      }
      • file: string
      • Optionalfolder?: string
      • group_id: number
      • name: string

    Returns void

Settings

Member Visibility

On This Page

Methods
.handle_quick_operationcan_send_imagecan_send_recordclean_cachedelete_msgdownload_fileforward_friend_single_msgforward_group_single_msgget_cookiesget_credentialsget_csrf_tokenget_fileget_forward_msgget_friend_listget_friends_with_categoryget_group_honor_infoget_group_ignore_add_requestget_group_infoget_group_listget_group_member_infoget_group_member_listget_group_msg_historyget_imageget_login_infoget_msgget_recordget_statusget_stranger_infoget_version_infosend_forward_msgsend_group_forward_msgsend_group_msgsend_likesend_msgsend_private_forward_msgsend_private_msgset_friend_add_requestset_group_add_requestset_group_adminset_group_anonymousset_group_anonymous_banset_group_banset_group_cardset_group_kickset_group_leaveset_group_nameset_group_special_titleset_group_whole_banset_msg_emoji_likeset_qq_avatarset_restartupload_group_file