join-external-public-room.md

description
Join an external public room

Join external public room

URL	Requires Auth	HTTP Method
/api/v1/federation/joinExternalPublicRoom	yes	POST

Payload

Argument	Example	Required	Description
externalRoomId	!externalRoomId:server.com	Required	The external public room id.

Example payload

{
  "externalRoomId": "!externalRoomId:server.com"
}

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/federation/joinExternalPublicRoom \
    -d '{"externalRoomId": "!externalRoomId:server.com"}'

Example Result

{
  "success": true
}

Version	Description
6.0.0	Added