mirror of
https://github.com/caronc/apprise.git
synced 2025-08-09 16:35:07 +02:00
Created Notify_whatsapp (markdown)
54
Notify_whatsapp.md
Normal file
54
Notify_whatsapp.md
Normal file
@ -0,0 +1,54 @@
|
||||
* **Source**: https://developers.facebook.com/docs/whatsapp/cloud-api/get-started
|
||||
* **Icon Support**: No
|
||||
* **Attachment Support**: No
|
||||
* **Message Format**: Text
|
||||
* **Message Limit**: 1024 Characters per message
|
||||
|
||||
### Syntax
|
||||
Valid syntax is as follows:
|
||||
* `whatsapp://{token}@{from_phone_id}/{targets}`
|
||||
* `whatsapp://{template}:{token}@{from_phone_id}/{targets}`
|
||||
|
||||
### Parameter Breakdown
|
||||
| Variable | Required | Description
|
||||
| ----------- | -------- | -----------
|
||||
| token | Yes | This is the **Access Token** associated with your Meta WhatsApp App
|
||||
| from | Yes | This is the **From Phone ID** associated with your Meta WhatsApp App; this isn't to be confused with your actual phone number. The ID is a separate assignment (about 14 digits long)
|
||||
| targets |Yes| The target individuals on WhatsApp you wish to notify
|
||||
| template | No | You can optionally specify a `template_name` here (such as `hello_world` which is the default one created once you set yourself up your Meta App). This causes Apprise to pull from your template defined.
|
||||
| lang | No | If you've defined a template to reference, you can optionally over-ride the default language of `en_US` to reference a different version of the template specified.
|
||||
|
||||
## Template Variables
|
||||
The templates you generate allow you to specify `{{1}}` and `{{2}}`, etc which are substituted during the Apprise runtime. To pre-set these values, simply leverage the `:` (colon) prefix in front of the index you wish to define.
|
||||
|
||||
`?:3=My Value` for example would assign `My Value` to `{{3}}` during the runtime. You must identify all indexes defined or you will get an error from the upstream server.
|
||||
|
||||
If you wish to assign the `body` or `type` from Apprise, these special keywords are specified instead with the `:` (colon) prefix providing the mapping/over-ride. For example: `?:body=1` would be accepted and would assign `{{1}}` the contents of the `body` passed into Apprise.
|
||||
|
||||
#### Example
|
||||
Send a WhatsApp Notification:
|
||||
```bash
|
||||
# Test out the changes with the following command:
|
||||
apprise -b "Test Message" \
|
||||
"whatsapp://token@from_phone_id/to_phone_no/"
|
||||
|
||||
# Templates can be handled like so:
|
||||
apprise -b "Test Message" \
|
||||
"whatsapp://template_name:token@from_phone_id/to_phone_no/"
|
||||
|
||||
# If you have defined {{1}} and {{2}} tokens, you can assign them values like so:
|
||||
apprise -b "Test Message" \
|
||||
"whatsapp://template_name:token@from_phone_id/to_phone_no/?:1=the data i want put here&:2=more data here"
|
||||
|
||||
# The :<id> is how you map {{<id>}}elements. If you want to associated the body or
|
||||
# message type with an id, then there are 2 reserved keywords that you can use for this:
|
||||
# The below would make sure the Apprise Body value would be placed in the {{1}} element:
|
||||
apprise -b "Test Message" \
|
||||
"whatsapp://template_name:token@from_phone_id/to_phone_no/?:body=1"
|
||||
|
||||
# You can mix and match the keywords and types:
|
||||
apprise -b "Test Message" \
|
||||
"whatsapp://template_name:token@from_phone_id/to_phone_no/?:body=2&:type=3&1:MyID1Value"
|
||||
|
||||
# It's up to the developer to make sure that all of the {{1}}, {{2}}, etc are assigned correctly
|
||||
```
|
Reference in New Issue
Block a user