@ali/ding-ai-minutes-bridge

钉钉 AI 听记桌面端开放 SDK，提供跨 iframe 调用桌面端 JSAPI 的能力。

安装

npm install @ali/ding-ai-minutes-bridge
# 或
pnpm install @ali/ding-ai-minutes-bridge

快速开始

import AIMinutesBridge from '@ali/ding-ai-minutes-bridge'

// 调用桌面端 JSAPI
const result = await AIMinutesBridge.call('methodName', { key: 'value' })

API 文档

初始化配置

// 方式1: 初始化后调用
AIMinutesBridge.init({ enableLog: true })

// 方式2: 链式调用
const result = await AIMinutesBridge
  .init({ enableLog: true })
  .call('methodName', params)

常用方法示例

requestAuthCode 获取免登码

import AIMinutesBridge from '@ali/ding-ai-minutes-bridge'

// 打开调试日志
AIMinutesBridge.init({ enableLog: true })

try {
    // 由于请求由听记域名（https://shanji.dingtalk.com）代理申请，请将https://shanji.dingtalk.com 加入微应用的端内免登地址 
    const result = await AIMinutesBridge.call('requestAuthCode', {
      corpId: 'ding12345' // 填入当前 corpId
    });
    console.log('requestAuthCode success, result', result);
  } catch (error) {
    console.log('requestAuthCode errror', error);
  }

getCurrentTheme 获取当前主题

import AIMinutesBridge from '@ali/ding-ai-minutes-bridge'
try {
    const result = await AIMinutesBridge.call('getCurrentTheme', {});
    console.log('getCurrentTheme success, result', result);
  } catch (error) {
    console.log('getCurrentTheme errror', error);
  }

其他 jsapi

其他jsapi 为内应用调用，三方页面无法使用

call(methodName, params)

调用桌面端 JSAPI。

const result = await AIMinutesBridge.call('methodName', { param1: 'value1' })

参数:

• methodName: string - 方法名
• params?: unknown - 参数对象

返回: Promise<T> - 返回 Promise，resolve 时获取结果

init(config)

初始化 SDK 配置，支持链式调用。

AIMinutesBridge.init({ enableLog: true })

setLogEnabled(enabled)

动态设置日志开关，支持链式调用。

AIMinutesBridge.setLogEnabled(true)

getVersion()

获取 SDK 版本号。

const version = AIMinutesBridge.getVersion() // "1.0.0"

isInIframe()

检查当前是否在 iframe 中运行。

const inIframe = AIMinutesBridge.isInIframe() // true/false

类型导入

import type {
  BridgeConfig,
  BridgeMessage,
  MessagePayload,
  MessageResult,
  ReceivedMessage
} from '@ali/ding-ai-minutes-bridge'