zhamao-framework/docs/api/ZM/API/GoCqhttpAPIV11.md

131 lines
2.3 KiB
Markdown
Raw Normal View History

2022-03-27 16:42:36 +08:00
# ZM\API\GoCqhttpAPIV11
## getGuildServiceProfile
```php
public function getGuildServiceProfile(): array|bool
```
### 描述
获取频道系统内BOT的资料
响应字段nickname, tiny_id, avatar_url
### 返回
| 类型 | 描述 |
| ---- | ----------- |
2022-04-01 18:48:48 +08:00
| array|bool | 返回API调用结果数组或异步API调用状态bool |
2022-03-27 16:42:36 +08:00
## getGuildList
```php
public function getGuildList(): array|bool
```
### 描述
获取频道列表
### 返回
| 类型 | 描述 |
| ---- | ----------- |
2022-04-01 18:48:48 +08:00
| array|bool | 返回API调用结果数组或异步API调用状态bool |
2022-03-27 16:42:36 +08:00
## getGuildMetaByGuest
```php
2022-04-01 18:48:48 +08:00
public function getGuildMetaByGuest(int|string $guild_id): array|bool
2022-03-27 16:42:36 +08:00
```
### 描述
通过访客获取频道元数据
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
2022-04-01 18:48:48 +08:00
| guild_id | int|string | 频道ID |
2022-03-27 16:42:36 +08:00
### 返回
| 类型 | 描述 |
| ---- | ----------- |
2022-04-01 18:48:48 +08:00
| array|bool | 返回API调用结果数组或异步API调用状态bool |
2022-03-27 16:42:36 +08:00
## getGuildChannelList
```php
2022-04-01 18:48:48 +08:00
public function getGuildChannelList(int|string $guild_id, false $no_cache): array|bool
2022-03-27 16:42:36 +08:00
```
### 描述
获取子频道列表
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
2022-04-01 18:48:48 +08:00
| guild_id | int|string | 频道ID |
| no_cache | false | 禁用缓存默认为false |
2022-03-27 16:42:36 +08:00
### 返回
| 类型 | 描述 |
| ---- | ----------- |
2022-04-01 18:48:48 +08:00
| array|bool | 返回API调用结果数组或异步API调用状态bool |
2022-03-27 16:42:36 +08:00
## getGuildMembers
```php
2022-04-01 18:48:48 +08:00
public function getGuildMembers(int|string $guild_id): array|bool
2022-03-27 16:42:36 +08:00
```
### 描述
获取频道成员列表
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
2022-04-01 18:48:48 +08:00
| guild_id | int|string | 频道ID |
2022-03-27 16:42:36 +08:00
### 返回
| 类型 | 描述 |
| ---- | ----------- |
2022-04-01 18:48:48 +08:00
| array|bool | 返回API调用结果数组或异步API调用状态bool |
2022-03-27 16:42:36 +08:00
## sendGuildChannelMsg
```php
2022-04-01 18:48:48 +08:00
public function sendGuildChannelMsg(int|string $guild_id, int|string $channel_id, string $message): array|bool
2022-03-27 16:42:36 +08:00
```
### 描述
发送信息到子频道
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
2022-04-01 18:48:48 +08:00
| guild_id | int|string | 频道ID |
| channel_id | int|string | 子频道ID |
| message | string | 信息内容 |
2022-03-27 16:42:36 +08:00
### 返回
| 类型 | 描述 |
| ---- | ----------- |
2022-04-01 18:48:48 +08:00
| array|bool | 返回API调用结果数组或异步API调用状态bool |