跳到主要内容

获取成员

本文提供调用「获取成员」接口的操作示例。

提示
  • 仅支持企业级的空间站使用(了解更多)
  • 仅支持空间站的主管理员,以及拥有成员管理权限的子管理员使用

示例:

假设你有一个空间站,你想获取成员 “张三” 的具体信息

你的操作步骤如下:

  1. 获取你的 API Token。(获取方法

  2. 获取你的空间站 ID。(获取方法

  3. 获取成员 “张三” 的 unitId。(获取方法

    什么是 unitId?

  4. 打开你电脑上的终端,执行下列代码,向服务器发送查询请求(假设 spaceId 为 spcjXzqVrjaP3,成员 “张三” 的 unitId 为 kD8tPcZ3fYxSjV9qWvL5X2TmQbN1nR6):

    注意:成员的邮箱、手机号属于敏感数据,如需获取则需传入 Query parameter: sensitiveData = true

    curl -X GET \
    "https://vika.cn/fusion/v1/spaces/spcjXzqVrjaP3/members/kD8tPcZ3fYxSjV9qWvL5X2TmQbN1nR6?sensitiveData=true" \
    -H "Authorization: Bearer {你的 API Token}"
  5. 服务器会返回下列 JSON 数据包,"data" 下的即为获取的成员信息:

    有关返回结果中各参数的含义,可查看 API 手册

    {
    "code": 200,
    "message": "SUCCESS",
    "success": true,
    "data":{
    "member":
    {
    "unitId": "kD8tPcZ3fYxSjV9qWvL5X2TmQbN1nR6",
    "name": "张三",
    "mobile": {
    "number": "13000111000",
    "areaCode": "+86"
    },
    "email":"zhangsan@vikadata.com",
    "avatar": "https://s4.vika.cn/public/2023/05/16/d2d74a23dabb4700a91594fbc975fd06",
    "status": 1,
    "type": "Member",
    "teams": [
    {
    "unitId": "VS1SejiywaMWbiGMEHAohh62T9EPmmlh",
    "name": "team A",
    "sequence": 1,
    "parentUnitId": "0",
    "roles": [
    {
    "unitId": "zJ6TuQvH2RtNfSx9eY7XKgD1oWcE5pV",
    "name": "role A",
    "sequence": 1
    }
    ]
    }
    ],
    "roles": [
    {
    "unitId": "c9EQqwN1pOEgjXqKJznPF6xF8t5TYTf0",
    "name": "role B",
    "sequence": 2
    }
    ]
    }
    }
    }