Sendbird/viewAUser

暂不支持在线调用 · 原因见下方

SendbirdSendbird 聊天平台服务端 API v3

GET/v3/users/{user_id}

查询用户信息

通过 user_id 获取指定用户的详细信息,返回该用户的资源表示,包括昵称、头像等属性。

通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint;客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容,Pontx 不代理、缓存或聚合,调用方使用本地 SDK/CLI 直连。

请求

operationId
viewAUser
服务器
https://api-{app_id}.sendbird.com
认证
apiTokenAuth

请求参数

user_id

pathstring必填

用户 ID

user_id_123

include_unread_count

queryboolean

include unread count 字段。

true

custom_types

querystring

custom types 字段。

custom_types_value

super_mode

querystring

超级频道模式

all

响应

200

SendbirdUserapplication/json

请求成功。

字段: access_tokencreated_atdiscovery_keyshas_ever_logged_inis_activeis_createdis_hide_me_from_friendsis_onlineis_shadow_blockedlast_seen_atlocalemetadatanicknamephone_numberpreferred_languagesprofile_urlrequire_auth_for_profile_imagestateunread_channel_countunread_message_countuser_id

400

SendbirdApiErrorapplication/json

请求参数无效。

字段: codemessage

401

SendbirdApiErrorapplication/json

未认证或 API 令牌无效。

字段: codemessage

403

SendbirdApiErrorapplication/json

无权限访问该资源。

字段: codemessage

404

SendbirdApiErrorapplication/json

未找到指定资源。

字段: codemessage

429

SendbirdApiErrorapplication/json

请求频率超限,请稍后重试。

字段: codemessage

500

SendbirdApiErrorapplication/json

上游服务内部错误。

字段: codemessage

{
  "access_token": "next_page_token_abc",
  "created_at": 1,
  "discovery_keys": [
    "discovery_keys_value"
  ],
  "has_ever_logged_in": true,
  "is_active": true,
  "is_created": true,
  "is_hide_me_from_friends": true,
  "is_online": true
}