Skip to content

Commit

Permalink
Updated README, added a comment about title param.
Browse files Browse the repository at this point in the history
  • Loading branch information
shlomki committed Apr 23, 2024
1 parent 68211fd commit 9b38c28
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ Restart Home Assistant and add the following section to your *configuration.yaml
notify:
- platform: greenapi
name: greenapi
instance_id: #Set the instanceid
token: #Set the greenapi token.
instance_id: #REQUIRED: Set the instanceid
token: #REQUIRED: Set the greenapi token.
target: #OPTIONAL! Set the detault target. If you set the default target here, you won't have to specify it again in your service calls.
```
* instance_id is the Green API instance id.
Expand All @@ -80,21 +81,11 @@ notify:
* For groups, the id should end with *@g.us*
* For chats, the id should end with *@c.us*
You can also set the default target in your notify service configuration, so that you don't have to specify it every time you call the service.
Example:
```yaml
notify:
- platform: greenapi
name: me
instance_id: #Set the instanceid
token: #Set the greenapi token.
target: #Set the default target.
```
## Sending a message
To Send a message you call the service and provide the following parameters:
* message (**Required**): Test to send.
* title (**OPTIONAL**): Add a title for the message in **bold**.
* target (**OPTIONAL** if you've already defined the default target in your notify service, otherwise required): The chat/group id to send the message to.
![Send text message](screenshots/text_message.png)
Expand Down

0 comments on commit 9b38c28

Please sign in to comment.