v1

Quickstart

Channelize.io iOS Call SDK along with API SDK and UI SDK helps you achieve the complete calling and real-time messaging solution.

NOTE: Channelize.io iOS Call SDK is using Channelize.io API SDK for networking and real-time events.

Install iOS Call SDK

Step 1: Pods Installation

  • Developers having Xcode 11 should use ChannelizeCall Cocoapods with the version starting from 4.11.0.
pod 'ChannelizeCall', '~> 4.11.0'
  • Developers having Xcode 10 should use ChannelizeCall Cocoapods with the version starting from 4.10.0.
pod 'ChannelizeCall', '~> 4.10.0'

Now proceed with installation after setting up pods in your project.

pod install

Step 2: Create .plist file

Get you AGORA API Key by following steps mentioned here and add it to your Channelize-Info.plist file.

<key>AGORA_API_KEY</key>
<string>YOUR_AGORA_KEY</string>

Step 3: Use SDK Methods

Now use all classes and methods with the import statement.

import Channelize_Voice_Video

Integrate Call SDK using API & UI SDKs

If you are using both Channelize.io iOS API and UI SDK, then you just need to enable the call feature in UI SDK by adding below lines of code in the customizations.

CHCustomOptions.enableVoiceVideo = true    // Set it true, if you want to enable call functionality otherwise set it to false.

Integrate Call SDK using API SDK

If you are not using Channelize.io UI SDK, follow the below process to make an outgoing call and handle an incoming call.

Make an Outgoing Call

Make an outgoing call following the below steps.

Step 1: Create a Call Object.

Create a call object by calling getCallObject function of iOS Call SDK.

NameTypeRequiredDescription
userCHUseryesCHUser object of the call receiver.
typeCallScreenyesThe type of call you want to make. Possible values are .voice or .video.
 
let userObject : CHUser = currentConversationUser
let callType : CallScreen = .video
let callObject = ChVoiceVideo.getCallObject(user: userObject, type: callType)

Step 2: Make a Call

Call the below method to start an outgoing call.

ChVoiceVideo.launchCallViewController(navigationController: UINAVIGATIONCONTROLLER,activeCall:callObject)

Receive an Incoming Call

Receive an incoming call following the below steps.

Step 1: In background modes enable Voice over IP and Background fetch.

Step 2. Upload VoIP certificate .pem file and VoIP key .pem file on Channelize.io Dashboard (App Settings > Push Notifications).

Step 3. Import Pushkit framework in AppDelegate.swift file.

Step 4: Create a variable for push registry

let pushRegistry = PKPushRegistry(queue: DispatchQueue.main)

Step 5: In didFinishLaunchingWithOptions method paste following code

pushRegistry.delegate = self
pushRegistry.desiredPushTypes = [.voIP]

Step 6: Confirm AppDelegate class to PKPushRegistryDelegate protocols and paste following code:

func pushRegistry(_ registry: PKPushRegistry, didUpdate pushCredentials: PKPushCredentials, for type: PKPushType) {
    let deviceToken = pushCredentials.token.reduce("", {$0 + String(format: "%02X", $1) })
    debugPrint("Token recieved - ",deviceToken)
    Channelize.updateVoipToken(token: deviceToken)
}

func pushRegistry(_ registry: PKPushRegistry, didReceiveIncomingPushWith payload: PKPushPayload, for type: PKPushType) {
    
    if let callTopic = payload.dictionaryPayload["topic"] as? String{
        if (payload.dictionaryPayload["userId"] as? String) != nil{
            if callTopic.contains("/reject"){
                ChVoiceVideo.performOutGoingCallRejected(callTopic: callTopic)
                return
            } else if callTopic.contains("/end"){
                ChVoiceVideo.performOnGoingCallEnded(callTopic:callTopic)
                return
            } else if callTopic.contains("/received"){
                ChVoiceVideo.postCallRecievedNotification(callTopic:callTopic)
                return
            } else if callTopic.contains("/accept"){
                ChVoiceVideo.postCallAcceptedNotification(callTopic:callTopic)
                return
            }
        }
    }

    if let callId = payload.dictionaryPayload["callId"] as? String{
        if let uid = payload.dictionaryPayload["userId"] as? String{
            if let uuidString = payload.dictionaryPayload["uuid"] as? String{
                if let uuid = UUID(uuidString: uuidString){
                    let call = CHActiveCall(uuid: uuid, callId: callId, uid: uid, isOutgoing: false)
                    call.displayName = payload.dictionaryPayload["displayName"] as? String
                    call.profileImageUrl = payload.dictionaryPayload["profileImageUrl"] as? String
                    if let callType = payload.dictionaryPayload["type"] as? String{
                        if callType == "video"{
                            call.type = .video
                        }
                    }
                    let backgroundTaskIdentifier = UIApplication.shared.beginBackgroundTask(expirationHandler: nil)
                    if CHCustomOptions.enableCallModule{
                        ChVoiceVideo.showIncomingCall(call: call, completion: {_ in
                                UIApplication.shared.endBackgroundTask(backgroundTaskIdentifier)
                        })
                    }
                }
            }
        }
    }
}

func pushRegistry(_ registry: PKPushRegistry, didInvalidatePushTokenFor type: PKPushType) {
    print("\(#function) token invalidated")
}

Configuring Channelize.io Call SDK

To configure iOS Call SDK you need to add the following code in didFinishLaunchingWithOptions function of your project's AppDelegate.swift file.

    CHVoiceVideo.configureVoiceVideo()
← UI Customizations