名词解释
阅读指引:本篇按主题解释开放平台文档中的常用术语。术语对应的接口与字段细节见「服务端 API」分类下的各篇。
应用与凭据
- 服务号应用:第三方系统在莲信开放平台的应用形态,由平台管理员创建并授权,包含应用后端与(可选的)客户端 H5 页面。
- app_identifier:应用的全局稳定标识(如
com.example.notice),由开发者提供;不是 OAuth2 client_id。 - app_key:OAuth2
client_id,公开选择器,可在 H5 与 JSSDK 参数中使用。 - app_secret:OAuth2 client secret,仅保存在应用后端;重置会撤销应用全部应用 Token 和用户 Token。
- sign_key:Webhook 请求验签与验证响应签名使用的密钥;不参与 JSSDK config;重置不撤销 OAuth2 Token,但会使群同步游标失效。
- 可信域名:管理员为应用登记的域名(不带协议和路径),限制 H5 / JSSDK 页面。
- oauth_callback_uri:管理员登记的 OAuth2 code 回调完整 URI,精确匹配,不支持通配符或 fragment。
凭证与授权
- 应用 Token(app access token):代表应用自身的 Bearer Token,通过
client_credentials换取,用于素材、消息、组织、群等接口。 - 用户 Token(user access token):代表应用 + 当前授权用户,通过 authorization code 换取,用于用户资料、代发消息。
- authorization code:短期、一次性的用户授权码,5 分钟内有效,只能在应用后端使用一次。
- refresh token:刷新令牌,只能保存在应用后端;刷新成功后整组 Token 轮换。
- jsapi_ticket:JSSDK 签名密钥,应用后端用应用 Token 换取并缓存,用于计算
config签名。 - Scope(能力):平台授予应用的权限集合,如
message:send:user、contact:organization:read。 - 用户授权:用户对需要用户授权的 Scope(如
user:profile:read)的同意,可刷新、可撤销。 - 发布范围:管理员配置的应用级边界,决定谁能使用应用、应用能读取或触达哪些用户与组织;用户维度(
user:0表示全部)与组织维度独立配置。 - user_open_id:当前应用可使用的用户标识,按不透明字符串保存和比较。
- state:OAuth2 授权请求中应用生成的随机值,用于防 CSRF 与请求串线,回调时必须校验。
消息与素材
- media_id:应用素材的唯一标识,以
media_开头,与上传类型绑定,不能跨应用使用。 - request_id:消息发送的幂等标识,重试时必须复用原值和完全相同的目标与内容。
- 模板卡片:客户端原生渲染的卡片消息;当前开放
textNotice(文本通知型)与newsNotice(图文展示型),操作菜单点击会回传 Webhook。 - 代发消息:应用在用户授权后代替真实用户向用户或群发消息(
delegate_send),向群代发时该用户须是群成员。
事件与同步
- Webhook:平台向管理员配置的
webhook_url异步投递事件的机制;须先部署验签与 URL 验证响应。 - sign_key 验签:对原始请求体按
timestamp + LF + nonce + LF + raw_body计算 HMAC-SHA256,与X-Matrix-Signature恒定时间比较。 - event_id / request_id(Webhook):事件稳定标识,同一事件的 HTTP 重试期间不变,用作幂等键。
- URL 验证:
webhook.url.verify事件,应用必须原样返回challenge并对响应签名,仅返回 HTTP 200 不算验证成功。 - sync_token(同步 Token):组织目录的水位凭证,不透明字符串,只保存并原样回传;配合
sync-complete保证快照一致性。 - cursor(游标):群同步接口的不透明分页游标,首次省略,之后原样回传,不能解析或跨应用复用。
客户端与 JSSDK
- JSSDK:运行在莲信客户端内 H5 页面的 JS SDK,引入平台交付的
jsapi.js后获得全局对象matrix。 - config:JSSDK 初始化接口,注入签名与权限信息;
openChat、chooseChat等受保护能力必须先 config。 - getAuthCode:获取用户授权码的 JSAPI,无需 config 即可调用。
- 受保护能力:需要 config 授权后才能调用的 JSAPI(当前为
openChat/chooseChat)。 - Bridge:JSSDK 与客户端原生容器之间的通信桥;
ready/error是 Bridge 生命周期的两个回调。
组织与群
- 组织(租户):使用莲信的独立单位;发布范围与「全员」目标都以当前租户为准。
- 组织节点(org_node):组织架构中的部门节点;消息目标
org_node固定覆盖节点自身及全部后代。 - 群应用(group:app):群主或管理员将应用添加进群后,应用获得的群数据访问与群消息能力;以有效绑定关系为授权依据。