跳到主要内容

快速开始概述

本指南将帮助您在 5 分钟内完成首个应用的创建和消息发送。

接入流程​

准备工作​

在开始之前,请确保您已具备:

  • 注册书谱 IM 用户账号
  • 拥有一个 IM 工作空间(用于安装应用)
  • 了解基本的 HTTP API 调用方式

接入步骤​

步骤说明预计时间
1. 创建应用在开发者中心创建应用,获取 clientId 和 clientSecret2 分钟
2. 安装应用将应用安装到工作空间,获取 Bot Token2 分钟
3. 发送消息使用 Bot Token 调用 API 发送消息1 分钟

核心概念​

应用凭证​

创建应用后,您将获得以下凭证:

凭证说明
appId应用 ID,数字类型
clientId应用唯一标识,UUID 格式,用于签名计算
clientSecret应用密钥,仅在服务端使用,请妥善保管
botUserIdBot 用户 ID,用于标识应用的机器人身份

Bot Token​

应用安装到工作空间后,会获得该工作空间的 Bot Token:

  • Bot Token 用于调用 Bot API(如发送消息)
  • 每个工作空间的 Bot Token 独立
  • Token 有效期为 1 年,过期后需重新获取

签名机制​

安装流程使用签名验证,确保请求来源可信:

sign = SHA256(clientId + timestamp + clientSecret)

下一步​