aboutsummaryrefslogtreecommitdiff
path: root/endpoints.md
blob: 2ee313e017a81e382ab4c0abff7b2f9bc4e5b3c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# List of implemented endpoints

This list was generated by the `load-docs.p6` script that gets the data
from the [api-docs.json](https://matrix.org/docs/api/client-server/json/api-docs.json)
from matrix.org. This will give you an overview about what's implemented in the library.

## Application service room directory management

- [ ] PUT - /_matrix/client/r0/directory/list/appservice/{networkId}/{roomId}

## Device management

- [ ] DELETE - /_matrix/client/r0/devices/{deviceId}
- [ ] GET - /_matrix/client/r0/devices
- [ ] GET - /_matrix/client/r0/devices/{deviceId}
- [ ] POST - /_matrix/client/r0/delete_devices
- [ ] PUT - /_matrix/client/r0/devices/{deviceId}

## End-to-end encryption

- [ ] GET - /_matrix/client/r0/keys/changes
- [ ] POST - /_matrix/client/r0/keys/claim
- [ ] POST - /_matrix/client/r0/keys/query
- [ ] POST - /_matrix/client/r0/keys/upload

## Media

- [ ] GET - /_matrix/media/r0/config
- [ ] GET - /_matrix/media/r0/download/{serverName}/{mediaId}
- [ ] GET - /_matrix/media/r0/download/{serverName}/{mediaId}/{fileName}
- [ ] GET - /_matrix/media/r0/preview_url
- [ ] GET - /_matrix/media/r0/thumbnail/{serverName}/{mediaId}
- [X] POST - /_matrix/media/r0/upload

## OpenID

- [ ] POST - /_matrix/client/r0/user/{userId}/openid/request_token

## Presence

- [ ] GET - /_matrix/client/r0/presence/list/{userId}
- [X] GET - /_matrix/client/r0/presence/{userId}/status
- [ ] POST - /_matrix/client/r0/presence/list/{userId}
- [X] PUT - /_matrix/client/r0/presence/{userId}/status

## Push notifications

- [ ] DELETE - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
- [ ] GET - /_matrix/client/r0/notifications
- [ ] GET - /_matrix/client/r0/pushers
- [ ] GET - /_matrix/client/r0/pushrules/
- [ ] GET - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
- [ ] POST - /_matrix/client/r0/pushers/set
- [ ] PUT - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
- [ ] PUT - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions
- [ ] PUT - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled

## Read Markers

- [ ] POST - /_matrix/client/r0/rooms/{roomId}/read_markers

## Reporting content

- [ ] POST - /_matrix/client/r0/rooms/{roomId}/report/{eventId}

## Room creation

- [X] POST - /_matrix/client/r0/createRoom

## Room directory

- [X] DELETE - /_matrix/client/r0/directory/room/{roomAlias}
- [X] GET - /_matrix/client/r0/directory/room/{roomAlias}
- [X] PUT - /_matrix/client/r0/directory/room/{roomAlias}

## Room discovery

- [X] GET - /_matrix/client/r0/publicRooms
- [ ] POST - /_matrix/client/r0/publicRooms

## Room membership

- [X] GET - /_matrix/client/r0/joined_rooms
- [X] POST - /_matrix/client/r0/join/{roomIdOrAlias}
- [X] POST - /_matrix/client/r0/rooms/{roomId}/ban
- [ ] POST - /_matrix/client/r0/rooms/{roomId}/forget
- [ ] POST - /_matrix/client/r0/rooms/{roomId}/invite
- [ ] POST - /_matrix/client/r0/rooms/{roomId}/invite
- [ ] POST - /_matrix/client/r0/rooms/{roomId}/join
- [ ] POST - /_matrix/client/r0/rooms/{roomId}/kick
- [X] POST - /_matrix/client/r0/rooms/{roomId}/leave
- [X] POST - /_matrix/client/r0/rooms/{roomId}/unban

## Room participation

- [ ] GET - /_matrix/client/r0/events
- [ ] GET - /_matrix/client/r0/events/{eventId}
- [ ] GET - /_matrix/client/r0/initialSync
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/context/{eventId}
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/event/{eventId}
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/initialSync
- [X] GET - /_matrix/client/r0/rooms/{roomId}/joined_members
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/members
- [X] GET - /_matrix/client/r0/rooms/{roomId}/messages
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/state
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/state/{eventType}
- [ ] GET - /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}
- [ ] GET - /_matrix/client/r0/sync
- [ ] GET - /_matrix/client/r0/user/{userId}/filter/{filterId}
- [ ] POST - /_matrix/client/r0/rooms/{roomId}/receipt/{receiptType}/{eventId}
- [ ] POST - /_matrix/client/r0/user/{userId}/filter
- [ ] PUT - /_matrix/client/r0/rooms/{roomId}/redact/{eventId}/{txnId}
- [X] PUT - /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}
- [ ] PUT - /_matrix/client/r0/rooms/{roomId}/state/{eventType}
- [X] PUT - /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}
- [ ] PUT - /_matrix/client/r0/rooms/{roomId}/typing/{userId}

## Search

- [ ] POST - /_matrix/client/r0/search

## Send-to-Device messaging

- [ ] PUT - /_matrix/client/r0/sendToDevice/{eventType}/{txnId}

## Server administration

- [ ] GET - /.well-known/matrix/client
- [ ] GET - /_matrix/client/r0/admin/whois/{userId}
- [ ] GET - /_matrix/client/versions

## Session management

- [ ] GET - /_matrix/client/r0/login
- [ ] POST - /_matrix/client/r0/login
- [X] POST - /_matrix/client/r0/logout
- [ ] POST - /_matrix/client/r0/logout/all

## User data

- [X] DELETE - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag}
- [ ] GET - /_matrix/client/r0/account/3pid
- [X] GET - /_matrix/client/r0/account/whoami
- [X] GET - /_matrix/client/r0/profile/{userId}
- [X] GET - /_matrix/client/r0/profile/{userId}/avatar_url
- [X] GET - /_matrix/client/r0/profile/{userId}/displayname
- [ ] GET - /_matrix/client/r0/register/available
- [ ] GET - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags
- [ ] POST - /_matrix/client/r0/account/3pid
- [ ] POST - /_matrix/client/r0/account/3pid/delete
- [ ] POST - /_matrix/client/r0/account/deactivate
- [ ] POST - /_matrix/client/r0/account/password
- [X] POST - /_matrix/client/r0/register
- [ ] POST - /_matrix/client/r0/user_directory/search
- [ ] PUT - /_matrix/client/r0/profile/{userId}/avatar_url
- [X] PUT - /_matrix/client/r0/profile/{userId}/displayname
- [ ] PUT - /_matrix/client/r0/user/{userId}/account_data/{type}
- [ ] PUT - /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}
- [ ] PUT - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag}

## VOIP

- [ ] GET - /_matrix/client/r0/voip/turnServer