Firmiana
  • 简体中文

      • 联邦 API

      联邦端点位于 /_matrix/federation/v1/ 下，使用基于签名的认证（Authorization: X-Matrix 头，非 Bearer Token）。

      事务端点

      发送事务

      PUT /_matrix/federation/v1/send/{txnId}

      向远程服务器发送一批 PDU（持久数据单元）和 EDU（临时数据单元）。

      加入/退出/邀请端点

      准备加入

      GET /_matrix/federation/v1/make_join/{roomId}/{userId}

      为远程用户准备加入事件以供签名。

      提交加入

      PUT /_matrix/federation/v1/send_join/{roomId}/{eventId}

      向房间提交已签名的加入事件。

      准备退出

      GET /_matrix/federation/v1/make_leave/{roomId}/{userId}

      为远程用户准备退出事件。

      提交退出

      PUT /_matrix/federation/v1/send_leave/{roomId}/{eventId}

      提交已签名的退出事件。

      邀请（v2）

      PUT /_matrix/federation/v2/invite/{roomId}/{eventId}

      邀请远程用户加入房间。使用 v2 前缀。

      状态端点

      获取房间状态

      GET /_matrix/federation/v1/state/{roomId}

      获取状态 ID

      GET /_matrix/federation/v1/state_ids/{roomId}

      获取事件认证

      GET /_matrix/federation/v1/event_auth/{roomId}/{eventId}

      回填

      GET /_matrix/federation/v1/backfill/{roomId}

      返回指定 prev_batch 令牌之前的事件，支持分页。

      获取缺失事件

      POST /_matrix/federation/v1/get_missing_events/{roomId}
      {
  "limit": 20,
  "min_depth": 0,
  "last_known_events": ["$event1", "$event2"]
}

      查询端点

      查询用户资料

      GET /_matrix/federation/v1/query/profile?user_id=@alice:localhost&fields=displayname,avatar_url

      查询房间目录

      GET /_matrix/federation/v1/query/directory?room_alias=#room:localhost

      查询用户设备

      GET /_matrix/federation/v1/query/user_devices?user_id=@alice:localhost

      查询密钥

      GET /_matrix/federation/v1/query/keys?server_name=localhost

      密钥服务器

      获取服务器密钥

      GET /_matrix/key/v2/server

      返回服务器的签名密钥和 valid_until 时间戳。

      查询远程密钥

      GET /_matrix/key/v2/query/{server}

      查询其他服务器的签名密钥（公证）。