## API
-In general, the way to send a `ChatMessage` is to first create a `Chat`, then post a message to that `Chat`. The actors in the API are generally given by their ActivityPub id to make it easier to support later `Group` scenarios.
+In general, the way to send a `ChatMessage` is to first create a `Chat`, then post a message to that `Chat`. `Group`s will later be supported by making them a sub-type of `Account`.
This is the overview of using the API. The API is also documented via OpenAPI, so you can view it and play with it by pointing SwaggerUI or a similar OpenAPI tool to `https://yourinstance.tld/api/openapi`.
### Creating or getting a chat.
-To create or get an existing Chat for a certain recipient (identified by AP ID)
+To create or get an existing Chat for a certain recipient (identified by Account ID)
you can call:
-`POST /api/v1/pleroma/chats/by-ap-id/{ap_id}`
-
-The ap_id of the recipients needs to be www-form encoded, so
+`POST /api/v1/pleroma/chats/by-account-id/{account_id}`
+The account id is the normal FlakeId of the user
```
-https://originalpatchou.li/user/lambda
+POST /api/v1/pleroma/chats/by-account-id/someflakeid
```
-would become
+If you already have the id of a chat, you can also use
```
-https%3A%2F%2Foriginalpatchou.li%2Fuser%2Flambda
+GET /api/v1/pleroma/chats/:id
```
-The full call would then be
+There will only ever be ONE Chat for you and a given recipient, so this call
+will return the same Chat if you already have one with that user.
+
+Returned data:
-```
-POST /api/v1/pleroma/chats/by-ap-id/https%3A%2F%2Foriginalpatchou.li%2Fuser%2Flambda
+```json
+{
+ "account": {
+ "id": "someflakeid",
+ "username": "somenick",
+ ...
+ },
+ "id" : "1",
+ "unread" : 2,
+ "last_message" : {...}, // The last message in that chat
+ "updated_at": "2020-04-21T15:11:46.000Z"
+}
```
-There will only ever be ONE Chat for you and a given recipient, so this call
-will return the same Chat if you already have one with that user.
+### Marking a chat as read
+
+To set the `unread` count of a chat to 0, call
+
+`POST /api/v1/pleroma/chats/:id/read`
Returned data:
```json
{
- "recipient" : "https://dontbulling.me/users/lain",
- "recipient_account": {
+ "account": {
"id": "someflakeid",
"username": "somenick",
...
},
"id" : "1",
- "unread" : 2
+ "unread" : 0,
+ "updated_at": "2020-04-21T15:11:46.000Z"
}
```
+
### Getting a list of Chats
`GET /api/v1/pleroma/chats`
```json
[
{
- "recipient" : "https://dontbulling.me/users/lain",
- "recipient_account": {
+ "account": {
"id": "someflakeid",
"username": "somenick",
...
},
"id" : "1",
- "unread" : 2
+ "unread" : 2,
+ "last_message" : {...}, // The last message in that chat
+ "updated_at": "2020-04-21T15:11:46.000Z"
}
]
```
`GET /api/v1/pleroma/chats/{id}/messages`
This will return all messages, sorted by most recent to least recent. The usual
-pagination options are implemented
+pagination options are implemented.
Returned data:
```json
[
{
- "actor": "https://dontbulling.me/users/lain",
+ "account_id": "someflakeid",
"chat_id": "1",
"content": "Check this out :firefox:",
"created_at": "2020-04-21T15:11:46.000Z",
"id": "13"
},
{
- "actor": "https://dontbulling.me/users/lain",
+ "account_id": "someflakeid",
"chat_id": "1",
"content": "Whats' up?",
"created_at": "2020-04-21T15:06:45.000Z",
`POST /api/v1/pleroma/chats/{id}/messages`
Parameters:
-- content: The text content of the message
+- content: The text content of the message. Optional if media is attached.
+- media_id: The id of an upload that will be attached to the message.
-Currently, no formatting beyond basic escaping and emoji is implemented, as well as no
-attachments. This will most probably change.
+Currently, no formatting beyond basic escaping and emoji is implemented.
Returned data:
```json
{
- "actor": "https://dontbulling.me/users/lain",
+ "account_id": "someflakeid",
"chat_id": "1",
"content": "Check this out :firefox:",
"created_at": "2020-04-21T15:11:46.000Z",
}
```
+### Deleting a chat message
+
+Deleting a chat message for given Chat id works like this:
+
+`DELETE /api/v1/pleroma/chats/{chat_id}/messages/{message_id}`
+
+Returned data is the deleted message.
+
### Notifications
There's a new `pleroma:chat_mention` notification, which has this form:
"chat_id": "1",
"id": "10",
"content": "Hello",
- "actor": "https://dontbulling.me/users/lain"
+ "account_id": "someflakeid"
},
"created_at": "somedate"
}