Feature Description

This API is used by the app admin to batch obtain the roles of users in a group.

API Calling Description

Applicable group types

These are the 4 built-in group types in IM. For detailed information, see the Group System.

Note：

AVChatRooms (livestreaming groups) do not support this API and a 10007 error will be returned if this operation is performed on this type of group. To achieve the same result, you can call the API for obtaining profiles of group members.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/get_role_in_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

This request packet is used to obtain the list of groups a user has joined. The group information includes the group ID and the IDs of group members whose roles are to be queried.

{
   "GroupId": "@TGS#2C5SZEAEF",
   "User_Account": [ // Up to 500 accounts are supported.
       "leckie",
       "peter",
       "wesley"
   ]
}

Request packet fields

Sample response packet body

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "UserIdList": [ // Result
      {
          "Member_Account": "leckie",
          "Role": "Owner" // Member role: Owner/Admin/Member/NotMember
      },
      {
          "Member_Account": "peter",
          "Role": "Member"
      },
      {
          "Member_Account": "wesley",
          "Role": "NotMember"
      }
  ]
}

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:

API Debugging Tool

Use the online debugging tool for RESTful APIs to debug this API.

Reference

Obtaining the groups a user has joined (v4/group_open_http_svc/get_joined_group_list)