Chronocat Satori (0.2.0)

Download OpenAPI specification:Download

URL: https://github.com/chrononeko License: AGPL-3.0

Chronocat 文档

Chronocat Satori OpenAPI 定义

这是一份 Chronocat Satori OpenAPI 的完整定义文件。

任何时候，你都可以从 https://chronocat.vercel.app/openapi.yaml 获取到此文件。

Channel

「频道」——消息的集合。

概念介绍

频道全体禁言

频道全体禁言。

Authorizations:

satori

Request Body schema: application/json

要全体禁言的频道

channel_id required	string
enable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"channel_id": "string",
"enable": true
}

创建私聊频道

创建一个私聊频道。

Authorizations:

satori

Request Body schema: application/json

要私聊的用户

user_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"type": 0,
"parent_id": "string",
"avatar": "string"
}

Guild

「群组」——用户的集合。

概念介绍

获取群组列表

获取当前用户加入的全部群组。

Authorizations:

satori

Request Body schema: application/json

分页

next	string (分页令牌) 获取下一页时提供的分页令牌，获取第一页时为空。

Responses

Request samples

Payload

Content type

application/json

{"next": "string"
}

Response samples

200

Content type

application/json

[{"data": [{"id": "string",
"name": "string",
"avatar": "string"
}
],
"next": "string"
}
]

处理群组邀请

处理来自群组的邀请。

Authorizations:

satori

Request Body schema: application/json

处理邀请

message_id required	string 请求 ID
approve required	boolean 是否通过请求
comment	string 备注信息

Responses

Request samples

Payload

Content type

application/json

{"message_id": "string",
"approve": true,
"comment": "string"
}

删除群组

删除群组。

Authorizations:

satori

Request Body schema: application/json

群组

guild_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"guild_id": "string"
}

GuildMember

「群组成员」——用户在特定群组内的信息。

概念介绍

获取群组成员列表

获取群组成员列表。

Authorizations:

satori

Request Body schema: application/json

群组

guild_id required	string
next	string (分页令牌) 获取下一页时提供的分页令牌，获取第一页时为空。

Responses

Request samples

Payload

Content type

application/json

{"guild_id": "string",
"next": "string"
}

Response samples

200

Content type

application/json

{"data": [{"user": {"id": "string",
"name": "string",
"nick": "string",
"avatar": "string",
"is_bot": true
},
"nick": "string",
"avatar": "string"
}
],
"next": "string"
}

群组用户禁言

群组用户禁言。

Authorizations:

satori

Request Body schema: application/json

用户禁言参数

guild_id required	string
user_id required	string
duration required	number (禁言时长) 禁言的时长，单位为毫秒。0 表示解除禁言。应当小于 30 天（259,200,000 毫秒）。目前会对向下取整到秒。
comment	string (说明信息) 禁言群组成员的说明。目前会忽略此字段。

Responses

Request samples

Payload

Content type

application/json

{"guild_id": "string",
"user_id": "string",
"duration": 0,
"comment": "string"
}

通过群组成员申请

处理加群请求。

Authorizations:

satori

Request Body schema: application/json

处理加群请求

message_id required	string 请求 ID
approve required	boolean 是否通过请求
comment	string 备注信息

Responses

Request samples

Payload

Content type

application/json

{"message_id": "string",
"approve": true,
"comment": "string"
}

GuildRole

「群组角色」——用户在群组内的角色或权限。

概念介绍

Login

「登录信息」——实现侧当前的状态。

概念介绍

获取登录信息

获取登录信息。

Authorizations:

satori

Responses

Response samples

200

Content type

application/json

{"user": {"id": "string",
"name": "string",
"nick": "string",
"avatar": "string",
"is_bot": true
},
"self_id": "string",
"platform": "string",
"status": 0,
"features": ["string"
],
"proxy_urls": ["string"
]
}

Message

「消息」——频道中发送的内容。

概念介绍

发送消息

发送一条消息。

Authorizations:

satori

Request Body schema: application/json

发送的目标和消息内容

channel_id required	string (目标频道) 消息要发送到的频道。在 Chronocat，群聊对应的频道为群号，私聊对应的频道为 private: 后跟 QQ 号。
content required	string (消息内容) 消息的内容。格式为 Satori 消息元素字符串。

Responses

Request samples

Payload

Content type

application/json

{"channel_id": "string",
"content": "string"
}

Response samples

200

Content type

application/json

[{"id": "string",
"content": "string",
"channel": {"id": "string",
"name": "string",
"type": 0,
"parent_id": "string",
"avatar": "string"
},
"guild": {"id": "string",
"name": "string",
"avatar": "string"
},
"member": {"user": {"id": "string",
"name": "string",
"nick": "string",
"avatar": "string",
"is_bot": true
},
"nick": "string",
"avatar": "string"
},
"user": {"id": "string",
"name": "string",
"nick": "string",
"avatar": "string",
"is_bot": true
},
"created_at": 0,
"updated_at": 0
}
]

Reaction

「表态」——用户对消息的回应。

概念介绍

User

「用户」——群组内的个体。

概念介绍

获取好友列表

获取好友列表。

Authorizations:

satori

Request Body schema: application/json

分页

next	string (分页令牌) 获取下一页时提供的分页令牌，获取第一页时为空。

Responses

Request samples

Payload

Content type

application/json

{"next": "string"
}

Response samples

200

Content type

application/json

[{"data": [{"id": "string",
"name": "string",
"nick": "string",
"avatar": "string",
"is_bot": true
}
],
"next": "string"
}
]

处理好友申请

处理好友申请。

Authorizations:

satori

Request Body schema: application/json

处理邀请

message_id required	string 请求 ID
approve required	boolean 是否通过请求
comment	string 备注信息

Responses

Request samples

Payload

Content type

application/json

{"message_id": "string",
"approve": true,
"comment": "string"
}

删除好友

删除好友。

Authorizations:

satori

Request Body schema: application/json

用户

user_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"user_id": "string"
}

Satori 欢迎页

展示 Satori 欢迎页面。无任何实际用途。

Authorizations:

None

Responses

获取单个资源

获取单个资源。该 URL 通常为 Satori 服务生成并在事件携带的消息元素中出现。如果客户端无法通过此链接访问到 Chronocat Satori 服务，则需修改配置文件中的 self_url 项。

Authorizations:

None

path Parameters

assetData

required

string

资源信息。通常为 Satori 服务生成。