# 通用参数
为了满足多样化的应用场景,Bosshi开放平台提供了丰富的 API 和事件,供开发者调用或订阅。这些 API 和事件会涉及到一些通用参数,在此进行统一介绍。通用参数可能作为请求参数,也可能作为响应参数。在使用Bosshi开放平台提供的 API 和事件之前,建议先了解一下这些通用参数的含义。
# 应用相关
# app_id
app_id
是Bosshi开放平台应用的唯一标识。在创建应用时,由系统自动生成,用户不能自行修改。可以在开发者后台 (opens new window)的 凭证与基础信息 页面查看 app_id
。
# app_secret
app_secret
是应用的秘钥。在创建应用时,由系统自动生成,在调用某些 API 时,需要将 app_secret
作为请求参数之一。用户可以在开发者后台 (opens new window)的 凭证与基础信息 页面查询或重置秘钥。
# 企业相关
# tenant_key
tenant_key
是租户唯一标识,在实际应用场景中,对应一个企业。应用有如下两种方式获取 tenant_key
:
- 企业安装应用时,开放平台通过事件推送给应用。
- 用户登录授权时,Bosshi开放平台会返回
tenant_key
。
# department_id
自定义的部门 ID, 如果没有自定义部门 ID,则开放平台会随机生成一个字符串作为自定义部门 ID。
# open_department_id
开放平台自动生成的部门 ID,以 od-
开头。open_department_id
全局唯一,即跨应用、跨开发主体的 open_department_id
都是不同的。
# 访问凭证
为了提升 API 调用的安全性,Bosshi开放平台设计了访问凭证机制。在调用接口前,需要先获取所需的访问凭证。访问凭证我们也称为 access_token
。访问凭证代表应用从平台、租户(公司或者团队)、用户手中获取的授权。访问凭证包括三种:
- 应用访问凭证,参数名为
app_access_token
。 - 租户访问凭证,参数名为
tenant_access_token
。 - 用户访问凭证,参数名
user_access_token
。
如果要了解如何获取访问凭证,请参考获取访问凭证。
如果要系统的了解Bosshi开放平台的权限系统,可以参考访问权限介绍。
# app_access_token
app_access_token
即应用访问凭证。开放平台可根据 app_access_token
,识别调用方的应用身份,应用可以访问应用自身相关的信息,不归属到具体的企业或者用户。如果要了解如何获取应用访问凭证,请参考自建应用获取 app_access_token。
# tenant_access_token
tenant_access_token
即租户访问凭证。使用 tenant_access_token
,应用将代表公司或者团队执行对应的操作,比如获取一个通讯录用户的信息。如果要了解如何获取 tenant_access_token
,请参考自建应用获取 tenant_access_token。
# user_access_token
user_access_token
即用户访问凭证。使用 user_access_token
,应用将代表用户执行对应的操作,比如用户通过 API 创建一篇云文档或者一个日程。如果要了解如何获取用户访问凭证。请参考获取 user_access_token。
# 用户相关
Bosshi对用户身份体系有充分地设计,为了满足不同开发场景的需求,Bosshi设置了 user_id
、open_id
和 union_id
等不同的用户标识。
开发一个应用时,合理的 ID 选择逻辑如下:
- 创建的应用不存在跨应用的数据关联互通场景,使用
open_id
即可。 - 需要跨应用的数据关联,但是其开发者归属同一个企业组织,可以使用
union_id
。 - 需要跨应用关联,并且这些应用可能是不同的组织开发的,但是应用的用户归属在同一个企业内,则使用
user_id
。
# 链路相关
为了快速排查 API 调用详情,追踪调用过程中遇到的问题,Bosshi开放平台设计了链路追踪机制,业务对接在调用接口时,可将接口调用唯一标识(类似于利用UUID生成标识)写入 Request Header 中,对应的值称为 traceId
。
traceId
是业务团队和Bosshi开放平台问题追踪,数据回源的重要标识。
# 其他
# chat_id
chat_id
是会话(包括单聊、群聊)的唯一标识。
# message_id
message_id
是消息体的唯一标识。