Koishi

简体中文

English
Français

简体中文

English
Français

外观

@koishijs/plugin-adapter-dingtalk ​

TIP

如果选择通信方式为 http，那么你需要准备一个带有 SSL 证书的公网域名，并将 Koishi 部署到公网。

接入方式 ​

  1. 前往 开放平台 > 应用开发 > 钉钉应用 并点击「创建应用」，输入相关信息确定创建
  2. 在跳转至的页面，选择添加「机器人」；勾选「机器人配置」，输入相关信息；消息接收模式选择 Stream 模式 时，插件的 protocol 选择 ws，选择 HTTP 模式 时，将机器人的 selfUrl 值后连接 /dingtalk (如 https://example.com/dingtalk) 填入钉钉平台的消息接收地址，插件的 protocol 选择 http；最后点击发布按钮
  3. 在左侧打开「凭证与基础信息」页面，将 Client ID 填入插件的 appkey 字段，将 Client Secret 填入插件的 secret 字段。
  4. (可选) 为了在控制台中显示应用名称与头像，请参照 添加接口调用权限 操作，申请 qyapi_get_microapp_list 权限；在左侧打开「添加应用能力」，选择添加「网页应用」。将「企业内部应用 AgentId」填入插件的 agentId 字段

配置项 ​

config.protocol ​

  • 可选值: http, ws

要使用的协议类型。

config.secret ​

  • 类型: string
  • 必需选项

机器人密钥。

config.appkey ​

  • 类型: string
  • 必需选项

机器人 AppKey。

config.agentId ​

  • 类型: string
  • 必需选项

机器人 AgentId。

HTTP 配置项 ​

无。

WS 配置项 ​

包括全部的 WsClient 选项。

内部接口 ​

TIP

关于内部接口的使用方式，请参见 访问内部接口。