@koishijs/plugin-adapter-line
WARNING
在接入之前,你需要准备一个带有 SSL 证书的公网域名,并将 Koishi 部署到公网。
接入方法
- 在 LINE 开发者控制台 注册账号,创建一个新的 Provider,在 Provider 中创建一个 Channel,类型选择 Messaging API,输入相关信息
- 在 Basic settings 页面找到 Channel secret,填入插件的 secret 字段
- 在 Messaging API 页面底部 Channel access token 处点击 Issue 创建 token,填入插件的 token 字段
- 根据使用需求可在上方的 Allow bot to join group chats (允许机器人加入群组) 处点击 Edit,在新页面中找到 Toggle features 一栏,第一对单选框选择 Allow
- 在 Messaging API 页面底部,根据使用需求点击 Auto-reply messages 或者 Greeting messages 的修改按钮,在新页面中可设置是否启用平台自带的自动回复或问候消息
- 在 Security 页面推荐配置白名单 IP
- 启动插件,打开 Messaging API 页面,勾选 Use webhook
参考文档:https://developers.line.biz/en/docs/messaging-api/getting-started/
配置项
options.token
- 类型:
string
机器人令牌。
options.secret
- 类型:
string
机器人密钥。
内部接口
TIP
关于内部接口的使用方式,请参见 访问内部接口。
internal.audienceMatch()
internal.broadcast()
internal.cancelDefaultRichMenu()
internal.createRichMenu()
internal.createRichMenuAlias()
internal.deleteRichMenu()
internal.deleteRichMenuAlias()
internal.getAdPhoneMessageStatistics()
internal.getAggregationUnitNameList()
internal.getAggregationUnitUsage()
internal.getBotInfo()
internal.getDefaultRichMenuId()
internal.getFollowers()
internal.getGroupMemberCount()
internal.getGroupMemberProfile()
internal.getGroupMembersIds()
internal.getGroupSummary()
internal.getMessageContent()
internal.getMessageContentPreview()
internal.getMessageContentTranscodingByMessageId()
internal.getMessageQuota()
internal.getMessageQuotaConsumption()
internal.getNarrowcastProgress()
internal.getNumberOfSentBroadcastMessages()
internal.getNumberOfSentMulticastMessages()
internal.getNumberOfSentPushMessages()
internal.getNumberOfSentReplyMessages()
internal.getPNPMessageStatistics()
internal.getProfile()
internal.getRichMenu()
internal.getRichMenuAlias()
internal.getRichMenuAliasList()
internal.getRichMenuBatchProgress()
internal.getRichMenuIdOfUser()
internal.getRichMenuImage()
internal.getRichMenuList()
internal.getRoomMemberCount()
internal.getRoomMemberProfile()
internal.getRoomMembersIds()
internal.getWebhookEndpoint()
internal.issueLinkToken()
internal.leaveGroup()
internal.leaveRoom()
internal.linkRichMenuIdToUser()
internal.markMessagesAsRead()
internal.multicast()
internal.pushMessage()
internal.pushMessagesByPhone()
internal.replyMessage()
internal.setDefaultRichMenu()
internal.setRichMenuImage()
internal.setWebhookEndpoint()
internal.testWebhookEndpoint()
internal.unlinkRichMenuIdFromUser()
internal.updateRichMenuAlias()
internal.validateBroadcast()
internal.validateMulticast()
internal.validateNarrowcast()
internal.validatePush()
internal.validateReply()
internal.validateRichMenuBatchRequest()
internal.validateRichMenuObject()