shkong/OpenShamrock
1
0
Fork 0
mirror of https://github.com/whitechi73/OpenShamrock.git synced 2024-08-14 13:12:17 +08:00
Code Issues Packages Projects Releases Wiki Activity
OpenShamrock/docs/api/contact.md
ikechan8370 2d95a08c11
fix: 格式错误
2023-12-10 19:06:44 +08:00

698 lines
18 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: 联系人相关
icon: address-book
---
::: warning 注意
对于 Shamrock 尚未实现的 API，会在标题添加标记 <Badge text="未实现" type="danger" vertical="baseline" />
:::
## 获取陌生人信息
该接口用于获取陌生人的信息。
### API 端点
`/get_stranger_info`
### 参数
| 字段 | 类型 | 必须 | 说明 |
| ------- | ----- | ---- | ----- |
| user_id | int64 | 是 | QQ 号 |
### 响应
::: warning 注意
该 API 可能会返回不存在于以下表格中的字段，请不要作为参考使用。
:::
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| -------- | ------ | ----- |
| user_id | int64 | QQ 号 |
| nickname | string | 昵称 |
| age | int32 | 年龄 |
| sex | string | 性别 |
| ext | object | 扩展字段（一堆垃圾） |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": {
"user_id": "534103824",
"nickname": "优",
"age": 5,
"sex": "female",
"level": 10,
"login_days": 0,
"qid": "",
"vote": 90,
"wzry_honor": null,
"ext": {
"add_src_id": 0,
"add_src_name": "",
"add_sub_src_id": 0,
"allow_cal_interactive": false,
"allow_click": false,
"allow_people_see": false,
"auth_state": -1,
"big_club_vip_open": 0,
"hollywood_vip_open": 0,
"qq_vip_open": 0,
"super_qq_open": 0,
"super_vip_open": 0,
"voted": 0,
"baby_q_switch": false,
"bind_phone_info": "",
"card_id": 0,
"card_type": 0,
"category": -1,
"clothes_id": 0,
"cover_url": "",
"declaration": null,
"default_card_id": 0,
"diy_complicated_info": null,
"diy_default_text": null,
"diy_text": null,
"diy_text_degree": 0.0,
"diy_text_font_id": 0,
"diy_text_height": 0.0,
"diy_text_width": 0.0,
"diy_text_loc_x": 0.0,
"diy_text_loc_y": 0.0,
"dress_up_is_on": false,
"enc_id": null,
"enlarge_qzone_pic": 0,
"extend_friend_entry_add_friend": 0,
"extend_friend_entry_contact": 0,
"extend_friend_flag": 0,
"extend_friend_question": 0,
"extend_friend_voice_duration": 0,
"favorite_source": 12,
"feed_preview_time": 0,
"font_id": 0,
"font_type": 0,
"qid_bg_url": "",
"qid_color": "",
"qid_logo_url": "https://sola.gtimg.cn/aoi/sola/20200925143823_CqAm9t45Us.png",
"qq_card_is_on": false,
"school_id": null,
"school_name": null,
"school_verified_flag": false,
"show_publish_button": false,
"singer": "",
"song_dura": 0,
"song_id": "",
"song_name": ""
}
}
}
```
:::
## 获取好友列表
该接口用于获取好友列表。
### API 端点
`/get_friend_list`
### 参数
::: tip 提示
该接口无输入参数，除 `refresh` 参数决定是否刷新数据。可能不是立即生效。
:::
### 响应
该接口返回的 `data` 数据为数组，每个元素为一个好友的信息，具体如下。
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| ---------------- | ------ | -------- |
| user_id | int64 | QQ 号 |
| user_name | string | 昵称 |
| user_displayname | string | 显示名 |
| user_remark | string | 备注 |
| age | int32 | 年龄 |
| gender | int32 | 性别 |
| group_id | int64 | 分组 ID |
| platform | string | 平台 |
| term_type | string | 终端类型 |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": [
{
"user_id": 2854200454,
"user_name": "Shamrock",
"user_displayname": "QQ机器人",
"user_remark": "QQ机器人",
"age": 0,
"gender": 0,
"group_id": 0,
"platform": "MOBILE_ANDROID",
"term_type": 65799
},
{
"user_id": 1372362033,
"user_name": "伏秋洛~",
"user_displayname": "伏秋洛~",
"user_remark": "伏秋洛~",
"age": 0,
"gender": 0,
"group_id": 0,
"platform": "MOBILE_PC",
"term_type": 65793
}
]
}
```
:::
## 获取单向好友列表 <Badge text="未实现" type="danger" />
该接口用于获取单向好友列表。
### API 端点
`/get_unidirectional_friend_list`
### 参数
::: tip 提示
该 API 无需参数
:::
### 响应
响应内容为 json 数组, 每个元素如下：
| 字段名 | 数据类型 | 说明 |
| -------- | -------- | ----- |
| user_id | int64 | QQ 号 |
| nickname | string | 昵称 |
| source | string | 来源 |
## 获取群信息
该接口用于获取群信息。
### API 端点
`/get_group_info`
### 参数
| 字段 | 类型 | 必须 | 说明 |
| -------- | ----- | ---- | ---- |
| group_id | int64 | 是 | 群号 |
### 响应
::: warning 注意
该 API 可能会返回不存在于以下表格中的字段，请不要作为参考使用。
:::
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| ---------------- | ------------ | ---------- |
| group_id | int64 | 群号 |
| group_name | string | 群名称 |
| group_remark | string | 群备注 |
| group_uin | int64 | 群 Uin |
| admins | List\<int64> | 管理员列表 |
| class_text | string | 群分类 |
| is_frozen | bool | 是否冻结 |
| max_member | int32 | 最大成员数 |
| max_member_count | int32 | 最大成员数 |
| member_num | int32 | 成员数量 |
| member_count | int32 | 成员数量 |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": {
"group_id": 758533243,
"group_name": "Shamrock",
"group_remark": "",
"group_uin": 758533243,
"admins": [1372362033, 1307993674],
"class_text": "",
"is_frozen": false,
"max_member": 500,
"member_num": 165,
"member_count": 165,
"max_member_count": 500
}
}
```
:::
## 获取群列表
该接口用于获取群列表。
### API 端点
`/get_group_list`
### 参数
::: tip 提示
该 API 无需参数
:::
### 响应
该接口返回的 `data` 数据为数组，每个元素为一个群的信息，具体如下。
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| ---------------- | ------------ | ---------- |
| group_id | int64 | 群号 |
| group_name | string | 群名称 |
| group_remark | string | 群备注 |
| group_uin | int64 | 群 Uin |
| admins | List\<int64> | 管理员列表 |
| class_text | string | 群分类 |
| is_frozen | bool | 是否冻结 |
| max_member | int32 | 最大成员数 |
| max_member_count | int32 | 最大成员数 |
| member_num | int32 | 成员数量 |
| member_count | int32 | 成员数量 |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": [
{
"group_id": 758533243,
"group_name": "Shamrock",
"group_remark": "",
"group_uin": 758533243,
"admins": [1372362033, 1307993674],
"class_text": "",
"is_frozen": false,
"max_member": 500,
"member_num": 165,
"member_count": 165,
"max_member_count": 500
}
]
}
```
:::
## 获取群成员信息
该接口用于获取群成员信息。
### API 端点
`/get_group_member_info`
### 参数
| 字段 | 类型 | 必须 | 说明 |
| -------- | ----- | ---- | ----- |
| group_id | int64 | 是 | 群号 |
| user_id | int64 | 是 | QQ 号 |
### 响应
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| ----------------- | ------------ | ------------------ |
| user_id | int64 | QQ 号 |
| group_id | int64 | 群号 |
| user_name | string | 昵称 |
| sex | string | 性别 |
| title | string | 专属头衔 |
| title_expire_time | int64 | 专属头衔过期时间戳 |
| nickname | string | 群昵称 |
| user_displayname | string | 显示名 |
| distance | int32 | 距离 |
| honor | List\<int32> | 群荣誉 |
| join_time | int64 | 入群时间 |
| last_active_time | int64 | 最后发言时间 |
| last_sent_time | int64 | 最后发言时间 |
| unique_name | string | 群头衔 |
| area | string | 地区 |
| level | string | 成员等级 |
| role | string | 角色 |
| unfriendly | bool | 是否不良记录成员 |
| card_changeable | bool | 是否允许修改群名片 |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": {
"user_id": 1372362033,
"group_id": 758533243,
"user_name": "伏秋洛~",
"sex": "female",
"title": "",
"title_expire_time": 0,
"nickname": "伏秋洛~",
"user_displayname": "",
"distance": 100,
"honor": [3],
"join_time": 1687759547,
"last_active_time": 1697105041,
"last_sent_time": 1697105041,
"unique_name": "",
"area": "",
"level": 10315,
"role": "owner",
"unfriendly": false,
"card_changeable": false
}
}
```
:::
## 获取群成员列表
该接口用于获取群成员列表。
### API 端点
`/get_group_member_list`
### 参数
| 字段 | 类型 | 必须 | 说明 |
| -------- | ----- | ---- | ---- |
| group_id | int64 | 是 | 群号 |
### 响应
该接口返回的 `data` 数据为数组，每个元素为一个群成员的信息，具体如下。
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| ----------------- | ------------ | ------------------ |
| user_id | int64 | QQ 号 |
| group_id | int64 | 群号 |
| user_name | string | 昵称 |
| sex | string | 性别 |
| title | string | 专属头衔 |
| title_expire_time | int64 | 专属头衔过期时间戳 |
| nickname | string | 群昵称 |
| user_displayname | string | 显示名 |
| distance | int32 | 距离 |
| honor | List\<int32> | 群荣誉 |
| join_time | int64 | 入群时间 |
| last_active_time | int64 | 最后发言时间 |
| last_sent_time | int64 | 最后发言时间 |
| unique_name | string | 群头衔 |
| area | string | 地区 |
| level | string | 成员等级 |
| role | string | 角色 |
| unfriendly | bool | 是否不良记录成员 |
| card_changeable | bool | 是否允许修改群名片 |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": [
{
"user_id": 1372362033,
"group_id": 758533243,
"user_name": "伏秋洛~",
"sex": "female",
"title": "",
"title_expire_time": 0,
"nickname": "伏秋洛~",
"user_displayname": "",
"distance": 100,
"honor": [3],
"join_time": 1687759547,
"last_active_time": 1697105041,
"last_sent_time": 1697105041,
"unique_name": "",
"area": "",
"level": 10315,
"role": "owner",
"unfriendly": false,
"card_changeable": false
}
]
}
```
:::
## 获取群荣誉信息
该接口用于获取群荣誉信息。
### API 端点
`/get_group_honor_info`
### 参数
| 字段 | 类型 | 必须 | 说明 |
| -------- | ----- | ---- | ---- |
| group_id | int64 | 是 | 群号 |
### 响应
| 字段 | 类型 | 说明 |
| ------------------ | ----------------------------- | ---------- |
| group_id | int64 | 群号 |
| current_talkative | List<[HonorInfo](#honorinfo)> | 当前龙王 |
| talkative_list | List<[HonorInfo](#honorinfo)> | 历史龙王 |
| performer_list | List<[HonorInfo](#honorinfo)> | 群聊之火 |
| legend_list | List<[HonorInfo](#honorinfo)> | 群聊炽焰 |
| strong_newbie_list | List<[HonorInfo](#honorinfo)> | 冒尖小春笋 |
| emotion_list | List<[HonorInfo](#honorinfo)> | 快乐之源 |
| all | List<[HonorInfo](#honorinfo)> | 全部荣誉 |
#### HonorInfo
| 字段 | 类型 | 说明 |
| ----------- | ------ | -------- |
| user_id | int64 | QQ 号 |
| nickname | string | 昵称 |
| avatar | string | 头像链接 |
| day_count | int32 | 持续天数 |
| id | int32 | ID |
| description | string | 描述 |
## 获取群系统消息
该接口用于获取群系统消息。
### API 端点
`/get_group_system_msg`
### 响应
| 字段 | 类型 | 说明 |
| ---------------- | --------------------------------------- | ------------ |
| invited_requests | List<[InvitedRequest](#invitedrequest)> | 邀请消息列表 |
| join_requests | List<[JoinRequest](#joinrequest)> | 进群消息列表 |
::: warning 注意
如果列表不存在任何消息, 将返回 `null`
:::
#### InvitedRequest
| 字段 | 类型 | 说明 |
| ------------ | ------ | ----------------- |
| request_id | int64 | 请求ID |
| invitor_uin | int64 | 邀请者 |
| invitor_nick | string | 邀请者昵称 |
| group_id | int64 | 群号 |
| group_name | string | 群名 |
| checked | bool | 是否已被处理 |
| actor | int64 | 处理者, 未处理为0 |
| requester_uin| int64 | 被邀请者ID |
| flag | string | flag,用于处理请求 |
#### JoinRequest
| 字段 | 类型 | 说明 |
| -------------- | ------ | ----------------- |
| request_id | int64 | 请求ID |
| requester_uin | int64 | 请求者ID |
| requester_nick | string | 请求者昵称 |
| message | string | 验证消息 |
| group_id | int64 | 群号 |
| group_name | string | 群名 |
| checked | bool | 是否已被处理 |
| actor | int64 | 处理者, 未处理为0 |
| flag | string | flag,用于处理请求 |
## 获取好友系统消息
该接口用于获取好友系统消息。
### API 端点
`/get_friend_system_msg`
### 响应
该接口返回的 `data` 数据为数组，每个元素为一个好友请求的系统信息，具体如下。
::: tabs
@tab 响应字段
| 字段 | 类型 | 说明 |
| ---------------- | ------ | -------- |
| request_id | int64 | 请求id |
| requester_uin | int64 | 请求者QQ号 |
| requester_nick | string | 请求者昵称 |
| source | string | 来源 |
| message | string | 附加消息 |
| source_group_name | string | 来源群名称，仅当从群添加好友时存在 |
| source_group_id | int64 | 来源群号，仅当从群添加好友时存在 |
| sex | string | 请求者性别 |
| age | string | 请求者年龄 |
| msg_detail | string | 处理结果 |
| status | string | 可选值：`已同意`、`已拒绝`，为空则表示尚未处理 |
| flag | string | flag,用于处理请求 |
@tab 响应示例
```json
{
"status": "ok",
"retcode": 0,
"data": [
{
"request_id": 1702011024000000,
"requester_uin": 1234567890,
"requester_nick": "流月e",
"source": "QQ群-群名称",
"message": "我是流月e",
"source_group_name": "群名称",
"source_group_id": 1234567890,
"flag": "1702011024000000;3004;3;1234567890",
"sex": "female",
"age": 23,
"msg_detail": "",
"status": ""
},
{
"request_id": 1702010997000000,
"requester_uin": 1234567891,
"requester_nick": "是铃音啦",
"source": "QQ群",
"message": "",
"source_group_name": "",
"source_group_id": 0,
"flag": "1702010997000000;6;1;1234567891",
"sex": "male",
"age": 0,
"msg_detail": "",
"status": ""
}
]
}
```
:::
## 获取精华消息列表
该接口用于获取精华消息列表。
### API 端点
`/get_essence_msg_list`
### 参数
| 字段 | 类型 | 说明 |
| -------- | ----- | ---- |
| group_id | int64 | 群号 |
### 响应
响应内容为 JSON 数组，每个元素如下：
| 字段名 | 数据类型 | 说明 |
| ------------- | -------- | ------------ |
| sender_id | int64 | 发送者QQ 号 |
| sender_nick | string | 发送者昵称 |
| sender_time | int64 | 消息发送时间 |
| operator_id | int64 | 操作者QQ 号 |
| operator_nick | string | 操作者昵称 |
| operator_time | int64 | 精华设置时间 |
| message_id | int32 | 消息ID，可能为0表示找不到消息映射 |
| message_seq | int32 | 消息seq |
## QQ是否在黑名单内
获取好友/陌生人是否处于黑名单列表。
### API 端点
`/is_blacklist_uin`
### 参数
| 字段 | 类型 | 必须 | 说明 |
| ------- | ----- | ---- | ------ |
| user_id | int64 | 是 | QQ账号 |
### 响应
| 字段 | 类型 | 说明 |
| ---- | ---- | ------------ |
| is | bool | 是否是黑名单 |
Reference in New Issue View Git Blame Copy Permalink