MAmatrix
Room participation

Snapshot the current state of a room and its most recent messages.

Get a copy of the current state and the most recent messages in a room.

This endpoint should now exclusively be used for "peeking" into viewable rooms you're not a member of (Room Previews). Using this endpoint for something other than peeking was deprecated in r0 of this specification. The relevant information for syncing is now returned by the /sync API. See the migration guide.

get/_matrix/client/v3/rooms/{roomId}/initialSync

Request

Path parameters

roomIdstring mx-room-id required

The room to get the data.

Response

The current state of the room

membership'invite' | 'join' | 'leave' | 'ban'

The user's membership state in this room.

room_idstring mx-room-id required

The ID of this room.

visibility'private' | 'public'

Whether this room is visible to the /publicRooms API or not.

Example response

{
  "messages": {
    "chunk": [
      {
        "content": {
          "membership": "join"
        },
        "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
        "origin_server_ts": 1632489532305,
        "sender": "@example:example.org",
        "state_key": "@user:example.org",
        "type": "m.room.member",
        "unsigned": {
          "age": 1567437,
          "membership": "join",
          "redacted_because": {
            "content": {
              "reason": "spam"
            },
            "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
            "origin_server_ts": 1632491098485,
            "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
            "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
            "sender": "@moderator:example.org",
            "type": "m.room.redaction",
            "unsigned": {
              "age": 1257
            }
          }
        },
        "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
      }
    ]
  },
  "state": [
    {
      "content": {
        "membership": "join"
      },
      "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
      "origin_server_ts": 1632489532305,
      "sender": "@example:example.org",
      "state_key": "@user:example.org",
      "type": "m.room.member",
      "unsigned": {
        "age": 1567437,
        "membership": "join",
        "redacted_because": {
          "content": {
            "reason": "spam"
          },
          "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
          "origin_server_ts": 1632491098485,
          "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
          "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
          "sender": "@moderator:example.org",
          "type": "m.room.redaction",
          "unsigned": {
            "age": 1257
          }
        }
      },
      "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.