本文内容

名词解释

用户相关

open_id: 用户标识的一种,在接口中提供。open_id 用于在同一个应用中对用户进行标识,对于同一个用户,不同应用获取到的 open_id 是不一样的。该 ID 对于第三方企业应用和企业自建应用都可使用。

union_id:用户标识的一种,在接口中提供。union_id 用于在同一个应用开发主体下对用户进行标识,对于同一个用户,同一个应用开发主体名下的应用获取到的 union_id 是相同的,而不同主体名下应用获取到的 union_id 是不同的。该 ID 对于第三方企业应用和企业自建应用都可使用。

company_uid: 用户标识的一种,在接口中提供。company_uid 用于对不同企业下的用户进行标识。对于同一企业下的同一个用户,同一个应用开发主体名下的应用获取到的 company_uid 是相同的。不同企业下的同一用户,同一个应用开发主体名下的应用获取到的 company_uid 是不同的。该 ID 对于第三方企业应用和企业自建应用都可使用。

企业相关

company_id:企业唯一标识。

dept_id:部门唯一标识。

open_company_id :企业标识码,仅用于第三方企业应用的个人授权流程。用户通过WPS协作打开应用主页时,WPS协作开放平台将在主页 URL 后携带该参数,应用需识别该参数并将其用于个人授权流程的请求入参。详细使用过程可见获取企业授权 company_token(第三方企业应用)

应用相关

app_id:WPS协作开放平台应用的唯一标识。可以用于接口调用。

app_key:与 app_id 一致,部分接口使用该字段。(开发者需特别注意的是,在 WPS-3 或 4 签名算法中的 app_key,指的是 secret_key)。

service_key:与 app_id 一致,部分接口使用该字段。

secret_key: WPS协作开放平台应用的秘钥。创建应用时,由开放平台生成,可以用于接口调用,请务必注意保管。应用开发者可在开发者后台-应用详情查看 secret_key。

scope: 调用开放平台接口、接收订阅事件通知的权限。每一个应用需要在版本中申请所需要的权限,并且得到安装该应用的企业管理员授权通过,才可以实际拥有某一个企业下的具体权限。缺失权限的应用,可能会出现接口调用不通、获取不到事件推送、接口/事件中缺失一些字段等问题,开发者可以自行查看开发文档,了解应用需要哪些权限。开发者可在开发者后台-应用详情-权限申请内查看和申请应用权限。

app_ticket: WPS协作开放平台通过 APP 的事件订阅地址定时推送给 APP 服务端的一个短期有效凭证,是第三方企业应用获取 app_token 的必要参数之一。应用需主动调用接口推送 app_ticket激活该事件推送,WPS协作开放平台每隔一段时间(不定期)会推送一次最新 app_ticket。开发者使用时可不关注 ticket 的有效期,用最新收到的 ticket 即可。另外,若事件连续 5 次未被应用响应或响应错误,平台将停止推送,应用需重新调用上述接口再次激活事件推送。

访问凭证

access_token:用户授权凭证,由用户授权流程可获取。

app_token:应用授权凭证,由应用授权流程可获取。

company_token:企业授权凭证,由企业授权流程可获取。

各类凭证获取说明和流程详见API 凭证概述

其他

chat_id:会话(含单聊、群聊)的唯一标识。

message_id:消息的唯一标识。

本文内容