ipecs-one-web-sdk v0.0.1

iPECS ONE Web SDK

The iPECS ONE Web SDK allows developers building web application with the javascript APIs to use iPECS ONE features.

• Example page

Table of contents

• Features
• Prerequisites
• Installation
• Authentication
• Rooms
• Calls
• Users
• Presence
• Settings

Features

Following are the core functionalities that the iPECS ONE Web SDK provides.

• Make and receive voice and video call.
• PBX additional features.
• Send and receive text message.
• Conversation list.
• Users and Rooms list.
• Presence indication.
• Search users.
• Settings for additional features.

Prerequisites

Ensure you have met the following requirements:

• You must have an account for iPECS ONE service.
• To use npm packages, you need to install a Nodejs development environment.

Installation

You need an account to use the SDK, and the SDK library must be installed.

NPM

In the web framework of the Node environment such as React, Vue, Angular, etc., the SDK library is installed as an npm package.

1. Install library via npm

   npm install ipecs-one-web-sdk --save

2. Import the library wherever you want to use the library

   import { sdk } from "ipecs-one-web-sdk";
   
   const { auth, room, call, user, setting } = sdk;

CDN

In the web page, the library can be included by script tag from CDN.

1. Include the library in your HTML code.

   <script type="text/javascript" src="script-path/ipecs-one-web-sdk.min.js"></script>

2. Use the library as a global variable named ipecsonewebsdk.

   <script type="text/javascript">
     const { auth, room, call, user, setting } = ipecsonewebsdk;
   </script>

Authentication

Authentication is required to use the iPECS ONE features.

Login

Logout

Rooms

Get rooms list of rooms

Get conversation list of room

Send text message

Receive text message

Calls

Make a call

Receive a call

Users

Get users list of rooms

Search users of server

Change my information

Presence

Get presences list of users of rooms

Change my presence

Receive changed presence

Settings

Set call forwarding

Set anonymous call reject