Skip to content

Room Invites

Public endpoints for handling chat room invitations.

Handle Room Invite

Process a room invitation link.

Endpoint

GET /api/join/room/{roomId}

Parameters

  • roomId - The Matrix room ID or alias

Response (Success)

json
{
  "data": {
    "room": {
      "room_id": "!abc123:matrix.server",
      "name": "Match Discussion",
      "topic": "Manchester United vs Liverpool",
      "member_count": 150,
      "is_public": true
    },
    "requires_auth": true,
    "redirect_url": "/app/chat/!abc123:matrix.server"
  }
}

Response (Room Not Found)

json
{
  "error": "Room not found",
  "code": "ROOM_NOT_FOUND"
}

Notes

  • This is a public endpoint (no authentication required)
  • Returns room information if valid
  • Client should redirect to login if user not authenticated
  • After authentication, user can join the room