开发者 / DEVELOPERS

先跑通消息链路,
再展开你的产品想象。

从跨平台 IM SDK 到服务端 REST API,先理解身份、连接、会话与消息的协作关系。这里提供安汇聊接入流程概览和示意代码,正式 SDK 包、接口版本与下载方式需在接入时确认。若需先了解长连接、心跳或接口用语,可查阅安汇聊即时通讯术语表。

选择你的接入平台

平台范围用于前期选型。可用版本、支持的消息能力、最低系统要求与授权范围,以项目提供的 SDK 文档为准。

Android

原生应用接入;重点确认系统版本、后台连接策略和推送通道。

Kotlin / Java 接入评估

iOS

原生应用接入;确认系统版本、应用生命周期及通知权限。

Swift / Objective-C 接入评估

Web

网页产品接入;确认浏览器兼容、连接恢复和跨域配置。

JavaScript / TypeScript 接入评估

小程序

宿主环境接入;确认网络域名配置、生命周期和平台限制。

按宿主平台分别适配

Flutter

跨平台应用接入;确认原生桥接、插件版本及推送依赖。

Dart 与原生能力适配

服务端 REST API

由服务端签发用户凭证,处理业务消息、回调与权限校验。

接口与鉴权方式按版本确认

快速集成:从一条消息开始

  1. 确认接入环境。明确平台、SDK 版本、应用标识和测试环境,取得正式接入资料。
  2. 连接用户身份。业务服务校验登录态后签发短期凭证,客户端只持有必要权限。
  3. 监听与发送消息。建立连接,订阅事件,验证单聊、错误处理与重连流程。
  4. 补齐业务体验。加入历史消息、推送、群管理或 AI,再完成安全与性能验证。
示例的使用边界

下方代码仅解释接入步骤,未声明任何真实包名、下载地址或可调用接口。获取 SDK 后,请按对应版本文档替换方法、事件与参数。

JavaScript · 接入伪代码
// 接入流程伪代码,不是已发布 SDK 的可执行接口。
// im 代表项目实际选用的 SDK 实例;请替换为正式 API。

// 1. 向自己的业务服务获取短期访问凭证
const { token } = await yourBackend.getChatToken();

// 2. 先监听消息,再连接(具体顺序以 SDK 文档为准)
im.onMessage((message) => {
  renderAsText(message.text); // 安全渲染,避免直接插入 HTML
});
await im.connect({ token });

// 3. 向已获授权的会话发送一条消息
await im.send({
  conversationId: 'YOUR_CONVERSATION_ID',
  type: 'text',
  text: '你好,欢迎使用安汇聊'
});

// 生产接入还需处理:凭证到期、重连、去重和发送失败。

服务端 REST API 概览

适合由业务系统触发消息、管理账号凭证或对接Webhook 回调。请求签名、权限模型、错误码和限流策略均需依据正式接口文档实现。相关概念也可对照REST API释义理解。

REST · 请求结构示意
# REST 请求结构示意;域名、路径与字段均为占位。
# 不是可调用接口。正式鉴权可能包含签名等额外步骤。
# 仅在服务端执行;服务端密钥不得放入 APP 或 Web 代码。

curl --request POST \
  'https://im-api.example.invalid/v1/messages' \
  --header "Authorization: Bearer ${IM_SERVER_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
    "recipient": "YOUR_USER_ID",
    "type": "text",
    "content": "你的服务进度已更新",
    "request_id": "YOUR_UNIQUE_REQUEST_ID"
  }'

# 业务侧需要检查响应、记录结果,并实现幂等与退避重试。

回调处理需核验签名与时间范围,按事件标识去重。消息重试应采用退避策略,避免重试风暴;发送结果与业务状态分别记录。

上线前,验证这些关键路径

本页用于接入完成后的验证。若还在确认要做哪些即时通讯能力,请先使用安汇聊即时通讯定制需求清单整理范围,再回到这里核对身份、消息、推送和运维路径。

身份与权限

验证凭证只允许访问授权的会话。

  • 过期、撤销与越权访问处理
  • 客户端不包含服务端密钥
  • 消息内容安全渲染与附件校验

消息与网络

用真实设备验证正常和异常网络。

  • 断网、重连、重复消息与顺序
  • 多端同步与历史消息分页
  • 前后台切换和离线推送

容量与可用性

先确定口径,再验证指标。

  • 峰值连接、吞吐与热点群压测
  • 故障切换、恢复时间与告警
  • 存储增长、备份与恢复演练

业务与运营

验证消息与业务状态保持一致。

  • 接口幂等、回调校验与重试
  • 推送频控、用户设置与退订
  • 日志留存、审计与版本回滚

准备好接入你的第一条消息了吗?

说明使用平台、框架版本与业务场景,获取对应的 SDK 和方案资料。