Skip to content

用户 (User)

类型定义

User

字段类型描述
idstring用户 ID
namestring?用户名称[1]
nickstring?用户昵称[1]
avatarstring?用户头像链接
is_botboolean?是否为机器人

TIP

[1] namenick 字段的区别

这两个字段都可以用于标识用户。在一些平台上 (例如 Telegram),一个用户存在多种不同概念的名称,因此 SDK 可以同时设置这两个字段。而另一些平台可能不存在这两个概念的对立关系,此时 SDK 只需要根据语义设置 namenick 中的一个即可。

在应用层实现上,nick 的优先级高于 name,因为昵称更容易被用户识别和理解。如果你正在开发基于 Satori 协议的客户端,在用户名的显示上应当优先使用 nick 字段,只有当 nick 为空时才使用 name 字段。

API

获取用户信息

POST/user.get
字段类型描述
user_idstring用户 ID

获取用户信息。返回一个 User 对象。

获取好友列表

POST/friend.list
字段类型描述
nextstring?分页令牌

获取好友列表。返回一个 User分页列表

处理好友申请

POST/friend.approve
字段类型描述
message_idstring请求 ID
approveboolean是否通过请求
commentstring?备注信息

处理好友申请。

事件

friend-request

接收到新的好友申请时触发。必需资源:user