# @capacitor-community/intercom 中文文档 规范地址：https://npmcn.com/package/%40capacitor-community/intercom/ 版本：8\.0\.0 npm 元数据更新时间：2026-10-23T21:47:57.706Z 中文译文更新时间：2026-11-09T02:31:51.888Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40capacitor-community/intercom 原文对照：https://npmcn.com/package/%40capacitor-community/intercom/?lang=original 项目主页：https://github.com/capacitor-community/intercom#readme 源码仓库：https://github.com/capacitor-community/intercom ## 关键信息（来自 npm 元数据） - 包体积（解压后）：91.5 kB，25 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - Node.js 要求：\>=22\.0\.0 - 运行依赖：0 个 - peer 依赖：@capacitor/core \>=8\.0\.0 - 首次发布：2020-06-27T18:36:17.805Z - 最新版本发布：2026-03-24T15:22:10.734Z - 近 30 天下载量：103683（2026-10-09 至 2026-11-07，npm 官方下载统计） - 已发布版本数：27（近 12 个月 2 个） ## 中文简介 为 Capacitor app 启用 Intercom 特性 ## 安装 ```sh npm install @capacitor-community/intercom ``` 也可以使用：`pnpm add @capacitor-community/intercom`、`yarn add @capacitor-community/intercom`、`bun add @capacitor-community/intercom` ## README ![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png) ### 电容对讲机 **`@capacitor-community/intercom`** 启用Intercom 能力的电容社区插件 ![](https://img.shields.io/maintenance/yes/2025?style=flat-square) [![](https://img.shields.io/npm/l/@capacitor-community/intercom?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/intercom) [![](https://img.shields.io/npm/dw/@capacitor-community/intercom?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/intercom) [![](https://img.shields.io/npm/v/@capacitor-community/intercom?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/intercom) [![](https://img.shields.io/badge/all%20contributors-22-orange?style=flat-square)](https://npmcn.com/package/%40capacitor-community/intercom/#readme-contributors) ## 维护者 | 维护者 | GitHub 图像 | 社会 | | --- | --- | --- | | 斯特万·席尔瓦 | [炖鱼](https://github.com/stewones) | [@stewones (英语)](https://x.com/stewones) | ## 兼容性 | 电容 | 对讲机iOS | Intercom Android 软件 | iOS 目标 | Android 目标 | | --- | --- | --- | --- | --- | | 8.x 电话 | 18.x 国家 | 17.x (中文(简体) ) | 15.0 (韩语) | 第36条 | | 7.x 电话 | 18.x 国家 | 15.x (中文(简体) ) | 15.0 (韩语) | 35个 | | 6.x (单位:千美元) | 16.x (韩语) | 12.x (中文(简体) ) | 13.0 (韩语) | 页:1 | > 说明: 此插件跟随语义版本 [电容](https://github.com/ionic-team/capacitor/blob/main/CHANGELOG.md) 并保持与Intercom SDKs的兼容性([iOS系统](https://github.com/intercom/intercom-ios/releases), (中文(简体) ), [机器人](https://github.com/intercom/intercom-android/releases)) (中文(简体) ). 如果你遇到任何问题 因为版本不一致,请 [打开一个问题](https://github.com/capacitor-community/intercom/issues/new?template=bug_report.md) 帮助我们改进插件. ## 安装 使用 npm : ```bash npm install @capacitor-community/intercom ``` 使用线条 : ```bash yarn add @capacitor-community/intercom ``` 同步本地文件 : ```bash npx cap sync ``` ## 使用量 ```js import { Intercom } from '@capacitor-community/intercom'; import { PushNotifications } from '@capacitor/push-notifications'; // Register for push notifications from Intercom PushNotifications.register(); // Register an identified user Intercom.registerIdentifiedUser({ userId: 123456 }); Intercom.registerIdentifiedUser({ email: 'test@example.com' }); Intercom.registerIdentifiedUser({ userId: 123456, email: 'test@example.com' }); // Register a log event Intercom.logEvent({ name: 'my-event', data: { pi: 3.14 } }); // Display the message composer Intercom.displayMessageComposer({ message: 'Hello there!' }); // Identity Verification // https://developers.intercom.com/installing-intercom/docs/ios-identity-verification Intercom.setUserHash({ hmac: 'xyz' }); // Secure Your Messenger // https://developers.intercom.com/installing-intercom/ios/secure-your-messenger Intercom.setUserJwt({ jwt: 'xyz' }); ``` ## iOS 设置 - `ionic start my-cap-app --capacitor` - `cd my-cap-app` - `npm install @capacitor-community/intercom` - `mkdir www && touch www/index.html` - `npx cap add ios` - 在电容器的配置文件上添加接口密钥 ``` { … "plugins": { "Intercom": { "iosApiKey": "ios_sdk-xxx", "iosAppId": "yyy" } } … } ``` - `npx cap open ios` - 在 xcode( 一般标签) 签名您的应用程序 > 提示:每次您更改本地代码时, 您可能需要清理缓存( Product > Clean building文件夹) , 然后再次运行应用程序 . ## 机器人设置 - `ionic start my-cap-app --capacitor` - `cd my-cap-app` - `npm install @capacitor-community/intercom` - `mkdir www && touch www/index.html` - `npx cap add android` - 在电容器的配置文件上添加接口密钥 ``` { … "plugins": { "Intercom": { "androidApiKey": "android_sdk-xxx", "androidAppId": "yyy" } } … } ``` - `npx cap open android` 现在你该走了 尝试使用 `ionic cap run android --livereload`。 。 。 . > 提示:每次您更改本地代码, 您可能需要清理缓存( Build > Clean Project QQ Build > Rebuilt Project) , 然后再次运行应用程序 . ## API 密码 - [`loadWithKeys(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-loadwithkeys) - [`registerIdentifiedUser(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-registeridentifieduser) - [`registerUnidentifiedUser()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-registerunidentifieduser) - [`updateUser(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-updateuser) - [`logout()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-logout) - [`logEvent(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-logevent) - [`displayMessenger()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displaymessenger) - [`displayMessageComposer(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displaymessagecomposer) - [`displayHelpCenter()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displayhelpcenter) - [`hideMessenger()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-hidemessenger) - [`displayLauncher()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displaylauncher) - [`hideLauncher()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-hidelauncher) - [`displayInAppMessages()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displayinappmessages) - [`hideInAppMessages()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-hideinappmessages) - [`displayCarousel(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displaycarousel) - [`setUserHash(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-setuserhash) - [`setUserJwt(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-setuserjwt) - [`setBottomPadding(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-setbottompadding) - [`sendPushTokenToIntercom(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-sendpushtokentointercom) - [`receivePush(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-receivepush) - [`displayArticle(...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-displayarticle) - [`addListener('windowDidShow', ...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-addlistenerwindowdidshow-) - [`addListener('windowDidHide', ...)`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-addlistenerwindowdidhide-) - [`removeAllListeners()`](https://npmcn.com/package/%40capacitor-community/intercom/#readme-removealllisteners) - [接口](https://npmcn.com/package/%40capacitor-community/intercom/#readme-interfaces) ### 装入 Keys (...) ```typescript loadWithKeys(options: { appId?: string; apiKeyIOS?: string; apiKeyAndroid?: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ appId?: string; apiKeyIOS?: string; apiKeyAndroid?: string; }` | * * * ### 注册识别用户(...) ```typescript registerIdentifiedUser(options: { userId?: string; email?: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ userId?: string; email?: string; }` | * * * ### 未识别用户 () ```typescript registerUnidentifiedUser() => Promise ``` * * * ### 更新用户(...) ```typescript updateUser(options: IntercomUserUpdateOptions) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `[IntercomUserUpdateOptions](https://npmcn.com/package/%40capacitor-community/intercom/#readme-intercomuserupdateoptions)` | * * * ### 登录( c) ```typescript logout() => Promise ``` * * * ### 日志事件(...) ```typescript logEvent(options: { name: string; data?: any; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ name: string; data?: any; }` | * * * ### 显示信使( ) ```typescript displayMessenger() => Promise ``` * * * ### 显示MessageComposer (...) ```typescript displayMessageComposer(options: { message: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ message: string; }` | * * * ### 显示帮助中心( C) ```typescript displayHelpCenter() => Promise ``` * * * ### 隐藏信使( C) ```typescript hideMessenger() => Promise ``` * * * ### 显示 Launcher () ```typescript displayLauncher() => Promise ``` * * * ### 隐藏 Launcher () ```typescript hideLauncher() => Promise ``` * * * ### 显示 ImpMessages () ```typescript displayInAppMessages() => Promise ``` * * * ### 隐藏 InAppMessages () ```typescript hideInAppMessages() => Promise ``` * * * ### 显示 Carousel (...) ```typescript displayCarousel(options: { carouselId: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ carouselId: string; }` | * * * ### 设置 UserHash (...) ```typescript setUserHash(options: { hmac: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ hmac: string; }` | * * * ### 设置用户Jwt(...) ```typescript setUserJwt(options: { jwt: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ jwt: string; }` | * * * ### 设置 BottomPadding(...) ```typescript setBottomPadding(options: { value: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ value: string; }` | * * * ### 发送 PushTokenTo Intercom (...) ```typescript sendPushTokenToIntercom(options: { value: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ value: string; }` | * * * ### 接收 Push (...) ```typescript receivePush(notification: IntercomPushNotificationData) => Promise ``` | 参数 | 类型 | | --- | --- | | **`notification`** | `[IntercomPushNotificationData](https://npmcn.com/package/%40capacitor-community/intercom/#readme-intercompushnotificationdata)` | * * * ### 显示文章(...) ```typescript displayArticle(options: { articleId: string; }) => Promise ``` | 参数 | 类型 | | --- | --- | | **`options`** | `{ articleId: string; }` | * * * ### 添加倾听器( '窗口显示',...) ```typescript addListener(eventName: 'windowDidShow', listenerFunc: () => void) => Promise ``` | 参数 | 类型 | | --- | --- | | **`eventName`** | `'windowDidShow'` | | **`listenerFunc`** | `() => void` | **回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/intercom/#readme-pluginlistenerhandle)>` * * * ### 添加倾听器( '窗口隐藏',...) ```typescript addListener(eventName: 'windowDidHide', listenerFunc: () => void) => Promise ``` | 参数 | 类型 | | --- | --- | | **`eventName`** | `'windowDidHide'` | | **`listenerFunc`** | `() => void` | **回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/intercom/#readme-pluginlistenerhandle)>` * * * ### 删除所有收听器( ) ```typescript removeAllListeners() => Promise ``` * * * ### 接口 #### 用户间更新选项 | Prop | 类型 | | --- | --- | | **`userId`** | `string` | | **`email`** | `string` | | **`name`** | `string` | | **`phone`** | `string` | | **`languageOverride`** | `string` | | **`customAttributes`** | `{ [key: string]: any; }` | #### 互通通知数据 | Prop | 类型 | | --- | --- | | **`conversation_id`** | `string` | | **`message`** | `string` | | **`body`** | `string` | | **`author_name`** | `string` | | **`image_url`** | `string` | | **`app_name`** | `string` | | **`receiver`** | `string` | | **`conversation_part_type`** | `string` | | **`intercom_push_type`** | `string` | | **`uri`** | `string` | | **`push_only_conversation_id`** | `string` | | **`instance_id`** | `string` | | **`title`** | `string` | | **`priority`** | `number` | #### 插件听筒 | Prop | 类型 | | --- | --- | | **`remove`** | `() => Promise` | ## 通知 我们从一个正式的Ong开始 如果您使用上一个 npm 软件包 `capacitor-intercom`请更新您的软件包 `@capacitor-community/intercom`检查 [更改日志](https://npmcn.com/CHANGELOG.md) 需要更多信息. ## 从 Capacitor v2 切换到 v3 - `UserUpdateOptions` 选项类型变为 `IntercomUserUpdateOptions` - `IntercomPlugin` 配置密钥变为 `Intercom` - `android-apiKey` 配置密钥变为 `androidApiKey` - `android-appId` 配置密钥变为 `androidAppId` - `ios-apiKey` 配置密钥变为 `iosApiKey` - `ios-appId` 配置密钥变为 `iosAppId` - [从 CAPBridge 切换到应用程序DelegateProxy](https://capacitorjs.com/docs/updating/3-0#switch-from-capbridge-to-applicationdelegateproxy-in-application-events) 应用事件 - 从您的应用程序中删除整个创建初始化 `MainActivity.java` ```diff public class MainActivity extends BridgeActivity { - @Override - public void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - - // Initializes the Bridge - this.init(savedInstanceState, new ArrayList>() {{ - // Additional plugins you've installed go here - add(IntercomPlugin.class); - }}); - } } ``` ## 许可证 麻省理工学院 ## 示例 - [https://github.com/concessor-community/intercom/blob/master/example (中文(简体) )](https://github.com/capacitor-community/intercom/blob/master/example) ## 贡献者 感谢这些伟大的人[emoji 密钥](https://allcontributors.org/docs/en/emoji-key):
Stew
缝
💻 📖		David Seek
大卫 寻找
💻		Roman Nikitin
罗马尼基丁
💻		Anne Tomassoni
安妮·托马索尼
💻 👀		Maciej Modzelewski
迈凯伊·莫泽列夫斯基
💻		Oleg Yuzvik
奥列格·尤兹维克
🚧		Gustavo Corrêa Alves
古斯塔沃·科里亚·阿尔维斯
📖
Jealvia
捷尔维亚
🚧		Adam Duren
亚当·杜伦
💻 🚧		Rami Khafagi
拉米・哈法吉
💻		Masahiko Sakakibara
坂原正彦
🚧		Dejardin Camille
德雅尔丁·卡米尔
💻		Mohamed Abdelgwad
穆罕默德·阿卜杜勒格瓦德
🚧		Nathan
内森
🚧
Cecil Wöbker
塞西尔·沃克
💻 🚧		Pavlo Pyrig
Pavlo 派里格语Name
💻		Ruan
鲁恩
💻		RickJeroen
瑞克・杰伦
🚧		reslear
换行
📖		Philipp Matter
菲利普物质
💻		Josh Pike
乔希·派克
🚧
vtorenaintermedia
虚拟媒体
💻
本项目遵循 [全部贡献者](https://github.com/all-contributors/all-contributors) 规格。 任何捐款都欢迎! ## 常见问题 ### @capacitor-community/intercom 是什么？ 为 Capacitor app 启用 Intercom 特性 ### 如何安装 @capacitor-community/intercom？ 在项目目录运行 npm install @capacitor-community/intercom，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @capacitor-community/intercom 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @capacitor-community/intercom 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @capacitor-community/intercom 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @capacitor-community/intercom 可以商用吗？ @capacitor-community/intercom 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @capacitor-community/intercom 的下载量有多少？ 根据 npm 官方下载统计，@capacitor-community/intercom 在 2026/10/09 – 2026/11/07 这 30 天内被下载 103,683 次，日均约 3,456 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @capacitor-community/intercom 还在维护吗？ 最新版本 8\.0\.0 发布于 2026/03/24（7 个月前）；至今共发布 27 个版本，其中过去 12 个月发布了 2 个；首次发布于 2020/06/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。