Flutter Voip24h-SDK Mobile

Mục lục

• Tính năng
• Yêu cầu
• Cài đặt
• Khai báo module
• CallKit
• Push Notification
• Graph

Tính năng

Yêu cầu

• OS Platform:
  • Android -> minSdkVersion: 23
  • IOS -> iOS Deployment Target: 9.0
• Permissions: khai báo và cấp quyền lúc runtime

  • Android: Trong file AndroidManifest.xml

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
    

  • IOS: Trong file Info.plist

    <key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key><true/>
    </dict>
    <key>NSMicrophoneUsageDescription</key>
    <string>{Your permission microphone description}</string>
    

Cài đặt

Sử dụng terminal:

flutter pub add voip24h_sdk_mobile

Linking module:

• IOS:
  • Trong ios/Podfile:

    ...
    # Khai báo thư viện
    platform :ios, '9.0'
    source "https://gitlab.linphone.org/BC/public/podspec.git"
    
    target 'Your Project' do
        ...
        use_frameworks!
        use_modular_headers!
    
        flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
    
        # Khai báo thư viện 
        pod 'linphone-sdk-novideo' , '5.1.36'
    end
    

  • Trong folder ios mở terminal, nhập dòng lệnh:

    rm -rf Pods/
    pod install
    

Khai báo module

import 'package:voip24h_sdk_mobile/voip24h_sdk_mobile.dart';
import 'package:voip24h_sdk_mobile/callkit/utils/sip_event.dart';
import 'package:voip24h_sdk_mobile/callkit/utils/transport_type.dart';
import 'package:voip24h_sdk_mobile/graph/extensions/extensions.dart';
import 'package:voip24h_sdk_mobile/callkit/model/sip_configuration.dart';

// TODO: Using module

CallKit

• Khai báo sipConfiguration:

  var sipConfiguration = SipConfigurationBuilder(extension: "extension", domain: "domain", password: "password")
                          .setKeepAlive(true/false) // optional (bool)
                          .setPort(port) // optional (int)
                          .setTransport(TransportType.Udp/TransportType.Tcp/TransportType.Tls) // optional (enum)
                          .build(); 
  

• Event listener SIP:

  Voip24hSdkMobile.callModule.eventStreamController.stream.listen((event) {
      switch (event['event']) {
          case SipEvent.AccountRegistrationStateChanged: {
              var body = event['body'];
              // TODO
          } break;
          case SipEvent.Ring: {
              // TODO
          } break;
          case ...
            break;
      }
  });
  
  ...
  
  @override
  void dispose() {
      Voip24hSdkMobile.callModule.eventStreamController.close();
      super.dispose();
  }
  

Push Notification

• IOS: Chúng tôi sử dụng Apple Push Notification service (APNs) cho thông báo đẩy cuộc gọi đến khi app ở trạng thái background
  • Step 1: Tạo APNs Auth Key
    • Truy cập Apple Developer để tạo Certificates
      
    • Chọn chứng nhận VoIP Services Certificate
    • Chọn ID ứng dụng của bạn. Mỗi ứng dụng bạn muốn sử dụng với dịch vụ VoIP đều yêu cầu chứng chỉ dịch vụ VoIP riêng. Chứng chỉ dịch vụ VoIP dành riêng cho ID ứng dụng cho phép máy chủ thông báo (Voip24h) kết nối với dịch vụ VoIP để gửi thông báo đẩy về ứng dụng của bạn.
      
    • Download file chứng chỉ và mở bằng Keychain Access
      
    • Export chứng chỉ sang định dạng .p12
      
    • Convert file chứng chỉ .p12 sang định dạng .pem và submit cho Voip24h cấu hình

      openssl pkcs12 -in path_your_certificate.p12 -out path_your_certificate.pem -nodes
      

• Step 2: Cấu hình project app của bạn để nhận thông báo đẩy cuộc gọi đến -> Từ IOS 10 trở lên, sử dụng CallKit + PushKit

  • Callkit cho phép hiển thị giao diện cuộc gọi hệ thống cho các dịch vụ VoIP trong ứng dụng của bạn và điều phối dịch vụ gọi điện của bạn với các ứng dụng và hệ thống khác.
  • PushKit hỗ trợ các thông báo chuyên biệt để nhận các cuộc gọi Thoại qua IP (VoIP) đến.

  • Để sử dụng CallKit Framework + PushKit FrameWork, chúng tôi khuyến khích sử dụng thư viện callkeep, trong pubspec.yaml:

  dependencies:
      ....
      callkeep:
      git:
        url: https://github.com/Voip24h-Corp/callkeep
        ref: master
  

  Chạy lệnh:

  flutter pub get
  cd ios
  pod install
  

  • Tại project của bạn thêm Push Notifications và tích chọn Voice over IP, Background fetch, Remote notifications, Background processing (Background Modes) trong Capabilities.
  • Khi khởi động ứng dụng callkeep sẽ tạo mã thông báo đăng kí cho ứng dụng khách. Sử dụng mã này để đăng kí lên server Voip24h

  import 'package:callkeep/callkeep.dart';
  ...
  callKeep.on<CallKeepPushKitToken>((value) => {
    tokenPushIOS = value.token ?? ""
  });
  callKeep.setup(context, <String, dynamic>{
    'ios': {
      'appName': 'Example',
    }
  });
  
  // tokenGraph: access token được generate từ API Graph
  // token: token device pushkit
  // sipConfiguration: thông số sip khi đăng kí máy nhánh
  // isIOS: mặc định là false
  // appId: bundle id của app ios
  // isProduction: true(production) / false(dev)
  // deviceMac: device mac của thiết bị
  
  Voip24hSdkMobile.pushNotificationModule.registerPushNotification(
        tokenGraph: tokenGraph,
        token: tokenPushIOS,
        sipConfiguration: sipConfiguration,
        isIOS: true,
        appId: packageInfo.packageName,
        isProduction: false,
        deviceMac: iosDeviceInfo.identifierForVendor
    ).then((value) => {
      print(value)
    }, onError: (error) => {
      print(error)
    });
  

  Phải cấp quyền thông báo trên ios trước khi sử dụng tính năng Push Notification

  • Đăng kí nhận thông báo đẩy từ Voip24h Server

  • Important Note: Sau khi nhận thông báo đẩy từ Voip24h Server, như đã đề cập cơ chế Callkit, PushKit ở trên thì phải hiển thị màn hình cuộc gọi của hệ thống (cuộc gọi giả) trước, thực thi Login lại máy nhánh ngay sau đó để nhận tín hiệu cuộc gọi thật từ Voip24h thông qua bản tin event Ring, lúc này mọi action call như answer/reject mới hoạt động.

  callKeep.on<CallKeepReceivedPushNotification>((value) => {
    callId = value.callId ?? "",
    testCallKit()
  });
  callKeep.on<CallKeepPerformAnswerCallAction>((value) => {
    answer()
  });
  callKeep.on<CallKeepPerformEndCallAction>((value) => {
    reject()
  });
  

  • Để huỷ đăng kí nhận Push Notification

  Voip24hSdkMobile.pushNotificationModule.unregisterPushNotification(
      sipConfiguration: sipConfiguration,
      isIOS: true,
      appId: packageInfo.packageName
  ).then((value) => {
    print(value)
  }, onError: (error) => {
    print(error)
  });
  

• Android: Chúng tôi sử dụng Firebase Cloud Messaging (FCM) cho thông báo đẩy cuộc gọi đến khi app ở trạng thái background
  • Step 1: Tạo API Token
    • Tạo dự án trong bảng điều khiển Firebase
      
    • Đăng kí app Android
      
      • Download file google-services.json và thêm Firebase SDK vào project app của bạn
        
    • Trong Project settings Firebase, tạo token Cloud Messaging API (Legacy) và submit token này cho Voip24h cấu hình
      
  • Step 2: Cấu hình project app của bạn để nhận thông báo đẩy cuộc gọi đến -> chúng tôi khuyến khích bạn sử dụng thư viện Firebase Messaging
    • Flutter packages:

    flutter pub add firebase_core
    flutter pub add firebase_messaging
    

    Theo dõi docs Firebase Messaging để cấu hình project app của bạn

    • Khi khởi động ứng dụng Firebase Messaging sẽ tạo mã thông báo đăng kí cho ứng dụng khách. Sử dụng mã này để đăng kí lên server Voip24h

      String? token = await messaging.getToken();
        ....
      if(token != null) {
          // tokenGraph: access token được generate từ API Graph
      // token: token device push firebase
      // sipConfiguration: thông số sip khi đăng kí máy nhánh
      // isAndroid: mặc định là false
      // appId: package id của app android
      // isProduction: true(production) / false(dev)
      // deviceMac: device mac của thiết bị
         
      Voip24hSdkMobile.pushNotificationModule.registerPushNotification(
      tokenGraph: tokenGraph,
      token: token,
      sipConfiguration: sipConfiguration,
      isAndroid: true,
      appId: packageInfo.packageName,
      isProduction: false,
      deviceMac: androidDeviceInfo.androidId
      ).then((value) => {
        print(value)
      }, onError: (error) => {
        print(error)
      });
      }	
      

      • Phiên bản từ Android 13 (SDK 32) trở đi sẽ yêu cầu quyền thông báo để nhận Push Notification https://developer.android.com/develop/ui/views/notifications/notification-permission. Vui lòng cấp quyền runtime POST_NOTIFICATIONS trước khi sử dụng
        • Cấu hình nhận thông báo đẩy. Khi nhận thông báo đẩy, vui lòng đăng kí lại máy nhánh để nhận tín hiệu cuộc gọi đến

          @pragma('vm:entry-point')
          Future<void> _firebaseMessagingBackgroundHandler(RemoteMessage message) async {
          if(Platform.isAndroid) {
          print("Handling a background message: ${message.data}");
          await Firebase.initializeApp().whenComplete(() => {
            localNotificationService.initialNotification().then((value) => {
          // register sip account here
            })
          });
          }
          }
          

        • Huỷ đăng kí nhận Push Notification

        Voip24hSdkMobile.pushNotificationModule.unregisterPushNotification(
            sipConfiguration: sipConfiguration,
            isAndroid: true,
            appId: packageInfo.packageName
        ).then((value) => {
          print(value)
        }, onError: (error) => {
          print(error)
        });
        

Graph

• key và security certificate(secert) do Voip24h cung cấp
• request api: phương thức, endpoint. data body tham khảo từ docs https://docs-sdk.voip24h.vn/