适用对象

这个页面是给谁用的?

先看角色,再看接口。开放平台页不是给普通访客泛泛了解产品用的,而是给正在评估“业务系统怎么接入即时通讯能力”的团队快速判断接入边界、接口模块和实施方式。 如果你正在做 OA、门户、ERP、CRM、生产系统、运维平台或行业业务平台接入,这个页面可以帮助你快速判断:小天互连开放平台能不能把私有化即时通讯能力接入现有业务系统,哪些场景适合走开放 API,哪些场景更适合走 SDK,以及接入前需要关注账号、组织、消息、待办、权限和网络环境等问题。

企业信息化负责人

判断开放平台是否适合统一消息入口、系统协同和私有化即时通讯建设。

开发与实施团队

查看接口模块、组织同步、消息推送、统一待办、文件管理和会议能力。

系统集成商与方案方

确认 API 和 SDK 的接入边界,判断与 OA、门户、ERP、CRM、行业平台的适配方式。

完整开发文档在 easydoc 平台

以下为 API 能力索引总览,完整参数说明、请求 / 响应示例请查看 小天互连开发文档。 如有集成咨询,请拨打 400-609-0086提交申请

API vs SDK

开放平台 API 和即时通讯 SDK 有什么区别

二者都属于小天互连的接入能力,但承接的问题不同。API 偏系统打通,SDK 偏应用内嵌。企业可以根据自身是要“让业务系统调用消息能力”,还是要“把即时通讯能力嵌入前端”来判断。

开放平台 API:让业务系统调用即时通讯能力

适合已有 OA、门户、ERP、CRM、HR、生产系统、运维系统或行业平台,希望通过接口调用消息推送、组织同步、统一认证和待办提醒能力的企业。

  • 重点解决系统之间的连接问题
  • 适合消息推送、统一待办、组织账号同步
  • 更关注业务系统集成和统一消息入口
  • 常用于私有化部署、内网协同和多系统联动场景
VS

即时通讯 SDK:把聊天能力嵌入应用前端

适合企业自研 App、门户、行业平台或业务系统前端,希望在自己的界面中嵌入单聊、群聊、通讯录、文件收发、音视频等即时通讯能力。

  • 重点解决应用内嵌 IM 的问题
  • 适合 App 内聊天、网页聊天和业务会话
  • 更关注前端体验、终端适配和会话能力
  • 常用于自研系统、行业平台和移动端 App 集成
适用业务系统

哪些业务系统适合接入开放平台

只要业务系统中存在“人、组织、消息、流程、提醒、待办、审批、告警”这些要素,就适合评估开放平台接入。小天互连开放平台更适合作为企业即时通讯与业务系统之间的连接层。

OA 与流程系统

用于审批提醒、流程催办、待办通知、公告触达和组织同步,减少员工在多个系统间切换。

统一门户系统

将门户入口、应用菜单、通知中心和消息能力打通,形成统一的企业工作入口。

ERP / CRM / HR 系统

适合订单提醒、客户通知、人事变更、合同审批、库存预警等业务消息触达。

生产与制造系统

用于生产异常、设备告警、工单提醒、质量问题和跨部门协同消息推送。

运维与监控平台

适合服务器告警、应用异常、安全事件、值班通知和应急协同消息触达。

行业业务平台

医疗、政务、金融、教育等行业系统可通过开放平台接入消息、组织和账号能力。

接入实施流程

开放平台接入一般怎么实施

开放平台接入不应只看接口文档,还要看企业已有系统、账号来源、组织结构、网络环境和权限边界。通常可以按照“先梳理、再对接、再联调、再上线”的路径推进。
1

梳理接入系统

明确要接入的 OA、门户、ERP、CRM、HR、生产系统或行业平台,以及各系统需要调用的消息场景。

2

确认账号与组织

确认账号来源、组织架构、人员关系、角色权限和统一认证方式,避免后期出现身份割裂。

3

接口开发与联调

根据消息推送、待办提醒、组织同步、登录认证等场景完成接口开发,并进行联调测试。

4

上线验证与运维

上线前验证消息触达、权限边界、异常处理和日志记录,上线后结合运维机制持续优化。

SDK & API

四类集成方式

根据你的技术栈选择对应的集成方式。

服务端 REST API

Java / Python / Go 均可调用,消息推送、组织管理、待办集成等。

REST API

iOS / Android SDK

将即时通讯能力原生嵌入企业自有 App,支持鸿蒙 HarmonyOS。

Mobile SDK

PC 客户端 SDK

Windows / macOS / Linux 桌面端集成,支持信创国产系统。

PC SDK

JS-SDK / uniapp

网页端嵌入即时通讯,uniapp 跨端开发支持。

JS-SDK
Open API

API 能力全览

所有 API 均部署在企业私有化服务器内网,调用数据不经过第三方节点。当前共 7 个模块,建议先从左侧模块导航查看,再在右侧阅读接口能力、适用场景和接口列表。

鉴权管理

用于单点登录、应用鉴权和用户令牌获取,是开放平台接入的第一步。适合企业统一认证、SSO 登录和接口调用授权场景。

统一认证单点登录令牌可控多系统联动 SSO 登录应用鉴权用户令牌
POST
单点登录说明与流程SSO 登录参数与流程说明
POST
单点登录验证接口/OAapp/v1/open-api/auth/sso-verify
GET
获取应用访问令牌/OAapp/v1/open-api/auth/get-token
GET
获取用户令牌/OAapp/v1/open-api/auth/get-user-token

组织机构管理

用于部门与人员数据的新增、查询、更新和删除,适合企业组织同步、通讯录维护和业务系统账号统一场景。

组织同步账号维护权限边界通讯录统一 部门同步用户同步组织架构联动
POST
添加部门/OAapp/v1/open-api/org/dept/add
GET
取得部门信息/OAapp/v1/open-api/org/dept/get
PUT
更新部门/OAapp/v1/open-api/org/dept/update
DEL
删除部门/OAapp/v1/open-api/org/dept/delete
GET
获取用户/OAapp/v1/open-api/org/user/get
POST
添加用户/OAapp/v1/open-api/org/user/add
PUT
更新用户/OAapp/v1/open-api/org/user/update
DEL
删除用户/OAapp/v1/open-api/org/user/delete

消息推送

用于业务通知、流程提醒、告警消息和问答回调等场景,让业务系统可以直接调用即时通讯能力完成消息触达。

消息触达提醒可控回调灵活业务通知 流程提醒系统告警Bot 回调
POST
发送消息/OAapp/v1/open-api/message/send
PUT
更新消息/OAapp/v1/open-api/message/update
DEL
删除消息/OAapp/v1/open-api/message/delete
POST
消息问答(Bot 回调)/OAapp/v1/open-api/message/qa

文件管理

用于文件上传、下载和通过 URL 导入文件,适合审批附件、资料分发、业务协作文件流转等场景。

文件流转附件管理资料协同下载可控 文件上传附件下载URL 导入
GET
通过文件临时ID下载/OAapp/v1/open-api/file/download/tmp
GET
通过文件ID下载/OAapp/v1/open-api/file/download
POST
文件上传/OAapp/v1/open-api/file/upload
POST
通过URL上传文件/OAapp/v1/open-api/file/upload/url

统一待办

用于把不同业务系统中的待办事项统一推送到即时通讯端,适合 OA、审批、任务和项目系统的一体化待办触达。

待办集中及时提醒状态更新流程系统 审批待办任务提醒状态同步
POST
发送待办/OAapp/v1/open-api/todo/send
PUT
更新待办/OAapp/v1/open-api/todo/update
DEL
删除待办/OAapp/v1/open-api/todo/delete

业务群

用于围绕业务场景快速创建群组、添加成员和关闭协作群,适合项目协作、事项协作和临时工作群场景。

快速建群聚焦协作成员管理项目协同 项目群事项群临时协同群
POST
创建业务群/OAapp/v1/open-api/group/create
POST
添加业务群成员/OAapp/v1/open-api/group/member/add
POST
关闭业务群/OAapp/v1/open-api/group/close
DEL
删除业务群成员/OAapp/v1/open-api/group/member/delete

会议管理

用于快速会议、预约会议以及会议信息维护,适合内部会商、业务协调和远程协作场景。

快速会议日程管理信息追溯远程协作 快速会议预约会议会议查询
GET
取得用户当前会议信息/OAapp/v1/open-api/meeting/current
GET
取得用户历史会议信息/OAapp/v1/open-api/meeting/history
POST
创建快速会议/OAapp/v1/open-api/meeting/quick
POST
创建预约会议/OAapp/v1/open-api/meeting/schedule
PUT
编辑会议信息/OAapp/v1/open-api/meeting/update
客户端 SDK

四端 SDK 集成能力

原生 SDK 可将即时通讯能力深度嵌入企业自有 App,支持消息、会话、通讯录、音视频全功能。

iOS SDK

Objective-C / Swift,支持 iPhone & iPad。

集成配置与初始化(HtImClientManager)
登录 / 退出登录(doHtLoginWithLoginConfigM)
加载动态门户 / 消息列表 / 通讯录
进入指定用户聊天页(goChatViewWith: uuid)
扫一扫 / 发送邮件 / 待办列表 / 发起申请
信息发布 / 发送通知(goSendNotice)

Android SDK

Java / Kotlin,支持 Android 8.0+,含鸿蒙。

Android 端快速接入与 Gradle 依赖配置
登录 / 退出 / 账号切换
加载门户 / 消息列表 / 通讯录 / 待办
指定用户聊天 / 群组操作
消息推送适配(华为 / 小米 / OPPO 等厂商)
扫一扫 / 审批入口调用

PC SDK

Windows / macOS / Linux 信创,桌面端嵌入。

SDK 引用与初始化配置
打开个人聊天会话
创建群组并进行聊天
打开指定群组聊天 / 查看群信息
群成员添加 / 删除群成员
支持统信UOS / 银河麒麟信创系统

JS-SDK / uniapp

Web 端嵌入 · 跨平台小程序开发。

JS-SDK 网页端消息接入与会话嵌入
uniapp SDK 跨端调用接口示例
用户身份绑定与 SSO 打通
消息收发 / 会话管理 / 事件监听
支持企业门户内嵌使用
回调处理与错误码说明
延伸阅读

接入开放平台之后,还应该继续看哪些内容?

开放平台不是孤立能力,它通常会和 SDK 接入、系统集成、私有化部署、信创适配、技术架构一起评估。下面把相关能力页和知识文章集中整理出来,帮助企业继续判断“能不能接、怎么接、接完后怎么长期运行”。

相关能力页

FAQ

开放平台常见问题

以下问题适合企业在评估即时通讯开放平台、API 接入和业务系统集成前先做判断。
主要解决企业现有业务系统与私有化即时通讯系统之间的连接问题,包括统一认证、组织同步、消息推送、统一待办、业务群协作、文件管理、视频会议和多端 SDK 接入。
开放平台更偏向让 OA、门户、ERP、CRM、HR、生产系统、运维平台等业务系统调用即时通讯能力;即时通讯 SDK 更偏向把聊天、会话、通讯录、音视频等能力嵌入企业自研 App、网页或桌面端。
可以。开放平台可与 OA 系统对接,用于单点登录、组织同步、审批消息提醒、统一待办推送、业务通知触达和流程状态更新。
支持。小天互连开放平台可以部署在企业私有化服务器、内网、专网或专有云环境中,接口调用数据不经过第三方节点,更适合对数据边界和内网协同有要求的组织。
接入前通常需要梳理接入系统、账号体系、组织数据来源、消息推送场景、待办规则、权限边界、网络环境和上线验证方式,再进行接口联调。

需要集成帮助?

技术顾问可协助评估集成方案,提供沙盒环境和接入支持。

查看开发文档 申请开发者账号
在线咨询
400-609-0086
电话咨询
立即试用
返回顶部