Created Notify_nextcloudtalk (markdown)

master
Chris Caron 2022-01-25 16:50:47 -05:00
parent 8ed5d1eb82
commit 388ecd7cae
1 changed files with 66 additions and 0 deletions

66
Notify_nextcloudtalk.md Normal file

@ -0,0 +1,66 @@
## Nextcloud Talk Notifications
* **Source**: https://nextcloud.com/talk
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 32000 Characters per message
### Account Setup
The official [Nextcloud Talk app](https://github.com/nextcloud/spreed) will need to be installed. An 'app password' (also referred to as 'device-specific' password/token) of one member of the chat will need to be created, see the [documentation](https://docs.nextcloud.com/server/stable/user_manual/session_management.html#managing-devices) for more information. Don't forget to disable file system access for this password.
### Syntax
Secure connections (via https) should be referenced using **nctalks://** where as insecure connections (via http) should be referenced via **nctalk://**.
Valid syntaxes are as follows:
* `nctalk://{user}:{password}@{hostname}/{room_id}`
* `nctalk://{user}:{password}@{hostname}:{port}/{room_id}`
* `nctalks://{user}:{password}@{hostname}/{room_id}`
* `nctalks://{user}:{password}@{hostname}:{port}/{room_id}`
You can post in multiple chats by simply chaining them at the end of the URL.
* `nctalk://{user}:{password}@{hostname}:{port}/{room_id1}/{room_id2}/{room_id3}`
* `nctalks://{user}:{password}@{hostname}:{port}/{room_id1}/{room_id2}/{room_id3}`
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| hostname | Yes | The hostname of the server hosting your Nextcloud service.
| user | Yes | The user of the nextcloud service you have set up.
| password | Yes | The password associated with the **user** for your Nextcloud account.
| room_id | Yes | The room_id of Nextcloud Talk.
#### Example
Send a secure nextcloud talk message to the room _93nfkdn3_:
```bash
# Assuming our {host} is localhost
# Assuming our {user} is user1
# Assuming our (user1) {password} is 12345-67890-12345-67890-12345:
apprise nctalks://user1:12345-67890-12345-67890-12345@localhost/93nfkdn3
```
### Header Manipulation
Some users may require special HTTP headers to be present when they post their data to their server. This can be accomplished by just sticking a hyphen (**-**) in front of any parameter you specify on your URL string.
```bash
# Below would set the header:
# X-Token: abcdefg
#
# We want to send an insecure connection (we'll use ncloud://)
# Assuming our {host} is localhost
# Assuming our {user} is user1
# Assuming our (user1) {password} is 12345-67890-12345-67890-12345
# We want to notify Room _93nfkdn3_:
apprise -vv -t "Test Message Title" -b "Test Message Body" \
nctalks://user1:12345-67890-12345-67890-12345@localhost/93nfkdn3?-X-Token=abcdefg
# Multiple headers just require more entries defined with a hyphen in front:
# Below would set the headers:
# X-Token: abcdefg
# X-Apprise: is great
#
# Assuming our {host} is localhost
# Assuming our {user} is user1
# Assuming our (user1) {password} is 12345-67890-12345-67890-12345
# We want to notify Room _93nfkdn3_:
apprise -vv -t "Test Message Title" -b "Test Message Body" \
nctalks://user1:12345-67890-12345-67890-12345@localhost/arnold?-X-Token=abcdefg&-X-Apprise=is%20great
```