Join External Public Room

Prev Next
Post
/api/v1/federation/joinExternalPublicRoom
Premium tag

Join a public external federated room.

Changelog

Version Description
6.0.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
  "externalRoomId": "!externalRoomId:server.com"
}
object
externalRoomId
string Required

The external public room ID.

Example!externalRoomId:server.com
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
Tags