Start the requesting user participating in a particular room.
POST {{baseUrl}}/join/:roomIdOrAlias?server_name=matrix.org,elsewhere.ca
Note that this API takes either a room ID or alias, unlike /room/{roomId}/join
.
This API starts a user participating in a particular room, if that user is allowed to participate in that room. After this call, the client is allowed to see all current state events in the room, and all subsequent events associated with the room until the user leaves the room.
After a user has joined a room, the room will appear as an entry in the
response of the /initialSync
and /sync
APIs.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
server_name | string | The servers to attempt to join the room through. One of the servers | |
must be participating in the room. |
Request Body
{"third_party_signed"=>{"value"=>"reference definitions/third_party_signed.yaml not found in the OpenAPI spec"}, "reason"=>"Looking for support"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"room_id":"!d41d8cd:matrix.org"}