创建频道 API 权限授权链接

用于创建 API 接口权限授权链接，该链接指向 guildID 对应的频道 。调用成功后，参数指定的子频道会受到一条”申请授权【xxx】权限“消息，管理员点击可进行机器人 API 权限授予。

:::warning 注意

  • 需要建立 ws 连接。
  • 每天只能在一个频道内发 3 条（默认值）频道权限授权链接，如需调整，请联系平台申请权限。

:::

使用示例

  1. token := token.BotToken("appid", "token")
  2. api := botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
  3. ctx := context.Background()
  5. permissionDemand, err := api.RequireAPIPermissions(ctx, guildId, &dto.APIPermissionDemandToCreate{
  6.   ChannelID: channelId,
  7.   APIIdentify: &dto.APIPermissionDemandIdentify{
  8.     Path:   "/guilds/{guild_id}",
  9.     Method: "GET",
  10.   },
  11.   Desc: "机器人申请对应的 API 接口权限后可以使用功能的描述",
  12. })
  13. if err != nil {
  14.   log.Fatalln("调用 RequireAPIPermissions 接口失败, err = ", err)
  15. }

参数说明

字段名 必填 类型 描述
guildId 是 string 频道 ID
demand 是 APIPermissionDemandToCreate 授权链接对象

APIPermissionDemandToCreate

字段名 必填 类型 描述
ChannelID 是 string 授权链接发送的子频道 ID
APIIdentify 是 APIPermissionDemandIdentify API 权限需求标识对象
Desc 否 string 机器人申请对应的 API 接口权限后可以使用功能的描述

APIPermissionDemandIdentify

字段名 类型 描述
Path string API 接口名，例如 /guilds/{guild_id}/members/{user_id}
Method string 请求方法，例如 GET

返回说明

返回 APIPermissionDemand对象。

APIPermissionDemand

字段名 类型 描述
GuildID string 申请接口权限的频道 ID
ChannelID string 接口权限需求授权链接发送的子频道 ID
APIIdentify APIPermissionDemandIdentify 权限接口唯一标识
Title string 接口权限链接中的接口权限描述信息
Desc string 接口权限链接中的机器人可使用功能的描述信息

返回示例

data：

  1. {
  2.   "guild_id": "123456",
  3.   "channel_id": "112233",
  4.   "api_identify": {
  5.     "path": "/guilds/{guild_id}",
  6.     "method": "GET"
  7.   },
  8.   "title": "申请授权【获取频道】权限",
  9.   "desc": "允许授权后才能正常使用机器人「频道权限」功能"
  10. }

此时打开”ChannelID“对应的频道，可看到一条机器人发出的 API 授权申请消息。