Wildix XBees Connect

https://www.npmjs.com/package/@wildix/xbees-connect
Admin
This package is a client library for UI integration applications, enabling interaction with the...
Tokens:146,750
Snippets:1,777
Trust Score:9.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Initialize and use the xBees client

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.0.5-alpha

Demonstrates how to get an instance of the xBees client and log its version. This is the basic setup for interacting with the x-bees service.

```javascript
import Client from "@wildix/xbees-connect";

const xBeesClient = Client.getInstance();

console.log(xBeesClient.version());
```

--------------------------------

### Initialize and use xBees client in JavaScript

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.0.4-alpha_activeTab=code

This JavaScript snippet demonstrates how to import the Client from @wildix/xbees-connect, get an instance of the client, and log its version. It assumes the client has already been installed.

```javascript
import Client from "@wildix/xbees-connect";

const xBeesClient = Client.getInstance();
console.log(xBeesClient.version());
```

--------------------------------

### Initialize and use xBees Connect Client

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.0.4-alpha_activeTab=dependencies

Initialize the xBees Connect client using its singleton instance and then call the version() method to get the client's current version. This demonstrates basic usage after installation.

```javascript
import Client from "@wildix/xbees-connect";

const xBeesClient = Client.getInstance();
console.log(xBeesClient.version());

```

--------------------------------

### Listen for Call Started Events in xBees

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=dependencies

Example of registering a callback to be notified when a call is initiated within the x-bees application. The callback will receive relevant event data.

```javascript
Client.getInstance().onCallStarted(listenerCallback);
```

--------------------------------

### Start a Call with Xbees-Connect

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect_activeTab=dependents

Provides the `startCall` method to initiate a phone call via x-bees, requiring the phone number as a string argument.

```javascript
Client.getInstance().startCall(phoneNumber);
```

--------------------------------

### Install @wildix/xbees-connect using Yarn or npm

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.0.4-alpha_activeTab=dependencies

Install the @wildix/xbees-connect package into your project directory using either Yarn or npm. This is the first step to using the client in your application.

```bash
yarn add @wildix/xbees-connect
```

```bash
npm install @wildix/xbees-connect
```

--------------------------------

### Control Xbees-Connect iFrame Readiness

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect_activeTab=dependents

Provides the `ready()` method for signaling to x-bees that the iFrame is ready to be shown. This should be called when the application starts and is prepared.

```javascript
Client.getInstance().ready();
```

--------------------------------

### Client Initialization and Basic Information

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3

Provides methods for initializing the client, checking UI modes, and retrieving the client version.

```APIDOC
## Client Initialization and Basic Information

### Description
Methods for initializing the client, checking UI modes, and retrieving the client version.

### Methods

#### `Client.getInstance()`
Returns the singleton instance of the x-bees-connect client.

#### `client.showsUi(): boolean`
Checks if the integration is running in a UI mode (ui, d, f).

#### `client.isDataOnly(): boolean`
Checks if the integration is running in data-only mode (no-ui).

#### `client.isSetupDialog(): boolean`
Checks if the integration is running in setup dialog mode (d).

#### `client.isFullsize(): boolean`
Checks if the integration is running in fullsize mode (f).

#### `client.version(): string`
Retrieves the version of the xbees-connect client.

### Request Example
```javascript
import Client from "@wildix/xbees-connect";

const client = Client.getInstance();
console.log(client.version());

if (client.showsUi()) {
  console.log("UI mode is active.");
}
```
```

--------------------------------

### Utility API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect_activeTab=code

Miscellaneous utility methods for interacting with the x-bees environment, such as getting version, starting calls, and managing the clipboard.

```APIDOC
## Utility API

### `version(): string`

Retrieves the version of xBeesConnect.

### `startCall(phoneNumber: string): void`

Sends a request to x-bees to start a call with the specified phone number.

### `reboot(): void`

Sends a request to x-bees to restart the iFrame, reloading with actual parameters and token.

### `setViewport({height: number; width: number}): void`

Sends a request to x-bees about changes in the current frame size.

### `toClipboard(payload: string): void`

Sends a request to x-bees to put a string to the user's clipboard.

### `addEventListener(): Function`

Starts listening for one of the x-bees events and returns the provided callback.

### `removeEventListener(): Function`

Stops listening for one of the x-bees events with the particular callback.

### `onLogout(): void`

Starts listening for the logout event and sends an event to x-bees about the logout ability.

### `sendAnalytics(): void`

Sends analytics data to x-bees for tracking in analytics data.
```

--------------------------------

### Utility and Action API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=versions

Utility functions and actions to interact with the x-bees system, such as getting version, starting calls, and managing clipboard.

```APIDOC
## Utility and Action API

### `version()`

#### Description
Retrieves the version of xBeesConnect.

#### Method
`Client.getInstance().version(): string`

### `startCall(phoneNumber)`

#### Description
Sends a request to x-bees to start a call with the specified phone number.

#### Method
`Client.getInstance().startCall(phoneNumber: string): void`

#### Parameters
*   **phoneNumber** (`string`) - The phone number to call.

### `reboot()`

#### Description
Sends a request to x-bees to restart the iFrame, reloading with actual parameters and token.

#### Method
`Client.getInstance().reboot(): void`

### `setViewport(size)`

#### Description
Sends a request to x-bees about changes in the current frame size.

#### Method
`Client.getInstance().setViewport({height: number; width: number}): void`

#### Parameters
*   **size** (`{height: number; width: number}`) - An object containing the new height and width of the viewport.

### `toClipboard(payload)`

#### Description
Sends a request to x-bees to put a string onto the user's clipboard.

#### Method
`Client.getInstance().toClipboard(payload: string): void`

#### Parameters
*   **payload** (`string`) - The string to copy to the clipboard.

### `sendAnalytics()`

#### Description
Sends analytics data to x-bees for tracking within analytics data.

#### Method
`Client.getInstance().sendAnalytics(): void`
```

--------------------------------

### Utility Functions API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.2.19-alpha_activeTab=dependencies

Provides various utility functions for interacting with x-bees, such as getting the version, starting calls, and managing the iframe.

```APIDOC
## Utility Functions API

### `version(): string`

**Description:** Retrieves the version of the xBeesConnect package.

### Method

`version()

### Parameters

None

### Request Example

```javascript
console.log(Client.getInstance().version());
```

### Response

*   **string** - The version string of the xBeesConnect package.

---

### `startCall(phoneNumber: string)`

**Description:** Sends a request to x-bees to initiate a call to the specified phone number.

### Method

`startCall(phoneNumber: string)

### Parameters

*   **phoneNumber** (string) - Required - The phone number to call.

### Request Example

```javascript
Client.getInstance().startCall('+1234567890');
```

### Response

None

---

### `reboot()`

**Description:** Sends a request to x-bees to restart the iFrame, reloading with the actual parameters and token.

### Method

`reboot()

### Parameters

None

### Request Example

```javascript
Client.getInstance().reboot();
```

### Response

None

---

### `setViewport({height: number; width: number})`

**Description:** Informs x-bees about changes in the current frame size.

### Method

`setViewport({height: number; width: number})

### Parameters

*   **height** (number) - Required - The new height of the viewport.
*   **width** (number) - Required - The new width of the viewport.

### Request Example

```javascript
Client.getInstance().setViewport({ height: 800, width: 1200 });
```

### Response

None

---

### `toClipboard(payload: string)`

**Description:** Sends a request to x-bees to copy the provided string to the user's clipboard.

### Method

`toClipboard(payload: string)

### Parameters

*   **payload** (string) - Required - The string to copy to the clipboard.

### Request Example

```javascript
Client.getInstance().toClipboard('Text to copy');
```

### Response

None

---

### `addEventListener()`

**Description:** Starts listening for one of the x-bees events and returns the provided callback.

### Method

`addEventListener()

### Parameters

None

### Request Example

```javascript
const myListener = () => console.log('x-bees event occurred');
Client.getInstance().addEventListener(myListener);
```

### Response

*   **Function** - The provided callback function.

---

### `removeEventListener()`

**Description:** Stops listening for one of the x-bees events with the particular callback.

### Method

`removeEventListener()

### Parameters

None

### Request Example

```javascript
const myListener = () => console.log('x-bees event occurred');
Client.getInstance().removeEventListener(myListener);
```

### Response

None

---

### `onLogout()`

**Description:** Starts listening for the logout event and sends an event to x-bees indicating that the user is logged out.

### Method

`onLogout()

### Parameters

None

### Request Example

```javascript
Client.getInstance().onLogout();
```

### Response

None

---

### `sendAnalytics()`

**Description:** Sends analytics data to x-bees for tracking in analytics data.

### Method

`sendAnalytics()

### Parameters

None

### Request Example

```javascript
Client.getInstance().sendAnalytics();
```

### Response

None
```

--------------------------------

### Client Initialization and Status

Source: https://www.npmjs.com/package/@wildix/xbees-connect/index

Methods for initializing the client, checking its status, and managing UI display modes.

```APIDOC
## Client Initialization and Status

### `Client.getInstance()`

Description: Retrieves the singleton instance of the x-bees-connect client.

Method: `static getInstance()`

### `ready()`

Description: Sends a signal to x-bees indicating that the iFrame is ready to be shown. This should be called when the application starts and is ready.

Method: `ready()`

### `isAuthorized(payload: string)`

Description: Sends a message to x-bees indicating that the user is authorized and no further actions are required. Returns a Promise resolving with `ResponseFromChannel`.

Method: `isAuthorized(payload: string) => Promise<ResponseFromChannel>`

### `isNotAuthorized(payload: string)`

Description: Sends a message to x-bees indicating that user actions are required. Returns a Promise resolving with `ResponseFromChannel`.

Method: `isNotAuthorized(payload: string) => Promise<ResponseFromChannel>`

### `showsUi()`

Description: Returns `true` if the client is running in a UI mode (ui, d, f), `false` otherwise.

Method: `showsUi(): boolean`

### `isDataOnly()`

Description: Returns `true` if the client is running in data-only mode (`no-ui`), `false` otherwise.

Method: `isDataOnly(): boolean`

### `isSetupDialog()`

Description: Returns `true` if the client is running in dialog/setup mode (`d`), `false` otherwise.

Method: `isSetupDialog(): boolean`

### `isFullsize()`

Description: Returns `true` if the client is running in fullsize mode (`f`), `false` otherwise.

Method: `isFullsize(): boolean`
```

--------------------------------

### Listen for Call Events in xbees-connect

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=code

Provides examples for listening to call started and call ended events. These methods are crucial for managing call states within your integrated application.

```javascript
/*
    onCallStarted: (callback: ListenerCallback) => void;
    onCallEnded: (callback: ListenerCallback) => void;
*/
```

--------------------------------

### Initialization API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.1.2-alpha_activeTab=readme

Methods for initializing and managing the connection readiness with x-bees.

```APIDOC
## Initialization API

### `ready()`

**Description**: Sends a signal to x-bees indicating that the iFrame is ready to be shown. This should be called when the application starts and is ready.

**Method**: N/A (Function call within the client)

**Endpoint**: N/A

### `isAuthorized(payload: string)`

**Description**: Sends a message to x-bees that the user is authorized and no further actions are required.

**Method**: N/A (Function call within the client)

**Endpoint**: N/A

**Parameters**:

#### Request Body
- **payload** (string) - Required - Information indicating user authorization.

### `isNotAuthorized(payload: string)`

**Description**: Sends a message to x-bees that user actions are required.

**Method**: N/A (Function call within the client)

**Endpoint**: N/A

**Parameters**:

#### Request Body
- **payload** (string) - Required - Information indicating that user actions are required.

### Request Example (isAuthorized)
```json
{
  "payload": "user_session_token_or_id"
}
```

### Response Example (isAuthorized/isNotAuthorized)
```json
{
  "status": "success"
}
```
```

--------------------------------

### API Initialization Signals

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3

Methods to signal readiness and authorization status to x-bees.

```APIDOC
## API Initialization Signals

### Description
Methods to signal readiness and authorization status to x-bees.

### Methods

#### `ready()`
Sends a signal to x-bees indicating that the iFrame is ready to be shown. This should be called when the application starts.

#### `isAuthorized: (payload: string) => Promise<ResponseFromChannel>`
Sends a message to x-bees that the user is authorized and no further actions are required.

#### `isNotAuthorized: (payload: string) => Promise<ResponseFromChannel>`
Sends a message to x-bees indicating that user actions are required.

### Request Example
```javascript
// Assuming 'client' is an instance of Client

client.ready();

// After successful authorization
client.isAuthorized("user_token_123").then(response => {
  console.log("Authorization confirmed:", response);
});

// If user actions are needed
client.isNotAuthorized("action_required").then(response => {
  console.log("User action required:", response);
});
```
```

--------------------------------

### Initialization API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.2.31-alpha_activeTab=dependents

Provides methods for initializing and signaling readiness to the x-bees system.

```APIDOC
## POST /api/xbees/initialize

### Description
Sends the signal to x-bees that the iFrame is ready to be shown. This should be called when the application starts and is ready.

### Method
POST

### Endpoint
N/A (Client-side method)

### Parameters
None

### Request Example
```javascript
Client.getInstance().ready();
```

### Response
#### Success Response (200)
Void

#### Response Example
N/A
```

```APIDOC
## POST /api/xbees/authorize

### Description
Sends a message to x-bees indicating that the user is authorized and no further actions are required.

### Method
POST

### Endpoint
N/A (Client-side method)

### Parameters
#### Request Body
- **payload** (string) - Required - Information about the authorization status.

### Request Example
```javascript
Client.getInstance().isAuthorized("user-token");
```

### Response
#### Success Response (200)
- **ResponseFromChannel** (object) - The response from the x-bees channel.

#### Response Example
```json
{
  "status": "success"
}
```
```

```APIDOC
## POST /api/xbees/not-authorized

### Description
Sends a message to x-bees indicating that user actions are required due to authorization issues.

### Method
POST

### Endpoint
N/A (Client-side method)

### Parameters
#### Request Body
- **payload** (string) - Required - Information about the authorization status.

### Request Example
```javascript
Client.getInstance().isNotAuthorized("authorization-error-details");
```

### Response
#### Success Response (200)
- **ResponseFromChannel** (object) - The response from the x-bees channel.

#### Response Example
```json
{
  "status": "pending_user_action"
}
```
```

--------------------------------

### Listen for Call Started Events

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.1.4-y_activeTab=dependents

Starts listening for events indicating that a call has been initiated. It accepts a callback function that will be executed when a call starts.

```javascript
Client.getInstance().onCallStarted((callDetails) => {
    console.log('Call started:', callDetails);
});
```

--------------------------------

### Client Initialization and Status

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=dependents

Methods for initializing the client, checking UI modes, and managing authorization status.

```APIDOC
## Client Initialization and Status

### `Client.getInstance()`

Retrieves the singleton instance of the client.

### `ready()`

Sends the signal to x-bees that the iFrame is ready to be shown. This should be called when the application starts and is ready.

### `isAuthorized(payload: string): Promise<ResponseFromChannel>`

Sends a message to x-bees indicating that the user is authorized and no further actions are required.

### `isNotAuthorized(payload: string): Promise<ResponseFromChannel>`

Sends a message to x-bees indicating that user actions are required.

### `showsUi(): boolean`

Returns `true` if the client is running in a UI mode (`ui`, `d`, `f`).

### `isDataOnly(): boolean`

Returns `true` if the client is running in data-only mode (`no-ui`).

### `isSetupDialog(): boolean`

Returns `true` if the client is running in dialog/setup mode (`d`).

### `isFullsize(): boolean`

Returns `true` if the client is running in fullsize mode (`f`).
```

--------------------------------

### Listen for Call Started Events in xBees

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.2.30-alpha_activeTab=dependents

Sets up a listener to detect when a call is started within x-bees using `onCallStarted`. The callback function receives details about the started call.

```javascript
Client.getInstance().onCallStarted(callInfo => {
    console.log('Call started:', callInfo);
});
```

--------------------------------

### Initialization API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.0.5-alpha_activeTab=dependents

Methods for initializing and managing the connection with x-bees.

```APIDOC
## POST /xbees/initialize

### Description
Sends a signal to x-bees indicating that the iFrame is ready to be shown. This should be called when the application starts and is ready.

### Method
POST

### Endpoint
/xbees/initialize

### Parameters
N/A

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "ready"
}
```
```

```APIDOC
## POST /xbees/authorize

### Description
Sends a message to x-bees indicating that the user is authorized and no further actions are required.

### Method
POST

### Endpoint
/xbees/authorize

### Parameters
#### Request Body
- **payload** (string) - Information confirming user authorization.

### Request Example
```json
{
  "payload": "user_token_or_id"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message from x-bees.

#### Response Example
```json
{
  "message": "Authorization confirmed"
}
```
```

```APIDOC
## POST /xbees/not_authorized

### Description
Sends a message to x-bees indicating that user actions are required, potentially due to an authorization issue.

### Method
POST

### Endpoint
/xbees/not_authorized

### Parameters
#### Request Body
- **payload** (string) - Information detailing why user actions are required.

### Request Example
```json
{
  "payload": "re-authentication_required"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message from x-bees.

#### Response Example
```json
{
  "message": "User action required"
}
```
```

--------------------------------

### Listening for Call Started Events in JavaScript

Source: https://www.npmjs.com/package/@wildix/xbees-connect/index

Attaches a listener to detect when a call is initiated within the x-bees environment. The provided callback is executed upon call start.

```javascript
Client.getInstance().onCallStarted(callback: ListenerCallback) => void;
```

--------------------------------

### Install @wildix/xbees-connect npm Package

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect_activeTab=dependents

Command to install the @wildix/xbees-connect package using npm. This is a standard Node Package Manager command for adding dependencies to a project.

```bash
npm i @wildix/xbees-connect
```

--------------------------------

### Listen for Theme and PBX Token Changes

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=code

Examples of setting up listeners for theme changes and PBX token updates. These methods allow your application to react to dynamic changes within the x-bees environment.

```javascript
/*
    onThemeChange: (callback: ThemeChangeListenerCallback) => void;
    onPbxTokenChange: (callback: ListenerCallback) => void;
*/
```

--------------------------------

### Control xBees Client Actions

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect_activeTab=versions

Examples demonstrating various control functions for the xBees client, including restarting the iFrame (`reboot`), setting viewport dimensions (`setViewport`), copying text to the clipboard (`toClipboard`), and initiating a phone call (`startCall`).

```javascript
version(): string
startCall(phoneNumber: string)
reboot()
setViewport({height: number; width: number})
toClipboard(payload: string)
```

--------------------------------

### Perform Actions with xbees-connect Client

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=code

Demonstrates various actions that can be performed using the x-bees-connect client, such as starting calls, rebooting the iframe, setting viewport size, and managing clipboard content.

```javascript
/*
    version(): string
    startCall(phoneNumber: string)
    reboot()
    setViewport({height: number; width: number})
    toClipboard(payload: string)
*/
```

--------------------------------

### Start a call using x-bees-connect

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=dependents

Initiates a phone call via x-bees to a specified phone number. This function sends a request to the x-bees system to start the call.

```javascript
client.startCall("+1234567890");
```

--------------------------------

### x-bees-connect API: Initialization signals

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=versions

Provides methods to signal readiness to x-bees (`ready`) and to indicate user authorization status (`isAuthorized`, `isNotAuthorized`). These are crucial for the initial setup and communication flow.

```javascript
/*
ready(): Sends the signal to x-bees that iFrame is ready to be shown.
isAuthorized: (payload: string) => Promise<ResponseFromChannel>
isNotAuthorized: (payload: string) => Promise<ResponseFromChannel>
*/
```

--------------------------------

### Initialization API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.1.4-y_activeTab=dependents

Methods related to the initial setup and readiness of the x-bees connect client.

```APIDOC
## Initialization API

### `ready()`

Sends the signal to x-bees that iFrame is ready to be shown. iFrame should send it when the application starts and is ready.

### Method

`ready()`

### Parameters

None

### Request Example

```javascript
Client.getInstance().ready();
```

### Response

No explicit response documented, indicates readiness.

### `isAuthorized(payload: string)`

Sends the message to x-bees that the user is authorized and no more actions are required.

### Method

`isAuthorized(payload: string)`

### Parameters

*   **payload** (string) - Required - Information indicating user authorization.

### Request Example

```javascript
Client.getInstance().isAuthorized('user-token-123');
```

### Response

*   **ResponseFromChannel** - The response from the x-bees channel.

### `isNotAuthorized(payload: string)`

Sends the message to x-bees that user actions are required.

### Method

`isNotAuthorized(payload: string)`

### Parameters

*   **payload** (string) - Required - Information indicating user authorization is not complete.

### Request Example

```javascript
Client.getInstance().isNotAuthorized('user-action-needed');
```

### Response

*   **ResponseFromChannel** - The response from the x-bees channel.
```

--------------------------------

### Initialization API

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.2.16-alpha_activeTab=code

Methods related to the initialization and readiness of the x-bees iFrame.

```APIDOC
## ready()

### Description
Sends the signal to x-bees that the iFrame is ready to be shown. This should be called when the application starts and is ready.

### Method
JavaScript

### Endpoint
N/A (Client-side method)

### Parameters
None

### Request Example
```javascript
Client.getInstance().ready();
```

### Response
None
```

```APIDOC
## isAuthorized

### Description
Sends a message to x-bees indicating that the user is authorized and no further actions are required.

### Method
JavaScript

### Endpoint
N/A (Client-side method)

### Parameters
* **payload** (string) - Required - Additional authorization details.

### Request Example
```javascript
Client.getInstance().isAuthorized('user-token-123');
```

### Response
* **ResponseFromChannel** - A promise that resolves with the response from the x-bees channel.
```

```APIDOC
## isNotAuthorized

### Description
Sends a message to x-bees indicating that user actions are required for authorization.

### Method
JavaScript

### Endpoint
N/A (Client-side method)

### Parameters
* **payload** (string) - Required - Details about required user actions.

### Request Example
```javascript
Client.getInstance().isNotAuthorized('action-required');
```

### Response
* **ResponseFromChannel** - A promise that resolves with the response from the x-bees channel.
```

--------------------------------

### Start a Call

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.1.4-y_activeTab=dependents

Sends a request to x-bees to initiate a phone call to the specified phone number.

```javascript
Client.getInstance().startCall("+1234567890");
```

--------------------------------

### Get xBees Connect Version

Source: https://www.npmjs.com/package/@wildix/xbees-connect/package/%40wildix/xbees-connect/v/1.3_activeTab=dependencies

Retrieves the current version string of the xBeesConnect client library.

```javascript
const version = Client.getInstance().version();
```
Tokens:
Raw