Get members

To get all the members of a group use below API.

info

{api-base-url} can be obtained from the MirrorFly console.

HTTP request#

curl -X GET "https://{api-base-url}/api/v1/group/view/groupMembers?groupId=samplegroupId&page=1&size=10"
-H "accept: */*"
-H "Authorization: xxxxxxxxxxxxxxxxxx"

Request Params#

ParamDataTypeRequiredDescription
groupidStringYesId of the group to get its members
pageNumberNoPage number to get the particular page data default value is 1
sizeNumberNoNumber of chats per page default value is 10

Responses#

If successful, this action returns encrypted details of members of this group.

{
"data": {
"vcardList": [
{
"userId": "99xxxxxx11", // String - UserId of the member
"image": "sampleimage", // String - profile image of the member
"status": "", // String - status message of the member
"mobileNumber": "99xxxxxx11", // String - encrypted mobile number of the member
"email": "sample@gmail.com", // String - encrypted email of the member
"isAdmin": 1 // Number - whether this user is admin
"isAdminBlocked": 0 // Number - whether this member is blocked by admin
}
],
"totalPages": 1, // Number - Total pages based on the size
"totalRecords": 1 // Number - Total members of the group
},
"message": "Data retrieved successfully"
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

{
"status": 401,
"message": "Token Expired"
}

In the case of a Bad Request, an error message is returned

{
"status": 400,
"message": "Error Message"
}