Skip to content

api

Jump to bottom
yuban10703 edited this page Aug 18, 2024 · 10 revisions

OPQ Bot API 文档

API 列表

详细信息

send_poke

发送戳一戳请求。

参数:

  • group_id (int): 群号。
  • user_id (int): 用户 ID。

返回值:

  • 视 API 返回类型而定。

send_like

发送好友点赞请求。

参数:

  • user_uid (str): 用户 UID。

返回值:

  • 视 API 返回类型而定。

get_status

获取 OPQ 框架信息。

返回值:

  • dict

get_group_member_list

获取群成员信息。

参数:

  • group_id (int): 群号。

返回值:

  • List[MemberLists]

get_group_list

获取群列表。

返回值:

  • GetGroupListResponse

set_group_ban

设置群成员禁言。

参数:

  • group_id (int): 群号。
  • user_uid (str): 用户 UID。
  • duration (int): 禁言时长，单位为秒。

返回值:

  • 视 API 返回类型而定。

send_forward_msg

发送合并转发消息。

参数:

  • event (Event): 事件对象。
  • messages (list[Union[Message, MessageSegment, str]]): 消息列表。

返回值:

  • 视 API 返回类型而定。

send_group_forward_msg

发送群组合并转发消息。

参数:

  • group_id (int): 群号。
  • messages (list[Union[Message, MessageSegment, str]]): 消息列表。

返回值:

  • SendMsgResponse

send_private_forward_msg

发送私聊合并转发消息。

参数:

  • user_id (int): 用户 ID。
  • messages (list[Union[Message, MessageSegment, str]]): 消息列表。
  • group_id (Optional[int], 默认值为 None): 群号。

返回值:

  • SendMsgResponse

send_group_json_msg

发送群组 JSON 消息。

参数:

  • group_id (int): 群号。
  • json_content (str): JSON 内容。

返回值:

  • SendMsgResponse

send_private_json_msg

发送私聊 JSON 消息。

参数:

  • user_id (int): 用户 ID。
  • json_content (str): JSON 内容。
  • group_id (Optional[int], 默认值为 None): 群号。

返回值:

  • SendMsgResponse

build_forward_msg

生成合并转发消息的 JSON 模板。

参数:

  • messages (list[Union[Message, MessageSegment, str]]): 消息列表。

返回值:

  • str

get_group_file_url

获取群文件的下载链接。

参数:

  • group_id (int): 群号。
  • fileid (str): 文件 ID。

返回值:

  • 视 API 返回类型而定。

upload_group_file

上传群文件。

参数:

  • group_id (int): 群号。
  • filename (str): 文件名。
  • file (Union[str, Path, BytesIO, bytes]): 文件。
  • notify (bool, 默认值为 True): 是否推送通知。

返回值:

  • 视 API 返回类型而定。

upload_image_voice

上传图片或语音资源文件。

参数:

  • command_id (int): 指令 ID。
  • file (Union[str, Path, BytesIO, bytes]): 资源文件。

返回值:

  • UploadImageVoiceResponse

send_group_msg

发送群组消息。

参数:

  • group_id (int): 群号。
  • message (Union[str, Message, MessageSegment]): 消息内容。

返回值:

  • Optional[SendMsgResponse]

send_private_msg

发送私聊消息。

参数:

  • user_id (int): 用户 ID。
  • message (Union[str, Message, MessageSegment]): 消息内容。
  • group_id (Optional[int], 默认值为 None): 群号。

返回值:

  • Optional[SendMsgResponse]
Clone this wiki locally