zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Added direct messages to API documentation (#701) 

* Added direct messages timeline to API documentation

* Added direct messages to Streaming API documentation
This commit is contained in:
Niklas Poslovski 2018-09-08 15:49:12 +02:00 committed by nightpool
parent ecbbb5491f
commit 6c87cec5b3
2 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Using-the-API/API.md
View File

@ -826,6 +826,7 @@ Returns the target [Status](#status).
GET /api/v1/timelines/public
GET /api/v1/timelines/tag/:hashtag
GET /api/v1/timelines/list/:list_id
GET /api/v1/timelines/direct
Query parameters:

4
Using-the-API/Streaming-API.md
View File

@ -25,6 +25,10 @@ Returns all public statuses for a particular hashtag (query param `tag`)
Returns statuses for list (query param `list`)
**GET /api/v1/streaming/direct**
Returns all direct messages
### Stream contents
The stream will contain events as well as heartbeat comments. Lines that begin with a colon (`:`) can be ignored by parsers, they are simply there to keep the connection open. Events have this structure: