github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Update with additional info, minor fixes and clarifications

master
threema-eduard 2023-11-23 09:37:24 +01:00
parent b54534b9fa
commit 4c3e0cfb55
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Notify_threema.md

@ -2,17 +2,17 @@
* **Source**: https://gateway.threema.ch/ * **Source**: https://gateway.threema.ch/
* **Icon Support**: No * **Icon Support**: No
* **Message Format**: Text * **Message Format**: Text
* **Message Limit**: 3500 Characters per Message * **Message Limit**: 3500 Characters per message
### Setup ### Setup
You need to first set up an account with [Threema](https://gateway.threema.ch/) which will grant you access to your Threema 8 character User ID (which starts with an asterix (`*`). e.g `*THREEMA` You need to set up a [Threema Gateway](https://gateway.threema.ch/) account first, which will allow you to request and access one or more 8-character Gateway IDs (each starting with an asterisk (`*`), e.g., `*THREEMA`).
## Account Setup ## Account Setup
* Create your Threema Gateway account at https://gateway.threema.ch/ and confirm your E-Mail address * Create your Threema Gateway account at https://gateway.threema.ch/, and confirm your e-mail address
* For credits: * For credits:
* Ask them via E-Mail for test credits and we will get you covered for some testing * Ask Threema Gateway support via e-mail (support-gateway at threema.ch) for test credits, and they will get you covered for some testing
* OR acquire them after logging into your Gateway account. * OR acquire them after logging into your Gateway account.
* Request your Simple or E2E Gateway ID. From their, they will then create your ID and you will find the corresponding ID secret on the ID overview page. * Request your Simple or E2E Gateway ID. After a short review, Threema will then create your ID, and you will find the corresponding ID secret on the ID overview page. This usually takes no more than one or two business days.
### Syntax ### Syntax
Valid syntax is as follows: Valid syntax is as follows:
@ -24,20 +24,20 @@ Valid syntax is as follows:
- ```threema://{gateway_id}@{secret}/{phone}``` - ```threema://{gateway_id}@{secret}/{phone}```
- ```threema://{gateway_id}@{secret}/{phone1}/{phone2}/{phone3}/{phoneN}``` - ```threema://{gateway_id}@{secret}/{phone1}/{phone2}/{phone3}/{phoneN}```
You can freely mix/match the variables as well: You can also freely mix/match the variables:
- ```threema://{gateway_id}@{secret}/{phone1}/{user1}/{email1}/...``` - ```threema://{gateway_id}@{secret}/{phone1}/{user1}/{email1}/...```
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | | Variable | Required | Description |
|----------|----------|-------------| |----------|----------|-------------|
| gateway_id | Yes| Your Gateway ID (8 characters that usually start with a `+`. You may use `?from=` (or `gwid`) as an alias to this variable. These usually start with an asterisk (`*`) such as `*MYGWYID` | | gateway_id | Yes| Your Gateway ID (8 characters that usually start with a `+`). You may use `?from=` (or `gwid`) as an alias to this variable. These usually start with an asterisk (`*`), e.g., `*MYGWYID` |
| secret | Yes| Your Threema API Secret associated with your account. You may use `?secret=` as an alias to this variable. | | secret | Yes| The ID secret associated with your Gateway ID. You may use `?secret=` as an alias to this variable. |
| target | No| Specfiy Threema UserID, Email Address, or Phone No. If no target is specified then your User ID is used instead. There is no limit to the number of targets you specify. You may use `?to=` as an alias to this variable.| | target | No| Specfiy the recipient Threema ID, e-mail address, or phone no. There is no limit to the number of targets you may specify. You may use `?to=` as an alias to this variable.|
#### Example #### Example
Send a Threema (Gateway) Simple notification Send a Threema (Gateway) Simple Notification
```bash ```bash
# Assume: # Assume:
# - our {gateway_id} is *MYGWYID # - our {gateway_id} is *MYGWYID
@ -47,7 +47,7 @@ apprise -vv -t "Test Message Title" -b "Test Message Body" \
threema://*MYGWYID@abc123-2345/6135551234 threema://*MYGWYID@abc123-2345/6135551234
``` ```
Send a Threema (Gateway) Simple notification to another Threema User: Send a Threema (Gateway) Simple Notification to a Threema User by specifying their ID:
```bash ```bash
# Assume: # Assume:
# - our {gateway_id} is *MYGWYID # - our {gateway_id} is *MYGWYID