omikit-plugin 3.2.65 → 3.2.66

package/README.md

@@ -694,18 +694,27 @@ We need you request permission about call before make call:
   // Result is the same with startCall
   ```
 
-  - Accept a call:
+  - __Accept a call__:
 
     ```javascript
     import {joinCall} from 'omikit-plugin';
 
     await joinCall();
     ```
+    __Note__: When calling `joinCall`, sdk will check permission of microphone and camera. If have any permission denied, sdk will send a event `onRequestPermissionAndroid` with list permission you need to request. You need to request permission before calling `joinCall` again.
 
-    Note: When calling `joinCall`, sdk will check permission of microphone and camera. If have any permission denied, sdk will send a event `onRequestPermissionAndroid` with list permission you need to request. You need to request permission before calling `joinCall` again.
 
-  - End a call: We will push a event `endCall` for you.
+ - __Call forwarding__: used to transfer the current call to any employee's sip number
+     ```javascript
+      import {transferCall} from 'omikit-plugin';
+
+      transferCall({
+      phoneNumber: 102 // employee's internal number
+      })
+    ```
+
 
+  - __End a call__ : We will push a event `endCall` for you.
     ```javascript
     import {endCall} from 'omikit-plugin';
 
@@ -750,6 +759,7 @@ We need you request permission about call before make call:
   - Send character: We only support `1 to 9` and `* #`.
 
     ```javascript
+    // FUNC IS USED when the user wants key interaction during a call. For example, press key 1, 2, 3.. to move to group
     import {sendDTMF} from 'omikit-plugin';
 
     sendDTMF({
@@ -791,14 +801,14 @@ We need you request permission about call before make call:
         "uuid": "122aaa"
     }
     ```
-  - endCall: End a completed call (including rejecting a call).
+  - __endCall__: End a completed call (including rejecting a call).
 
     ```javascript
     import {endCall} from 'omikit-plugin';
 
     endCall();
     ```
-  - rejectCall: Used to reject an incoming call when the user has not accepted it yet.
+  - __rejectCall__: Used to reject an incoming call when the user has not accepted it yet.
     Note: Do not use this function to end an ongoing call.
 
     ```javascript
@@ -806,7 +816,7 @@ We need you request permission about call before make call:
 
     rejectCall();
     ```
-  - Logout: logout and remove all information.
+  - __Logout__: logout and remove all information.
 
     ```javascript
     import {logout} from 'omikit-plugin';
@@ -814,7 +824,7 @@ We need you request permission about call before make call:
     logout();
     ```
 
-  - Permission: Check system alert window permission (only Android).
+  - __Permission__: Check system alert window permission (only Android).
 
     ```javascript
     import {systemAlertWindow} from 'omikit-plugin';
@@ -826,7 +836,7 @@ We need you request permission about call before make call:
     }
     ```
 
-  - Setting: Open to enable system alert window (only Android).
+  - __Setting__: Open to enable system alert window (only Android).
 
     ```javascript
     import {openSystemAlertSetting} from 'omikit-plugin';
@@ -835,16 +845,31 @@ We need you request permission about call before make call:
       openSystemAlertSetting();
     }
     ```
-  - Audio: 
-    - func *getCurrentAudio*: lấy thông tin hiện tại của audio devices
-     ```javascript
+  - __Audio__: 
+    - func *getCurrentAudio*: Get current information of audio devices
+    ```javascript
     import {getCurrentAudio} from 'omikit-plugin';
 
     getCurrentAudio().then((data: any) => {
       console.log(data); // [{"name": "Speaker", "type": "Speaker"}]
-          // Ghi chú: Data là một mảng chứa thông tin của các thiết bị âm thanh, với các tham số:
-          // - name: Tên của thiết bị âm thanh
-          // - type: Loại thiết bị âm thanh (ví dụ: "Speaker", "Microphone", v.v.)
+          // Note: Data is an array containing information about audio devices, with parameters:
+          // - name: Name of the audio device
+          // - type: Audio device type (e.g. "Speaker", "Receiver", etc.)
+    });
+    ```
+    - func setAudio: set Audio calls the current device
+     ```javascript
+    import {  getAudio, setAudio} from 'omikit-plugin';
+
+    const audioList = await getAudio(); // Get a list of supported audio device types 
+    console.log("audioList --> ", audioList) // audioList -->  [{"name": "Receiver", "type": "Receiver"}, {"name": "Speaker", "type": "Speaker"}]
+    
+    const receiver = audioList.find((element: any) => {
+          return element.type === 'Receiver'; // type: "Speaker" is the external speaker, Receiver is the internal speaker
+    });
+    
+    setAudio({
+      portType: receiver.type,
     });
     ```
 
@@ -899,7 +924,7 @@ We need you request permission about call before make call:
   registerVideoEvent();
   ```
 
-- Event listener:
+- *Event listener*:
 
 ```javascript
 useEffect(() => {
@@ -959,21 +984,75 @@ useEffect(() => {
       - hold(7);
 
   * onCallStateChanged is call state tracking event. We will return status of state. Please refer `OmiCallState`.
-    `onCallStateChanged value:` + isVideo: value boolean (true is call Video) + status: number (value matching with List status call ) + callerNumber: phone number + incoming: boolean - status call incoming or outgoing + \_id: option (id of every call) + code_end_call: This is code when end call.
+  
+```javascript
+// The event is updated every time the call status changes
+const onCallStateChanged = (data: any) => {
+  /*
+    Call state change event data (Object) includes:
+    
+    - _id: string (UUID of the call)
+    - callInfo: object (Detailed call information)
+    - callerNumber: string (Phone number of the caller)
+    - code_end_call: number (Status code when the call ends)
+    - destination_number?: string (Destination phone number, optional)
+    - direction: string ("inbound" or "outbound", call direction)
+    - disposition: string (Call answer status)
+    - incoming: boolean (true if it is an incoming call)
+    - isVideo: boolean (true if it is a video call)
+    - sip_user: string (Current SIP user)
+    - source_number: string (SIP number of the user)
+    - status: string (value matching with List status call)
+    - time_end: number (Timestamp when the call ended)
+    - time_start_to_answer: number (Time taken to answer the call)
+    - transaction_id: string (OMI Call unique ID)
+  */
+};
+
+// Event returned when the user mutes the call
+const onMuted = (isMuted: boolean) => {
+// isMuted: true when muted call 
+}
+
+// Event returns value when user holds call
+const onHold = (isHold: boolean) => {
+// isHold: true when hold call 
+}
+
+//  The event updates the quality of an ongoing call
+const onCallQuality = (data: any) => {
+    const { quality } = data;
+    // quality: int is mean quality off calling 
+    // 1 is good, 2 is medium, 3 is low 
+}
+
+// Even when user turn on speakerphone  
+const onSpeaker = (isSpeaker: boolean) => {
+  // isSpeaker: true, false  
+  // True mean speaker devices is open 
+}
+
+// * onSwitchboardAnswer have callback when employee answered script call.
+const onSwitchboardAnswer = (data: any) => {
+  const { sip } = data
+  // sip: String 
+}
+```
 
-  * `Incoming call` state lifecycle: incoming -> connecting -> confirmed -> disconnected
-  * `Outgoing call` state lifecycle: calling -> early -> connecting -> confirmed -> disconnected
+### 📞 Call State Lifecycle
+* **`Incoming call` state lifecycle**: incoming -> connecting -> confirmed -> disconnected
+* **`Outgoing call` state lifecycle**: calling -> early -> connecting -> confirmed -> disconnected
 
-  * onSwitchboardAnswer have callback when employee answered script call.
 
 - Table describing code_end_call status
 
 | Code            | Description                                                                                                           |
 | --------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `600, 503, 480`  | These are the codes of the network operator or the user who did not answer the call  |
+| `600, 503`  | These are the codes of the network operator or the user who did not answer the call  |
 | `408`   | Call request timeout (Each call usually has a waiting time of 30 seconds. If the 30 seconds expire, it will time out) |
 | `403`           | Your service plan only allows calls to dialed numbers. Please upgrade your service pack|
 | `404`           | The current number is not allowed to make calls to the carrier|
+| `480`           | The number has an error, please contact support to check the details |
 | `603`           | The call was rejected. Please check your account limit or call barring configuration! |
 | `850`           | Simultaneous call limit exceeded, please try again later |
 | `486`           | The listener refuses the call and does not answer |
@@ -1007,12 +1086,6 @@ useEffect(() => {
   - `OmiCallEvent.onHold`: hold current call 
 - Data value: We return `callerNumber`, `sip`, `isVideo: true/false` information
 
-- Forward calls to internal staff:
-  - You can use function `transferCall` for transfer to staff you want.
-    example:
-    transferCall({
-    phoneNumber: 102
-    })
 
 # Issues
 

package/android/build.gradle

@@ -120,7 +120,7 @@ dependencies {
   // use for OMISDK
   implementation("androidx.work:work-runtime:2.8.1")
   implementation "androidx.security:security-crypto:1.1.0-alpha06"
-  api 'vn.vihat.omicall:omi-sdk:2.3.16'
+  api 'vn.vihat.omicall:omi-sdk:2.3.17'
 
   implementation "com.facebook.react:react-native:+" // From node_modules
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"

package/android/gradle.properties

@@ -4,4 +4,4 @@ OmikitPlugin_targetSdkVersion=33
 OmikitPlugin_compileSdkVersion=33
 OmikitPlugin_ndkversion=21.4.7075529
 OMI_USER=omicall
-OMI_TOKEN=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
+OMI_TOKEN=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

package/ios/CallProcess/CallManager.swift

@@ -335,7 +335,7 @@ class CallManager {
       if (videoManager == nil && call.isVideo) {
         videoManager = OMIVideoViewManager.init()
       }
-      isSpeaker = call.isVideo
+      isSpeaker = call.speaker
       lastStatusCall = "answered"
       OmikitPlugin.instance.sendMuteStatus()
       break
@@ -517,7 +517,7 @@ class CallManager {
   func getCurrentAudio() -> [[String: String]] {
     return OmiClient.getCurrentAudio()
   }
-  
+
   //video call
   func toggleCamera() {
     if let videoManager = videoManager {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "omikit-plugin",
-  "version": "3.2.65",
+  "version": "3.2.66",
   "description": "Omikit Plugin by ViHAT",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",