Skip to content

批量获取用户的自定义属性值

适用版本>=v7.0.2412a.20241212

接口说明:批量获取用户的自定义属性值

请求说明

请求地址配置域名+/openapi+/v7/users/custom_attrs/batch_read
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理用户自定义字段(应用授权) kso.user_custom_attr.readwrite

请求头(Header)

Header参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称类型是否必填说明
user_idsstring[]用户id列表,列表长度最大为50

请求体示例

json
{
  "user_ids": ["string"]
}

响应体(Response)

名称类型说明
codeint错误码
detailstring详细信息
msgstring状态信息
dataobject返回信息体
usersobject[]用户列表
custom_attrsobject[]自定义属性列表
attr_idstring自定义属性 id
attr_namestring自定义属性名称
attr_value_typestring自定义属性值类型
可选值:text: 文本;url: 网页;relation_user: 人员;
relation_userstringattr_value_typerelation_user 时,展示的选项列表
textstringattr_value_typetext 时,展示的选项列表
urlobjectattr_value_typeurl 时,展示的选项列表
titlestring标题
linkstring链接
user_idstring用户 id

响应体示例

json
{
  "data": {
    "users": [
      {
        "custom_attrs": [
          {
            "attr_id": "string",
            "attr_name": "string",
            "attr_value_type": "string",
            "relation_user": "string",
            "text": "string",
            "url": {
              "title": "string",
              "link": "string"
            }
          }
        ],
        "user_id": "string"
      }
    ]
  },
  "msg": "string",
  "code": 0
}