获取 app 总用户属性大小

大约 2 分钟

获取 app 总用户属性大小

用户属性指实时消息互动用户的信息,如用户昵称、头像、邮箱、电话、性别、签名、生日等。

例如,在招聘场景下,利用用户属性功能,可以存储性别、邮箱、用户类型(面试者)、职位类型(web 研发)等。当查看用户信息时,可以直接查询服务器存储的用户属性信息。

功能说明

获取该 app 下所有用户的属性数据大小,单位为字节。

调用频率上限

100 次/秒/App Key

请求 URL

GET https://{host}/{org_name}/{app_name}/metadata/user/capacity

关于请求 URL 中的参数说明,详见 请求 URL 参数介绍

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X GET 'https://XXXX/XXXX/XXXX/metadata/user/capacity'    \
-H 'Accept: application/json'     \
-H 'Authorization: Bearer <YourAppToken>' 

请求 header 参数

关于 AcceptAuthorization 字段的说明,详见 请求 header 参数说明

响应示例

{
  "timestamp": 1620447051368,
  "data": 1673,
  "duration": 55
}

响应 body 字段

如果返回的 HTTP 状态码为 200,表示请求成功,响应包体中包含以下字段:

参数类型描述
dataLong该 app 下所有用户属性的数据大小,单位为字节。
timestampLongUnix 时间戳,单位为毫秒。
durationInt从发送请求到响应的时长,单位为毫秒。

错误码

如果返回的 HTTP 状态码非 200,表示请求失败,可能提示以下错误码:

HTTP 状态码错误类型错误提示可能原因处理建议
401unauthorizedunauthorized鉴权失败。获取应用容量时需要使用 app 级别权限。
401metadata_errorauth error鉴权失败。使用正确的 token。
403FORBIDDEN{appkey} user metadata service not allow用户属性功能未开通。联系商务开通用户属性功能。

关于其他错误,你可以参考 响应状态码 了解可能的原因。

上次编辑于: