coopgo-platform
/
gorush
7
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update README.md. Clarify sending notifications using Firebase (#392) 

It was [not obvious](https://github.com/appleboy/gorush/issues/391) that I should specify `platform=2 (Android)` if  I want to send notifications on both Android and iOS devices using Firebase, so here are some changes in documentation. Thanks!
This commit is contained in:
Belek 2019-02-04 16:06:09 +06:00 committed by Bo-Yi Wu
parent 1005389bdf
commit 1ef90c8461
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -25,6 +25,7 @@ A push notification micro server using [Gin](https://github.com/gin-gonic/gin) f
- [Command Usage](#command-usage) - [Command Usage](#command-usage)
- [Send Android notification](#send-android-notification) - [Send Android notification](#send-android-notification)
- [Send iOS notification](#send-ios-notification) - [Send iOS notification](#send-ios-notification)
- [Send Android or iOS notifications using Firebase](#send-android-or-ios-notifications-using-firebase)
- [Run gorush web server](#run-gorush-web-server) - [Run gorush web server](#run-gorush-web-server)
- [Web API](#web-api) - [Web API](#web-api)
- [GET /api/stat/go](#get-apistatgo) - [GET /api/stat/go](#get-apistatgo)
@ -305,6 +306,13 @@ $ gorush -ios -m "your message" -i "your certificate path" \
-production -production
``` ```
### Send Android or iOS notifications using Firebase
Send single notification with the following command:
```bash
$ gorush -android -m "your message" -k "API key" -t "Device token"
```
## Run gorush web server ## Run gorush web server
Please make sure your [config.yml](config/config.yml) exist. Default port is `8088`. Please make sure your [config.yml](config/config.yml) exist. Default port is `8088`.
@ -450,6 +458,18 @@ Simple send Android notification example, the `platform` value is `2`:
] ]
} }
``` ```
Simple send notification on Android and iOS devices using Firebase, the `platform` value is `2`:
```json
{
"notifications": [
{
"tokens": ["token_a", "token_b"],
"platform": 2,
"message": "This notification will go to iOS and Android platform via Firebase!"
}
]
}
```
Send multiple notifications as below: Send multiple notifications as below:
@ -485,7 +505,7 @@ Request body must has a notifications array. The following is a parameter table
| name | type | description | required | note | | name | type | description | required | note |
|-------------------------|--------------|---------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------| |-------------------------|--------------|---------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------|
| tokens | string array | device tokens | o | | | tokens | string array | device tokens | o | |
| platform | int | platform(iOS,Android) | o | 1=iOS, 2=Android | | platform | int | platform(iOS,Android) | o | 1=iOS, 2=Android (Firebase) |
| message | string | message for notification | - | | | message | string | message for notification | - | |
| title | string | notification title | - | | | title | string | notification title | - | |
| priority | string | Sets the priority of the message. | - | `normal` or `high` | | priority | string | Sets the priority of the message. | - | `normal` or `high` |