Skip to content

Commit

Permalink
mobile: small typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sduthil committed Aug 2, 2024
1 parent 1026648 commit 66fb2c9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
21 changes: 10 additions & 11 deletions content/uc-doc/api_sdk/mobile/push_notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@ The configuration procedure is as follow:
See
[Google Cloud service account documentation](https://cloud.google.com/iam/docs/service-accounts-create?hl=en)
for more information;
3. **download the service account json credentials file**
A JSON file containing the service account credentials can be downloaded from the Firebase
console;
3. **download the service account JSON credentials file** A JSON file containing the service account
credentials can be downloaded from the Firebase console;
See
[Firebase documentation](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments).
4. **create or update the external mobile config in wazo-auth, providing the content of the
Expand All @@ -52,8 +51,8 @@ The configuration procedure is as follow:
configuration for mobile push notifications support;
- `POST` on that endpoint will create a fresh configuration if none exist, and `PUT` will allow
updating the fields of that configuration;
- the `fcm_service_account_info` field must be filled with the content of the downloaded json
file from step 3(as a json string);
- the `fcm_service_account_info` field must be filled with the content of the downloaded JSON
file from step 3 (as a JSON string);
- the `fcm_sender_id` is also required and should be the FCM project number assigned to the
project, as shown in the Firebase console;
see the
Expand All @@ -64,7 +63,7 @@ The configuration procedure is as follow:

To support push notifications to iOS devices, the requirements and procedure are similar to FCM
support. An Apple developer account is required.
This account is used to register an Apple app(the mobile client), which support push
This account is used to register an Apple app (the mobile client), which support push
notifications.
A certificate is generated for that app, and is provided to the Wazo Platform stack for
authentication to APNS when delivering the push notifications.
Expand Down Expand Up @@ -108,7 +107,7 @@ Here are the push notification types which are currently generated by the Wazo P
call, which they have a chance to answer;
- the notification data includes call event data, such as Caller ID;
- `missedCall`: a user-facing push notification to notify that a call has been received and was not
answered by the user(whether an automatic forward has occured or not);
answered by the user (whether an automatic forward has occurred or not);
- the notification title indicates that there is a new missed call, and the notification body
specifies the name and number of the caller;
- the notification data includes call event data, such as Caller ID name and number;
Expand All @@ -118,7 +117,7 @@ Here are the push notification types which are currently generated by the Wazo P
the Caller ID of the voicemail author (caller);
- the notification data includes the voicemail event data;
- `messageReceived`: a user-facing push notification which indicates to the user that a chat message
has been sent to(and received by) them;
has been sent to (and received by) them;
- the notification title will be the alias of the sender, and the body will be the content of the
message; the notification data includes message event data;
- `cancelIncomingCall`: a data-only push notification which tells the mobile app to ignore a
Expand Down Expand Up @@ -147,7 +146,7 @@ curl -X POST \

Here you need to substitute

- `$token`: an authentication token with appropriate permissions(e.g. an admin token),
- `$token`: an authentication token with appropriate permissions (e.g. an admin token),
- `$tenant_uuid`: the uuid of the tenant of the user being targeted
- `"123e4567-e89b-12d3-a456-426614174000"`: the uuid of the user being targeted

Expand Down Expand Up @@ -202,5 +201,5 @@ test_notification = {
webhookd.mobile_notifications.send(test_notification)
```

The targeted user (`user_uuid`) will receive the push notification on his registered mobile
sessions(if any exist).
The targeted user (`user_uuid`) will receive the push notification on his registered mobile sessions
(if any exist).
4 changes: 2 additions & 2 deletions content/uc-doc/system/wazo-webhookd/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ are:
- http subscriptions
- mobile subscriptions

## mobile subscriptions
## Mobile Subscriptions

As well as supporting configuration of custom behaviors through http subscriptions and custom Python
As well as supporting configuration of custom behaviors through HTTP subscriptions and custom Python
plugins, wazo-webhookd can also automatically create and manage special subscriptions for mobile
users.
These _mobile subscriptions_ can provide push notification services for Wazo Platform events
Expand Down

0 comments on commit 66fb2c9

Please sign in to comment.