Skip to content

Commit

Permalink
Update readme - adding new version changes
Browse files Browse the repository at this point in the history
  • Loading branch information
t0mer committed Apr 4, 2024
1 parent d9958ba commit d250255
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,46 @@ notify:
name: greenapi
instance_id: #Set the instanceid
token: #Set the greenapi token.
target: #Comma separated values. Contact should end with @c.us and group with @g.us
```
* instance_id is the Green API instance id.
* token is the Green API instance token.
* Target is the chat/contact/group id to send the message to:
* For groups, the id should end with *@g.us*
* For chats, the id should end with *@c.us*
* You can set up to 3 targets, separated with commas **[email protected],[email protected],[email protected]**. The message wil be sent to all.
## Sending a message
To Send a message you call the service and provide the following paramaters:
* message (**Required**): Test to send.
* target (**Required**): Tha chat/group ir to send the message to.
![Send text message](screenshots/text_message.png)
Or from Yaml mode:
```yaml
service: notify.greenapi
data:
message: New Whatsapp component
target: 972*********@c.us
```
### Optional - Attache media to message
To send message with media, add the following to the data parameter:
* file : [Path to the file]
![Send media](screenshots/send_media.png)
Or from Yaml mode:
```yaml
service: notify.greenapi
data:
message: New Whatsapp component
target: 972*********@c.us
data:
file: /config/images/Capture.png

```

# Important
### If the path to the file does not exists no message will be sent.
Binary file added screenshots/send_media.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/text_message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d250255

Please sign in to comment.