跳到主要内容

获取群成员列表​

简要描述​

  • 获取群成员列表。

请求方式​

  • post

请求URL​

  • {API_ADDRESS}/group/get_group_member_list
header名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪，建议使用时间戳，在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例​

{
  "groupID": "2559217223",
  "keyword":"userID",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}
字段名选填类型说明
groupID必填string群ID
keyword选填string群成员的 userID 或 nickname，不填时返回对应分页的数据
pagination必填object分页参数结构体
pagination.pageNumber必填int当前页码，从1开始
pagination.showNumber必填int当前页请求数量

成功返回示例​

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 5,
    "members": [
      {
        "groupID": "2559217223",
        "userID": "3034068043",
        "roleLevel": 20,
        "joinTime": 1687762198048,
        "nickname": "OK",
        "faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer%2Fcache%2Fimage_cropper_1687330588901.jpg",
        "appMangerLevel": 0,
        "joinSource": 2,
        "operatorUserID": "4771680259",
        "ex": "",
        "muteEndTime": 0,
        "inviterUserID": "4771680259"
      },
      {
        "groupID": "2559217223",
        "userID": "3645617224",
        "roleLevel": 60,
        "joinTime": 1687762198048,
        "nickname": "Huo",
        "faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer%2Fcache%2Fimage_cropper_1687846002615.jpg",
        "appMangerLevel": 0,
        "joinSource": 2,
        "operatorUserID": "4771680259",
        "ex": "",
        "muteEndTime": 0,
        "inviterUserID": "4771680259"
      },
      {
        "groupID": "2559217223",
        "userID": "3791793226",
        "roleLevel": 20,
        "joinTime": 1687760824107,
        "nickname": "Wo",
        "faceURL": "",
        "appMangerLevel": 0,
        "joinSource": 2,
        "operatorUserID": "4771680259",
        "ex": "",
        "muteEndTime": 0,
        "inviterUserID": "4771680259"
      },
      {
        "groupID": "2559217223",
        "userID": "4771680259",
        "roleLevel": 100,
        "joinTime": 1687760824107,
        "nickname": "Lumia",
        "faceURL": "http://203.56.175.233:10002/third/object?name=%2Fdata%2Fuser%2F0%2Fcn.rentsoft.flutter.openim.consumer%2Fcache%2Fimage_cropper_1687330764676.jpg",
        "appMangerLevel": 0,
        "joinSource": 2,
        "operatorUserID": "4771680259",
        "ex": "",
        "muteEndTime": 0,
        "inviterUserID": "4771680259"
      },
      {
        "groupID": "2559217223",
        "userID": "7117248489",
        "roleLevel": 20,
        "joinTime": 1687762198048,
        "nickname": "Hello",
        "faceURL": "",
        "appMangerLevel": 0,
        "joinSource": 2,
        "operatorUserID": "4771680259",
        "ex": "",
        "muteEndTime": 0,
        "inviterUserID": "4771680259"
      }
    ]
  }
}

成功返回示例的参数说明​

参数名类型说明
errCodeint错误码，0表示成功
errMsgstring错误简要信息，为空
errDlterrDlt错误详细信息，为空
dataobject通用数据对象，具体结构见下方
totalint群成员总数
membersarray群成员信息列表

失败返回示例​

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明​

参数名类型说明
errCodeint错误码，具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息