• 简体中文
  • 目录 API

    房间别名目录

    获取房间别名

    GET /_matrix/client/v3/directory/room/{roomAlias}
    {
      "room_id": "!abc:localhost",
      "servers": ["localhost"]
    }

    创建房间别名

    PUT /_matrix/client/v3/directory/room/{roomAlias}
    { "room_id": "!abc:localhost" }

    删除房间别名

    DELETE /_matrix/client/v3/directory/room/{roomAlias}

    公共房间目录

    列出公共房间

    GET /_matrix/client/v3/publicRooms?limit=50&since=...

    返回已发布的房间,包含从状态事件填充的元数据(名称、话题、头像)。

    {
      "chunk": [
        {
          "room_id": "!abc:localhost",
          "name": "综合讨论",
          "topic": "一般性讨论的房间",
          "avatar_url": "mxc://localhost/thumb",
          "num_joined_members": 42,
          "world_readable": true,
          "guest_can_join": true
        }
      ],
      "next_batch": "...",
      "total_room_count_estimate": 100
    }

    搜索公共房间

    POST /_matrix/client/v3/publicRooms
    {
      "filter": { "generic_search_term": "综合" },
      "limit": 50,
      "since": "..."
    }

    用户目录

    搜索用户

    POST /_matrix/client/v3/user_directory/search
    {
      "search_term": "alice",
      "limit": 20
    }
    {
      "results": [
        {
          "user_id": "@alice:localhost",
          "display_name": "Alice",
          "avatar_url": "mxc://localhost/avatar"
        }
      ],
      "limited": false
    }

    第三方 ID(3PID)

    获取 3PID

    GET /_matrix/client/v3/account/3pid

    添加 3PID

    POST /_matrix/client/v3/account/3pid

    绑定 3PID

    POST /_matrix/client/v3/account/3pid/bind

    解绑 3PID

    POST /_matrix/client/v3/account/3pid/unbind