Skip to content

Remove Push Notification documentation #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+41 −350
Open

Remove Push Notification documentation #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d91b167
remove push notification
niravcodes Nov 6, 2025
b6716c1
fix link
niravcodes Nov 6, 2025
3e02081
nuke push
niravcodes Nov 6, 2025
e232b6c
fix title
niravcodes Nov 6, 2025
262e478
remove push entirely
niravcodes Nov 7, 2025
951c9d9
remove push from redirects-map
niravcodes Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 4 additions & 127 deletions website/docs/browser-sdk/tech-ref/SignalWire Client/client/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ The call invites can be accepted or rejected as per user input.
#### Example

```javascript
// Receive calls using push notifications
// Receive calls using websocket notifications
client.online({
incomingCallHandlers: {
all: __incomingCallHandler,
Expand Down Expand Up @@ -284,84 +284,13 @@ console.log(await client.getSubscriberInfo())
"country": "US",
"region": "East",
"company_name": "Example Inc",
"push_notification_key": "bm90aGluZyBpbnRlcmVzdGluZyBoZXJlOyk=",
"app_settings": {
"display_name": "Cool Application",
"scopes": ["read", "write"]
}
}
```

### registerDevice

▸ **registerDevice**(`options`): `Promise<`[`Response`](#response-for-registerdevice-json)`>`

Register a device for receiving SignalWire notifications related to the registering subscriber.

#### Parameters

| Name | Type | Description |
| :-------------------- | :-------------------------------- | :----------------------------------------------------------------------------------------- |
| `options` | `object` |
| `options.deviceToken` | `string` | The token you receive from the device after getting notification permission from the user. |
| `options.deviceType` | `"iOS" \| "Android" \| "Desktop"` | The address type to filter for. Possible values: `subscriber`, `room`, `app`, `call`. |

#### Response for RegisterDevice (JSON)

The method call returns a promise to a JSON object with the following fields:

| Name | Type | Description |
| :---------------------- | :-------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `string` | ID of the current device registration. Use this when sending a request to unregister this device. |
| `device_token` | `string` | Echo of the`options.deviceToken` option that was sent while registering. |
| `device_type` | `"iOS" \| "Android" \| "Desktop"` | Echo of the `options.deviceType` option that was sent while registering. |
| `device_name` | `null` | Not yet implemented |
| `push_notification_key` | `string` | SignalWire only sends encrypted push notifications. When you receive them, use this key to decode them ([Details](/sdks/browser-sdk/signalwire-client/push-notifications)) |
| `date_registered` | `string` | The date string when the server registered this device |

#### Example

```javascript
await client.registerDevice({ deviceToken: "XYZ", deviceType: "Desktop" });
```

```json
{
"id": "222rr8b2-9070-4383-af17-e48b97e900a0",
"device_token": "XYZ",
"device_name": null,
"device_type": "Desktop",
"push_notification_key": "qMdif...fZzz",
"date_registered": "2024-02-27T12:46:42Z"
}
```

### unregisterDevice

▸ **registerDevice**(`{id:string}`): `Promise<{}>`

Cancels the registration of the device mentioned by its ID.

#### Parameters

| Name | Type | Description |
| :--- | :------- | :------------------------------------------------------------------------------------------------- |
| `id` | `string` | The ID of the device that you need to unregister. This ID is returned when registering the device. |

#### Returns

Returns empty object when successful. Throws error with the server's error when unsuccessful.

#### Example

```javascript
const device = await client.registerDevice({ deviceToken: "XYZ", deviceType: "Desktop" });
// commit `device.id` and `device.push_notification_key` to a persistent storage like localStorage or session or file
// ...

// When the time comes to "log out" or stop getting notifications:
await client.unregisterDevice({ id: device.id });
```

### connect

Expand All @@ -382,55 +311,6 @@ automatically in most cases.

Nothing

### handlePushNotification

▸ **handlePushNotification**(`payload`): `Promise<Call>`

Creates the call based on the push notification that the device received.

Dials to the address specified in the `to` parameter, and returns a `Call` object if successful.
If the `rootElement` was set during [client instantiation](#instantiation),
the video call will be injected into that container.

#### Parameters

| Name | Type | Description |
| :-------- | :------- | :------------------------------------ |
| `payload` | `object` | The contents of the push notification |

The exact format of Push Notification you receive will vary depending from
Android to iOS to Web. But it will always contain the following information:

| Name | Type | Description |
| :--------------------- | :------- | :--------------------------------------------------------------- |
| `encryption_type` | `string` | Type of encryption used (`'aes_256_gcm'` or `'none'`) |
| `notification_uuid` | `string` | UUID of the push notification |
| `with_video` | `string` | Indicates whether the call includes video (`"true" \| "false"`) |
| `incoming_caller_name` | `string` | Name of the incoming caller |
| `incoming_caller_id` | `string` | ID of the incoming caller |
| `invite` | `string` | Invitation (base 64 encoded, compressed, and possibly encrypted) |
| `title` | `string` | Title of the call |
| `type` | `string` | Type of notification (`'call_invite'`) |
| `iv` | `string` | The initialization vector of the encryption (base 64) |
| `tag` | `string` | The tag info for the encryption (base 64) |
| `version` | `string` | The version of the push notification received |

In addition to this, you are required to add a `decrypted` field which has the decrypted SDP invite.
To decrypt the encrypted invite, use the encryption key that was sent while calling `registerDevice`
method. The [Push Notifications](/sdks/browser-sdk/signalwire-client/push-notifications) reference goes through this in detail.

#### Returns

Promise to a JavaScript object with the following attributes:

| Name | Type | Description |
| :------------- | :------- | :----------------------------------------------------------------- |
| `resultType` | `string` | a resultType of `"inboundCall"` signifies that a call was received |
| `resultObject` | `Call` | The Call object |

Unlike with the `dial` method, the `Call` object here has not been started.
To accept and start the call, use `Call.answer()` and to reject the call, use `Call.hangup()`.

### updateToken

▸ **updateToken**(token:`string`): `Promise<void>`
Expand Down Expand Up @@ -496,8 +376,7 @@ Use this object to assign callback functions which get invoked when a call is re

| Name | Type | Required? | Description |
| :----------------- | :--------------------------------------- | :-------- | :-------------------------------------------------------------------------- |
| `all` | `(`[`IncomingCallNotification`]`)=>void` | Optional | Callback for calls received either as a push notification or from websocket |
| `pushNotification` | `(`[`IncomingCallNotification`]`)=>void` | Optional | Callback for calls received via push notification (overrides `all`) |
| `all` | `(`[`IncomingCallNotification`]`)=>void` | Optional | Since push support has been removed, identical to `websocket` |
| `websocket` | `(`[`IncomingCallNotification`]`)=>void` | Optional | Callback for calls received via websocket (overrides `all`) |

[`IncomingCallNotification`]: #incomingcallnotification
Expand Down Expand Up @@ -526,18 +405,16 @@ This is the type of object that is passed into the [IncomingCallHandlers] callba

| Name | Type | Description |
| :------------------ | :---------------------------------- | :-------------------------------------------------------------------------- |
| `source` | `"websocket"`\|`"pushNotification"` | |
| `source` | `"websocket"` | |
| `callID` | `string` | Unique ID of the incoming call |
| `sdp` | `string` | The encrypted payload documented in the [push notification payload] section |
| `sdp` | `string` | deprecated |
| `caller_id_name` | `string` | Name of the caller |
| `caller_id_number` | `string` | ID or number of the caller |
| `callee_id_name` | `string` | Name of the callee |
| `callee_id_number` | `string` | ID or number of the callee |
| `display_direction` | `string` | Direction of the call |
| `nodeId` | `string` | The node from where the call was received |

[push notification payload]: /sdks/browser-sdk/signalwire-client/push-notifications#payload

### CallOptions

Ƭ **CallOptions**: `Object`
Expand Down
36 changes: 36 additions & 0 deletions website/docs/browser-sdk/tech-ref/SignalWire Client/notifications.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Notifications
slug: /signalwire-client/notifications
---

# Notifications

If you've initialized the SignalWire Client with a subscriber token, you can opt into receiving notifications
whenever that subscriber address is called using WebSockets.

The WebSocket notifications are delivered over the WebSocket connection **while your application is active**, and you have
called the `online()` method to opt into receiving them.

To receive incoming call notifications over WebSocket, call `client.online()` with an `incomingCallHandlers` object:

```javascript
client.online({
incomingCallHandlers: {
websocket: (callInvite) => {
const callerName = callInvite.invite.details?.caller_id_name;
const callerNumber = callInvite.invite.details?.caller_id_number;

// to accept:
const roomSession = await callInvite.invite.accept(params);

// to reject:
callInvite.invite.reject();
},
},
});
```

When an incoming call arrives, the `websocket` handler receives a `callInvite` object containing:
- `callInvite.invite.details` - call and caller information `IncomingInvite`
- `callInvite.invite.accept()` - accepts the call and returns a `CallSession`
- `callInvite.invite.reject()` - rejects the call
108 changes: 0 additions & 108 deletions website/docs/browser-sdk/tech-ref/SignalWire Client/push_notifications.mdx
View file
Open in desktop

This file was deleted.

Loading