Get
/api/v1/rooms.isMember
Use this endpoint to check whether or not a user is a member of a specific room. If the user is not a member of the room, an error response (error-user-not-found) is returned. You can only get the results for the rooms that you are a member of. Otherwise, you get a forbidden error response.
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
roomId
stringRequired
Enter the room ID in which you want to check for the user.
userId
stringRequired
Enter the user ID that you want to check. Alternatively, you can use the username parameter and provide the user name instead of the user ID.
Responses
200
OK
Example 1
{
"isMember": true,
"success": true
}object
isMember
boolean
success
boolean
400
Bad Request
User not available in room
{
"success": false,
"error": "error-user-not-found"
}Missing user ID parameter
{
"success": false,
"error": "must have required property 'userId'\n must have required property 'username'\n must match exactly one schema in oneOf [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string