Popin iOS SDK v2 – Integration Documentation

PopinCall is an iOS library that enables seamless integration of video calling functionality into your iOS applications. It provides an easy-to-use interface for connecting users with experts or support agents with robust real-time communication.

---

Requirements

• iOS 15.0+

• Swift 5.0+

• Xcode 14.0+

---

Installation

Swift Package Manager

Add PopinCall as a dependency in your Package.swift:

dependencies: [
    .package(url: "https://github.com/AshwinDotMe/Popin-Library-iOS.git", from: "1.0.0")
]

Or in Xcode:

1. Go to File > Add Package Dependencies...

2. Enter the package URL: https://github.com/AshwinDotMe/Popin-Library-iOS.git

3. Select the version you want to use.

---

Permissions

Add the following to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>This app needs access to camera for video calls</string>
<key>NSMicrophoneUsageDescription</key>
<string>This app needs access to microphone for video calls</string>

Background Modes

Enable these Background Modes in your app's Signing & Capabilities:

• Audio, AirPlay, and Picture in Picture – For audio/video streaming during calls

• Voice over IP – For VoIP call handling

• Background fetch – For downloading content from the network

Or add directly to your Info.plist:

<key>UIBackgroundModes</key>
<array>
    <string>audio</string>
    <string>voip</string>
    <string>fetch</string>
</array>

---

Quick Start

1. Import the Library

import PopinCall

2. Initialize with Configuration

let product = PopinProduct(
    id: "SKU-12345",
    name: "Wireless Headphones",
    image: "https://example.com/product.jpg",
    url: "https://example.com/products/headphones",
    description: "Noise-cancelling wireless headphones",
    extra: "$299.99"
)

let metadata: [String: String] = [
    "source": "ios_app",
    "version": "1.0.0",
    "campaign": "summer_sale"
]

let config = PopinConfig.Builder()
    .userName("Demo User")
    .contactInfo("[e-mail]")
    .callerId("user-12345")
    .sandboxMode(true)
    .product(product)
    .meta(metadata)
    .secondaryProductText("Car details")
    .expertDesignation("Car Expert")
    .initListener(self)
    .eventsListener(self)
    .hideDisconnectButton(false)
    .hideScreenShareButton(false)
    .hideFlipCameraButton(false)
    .hideMuteVideoButton(false)
    .hideMuteAudioButton(false)
    .hideBackButton(false)
    .persistenceMode(true)
    .build()

Popin.initialize(token: YOUR_SELLER_TOKEN, config: config)

3. Start a Call

Popin.shared?.startCall()

4. Implement Listeners

extension ViewController: PopinInitListener {
    func onInitComplete(userId: Int) {
        print("Popin initialized, userId: \(userId)")
    }

    func onInitFailed(reason: String) {
        print("Popin init failed: \(reason)")
    }
}

extension ViewController: PopinEventsListener {
    func onPermissionGiven() { print("Permission given") }
    func onPermissionDenied() { print("Permission denied") }
    func onCallStart() { print("Call started") }
    func onCallAbandoned() { print("Call abandoned") }
    func onQueuePositionChanged(position: Int) { print("Queue position: \(position)") }
    func onCallMissed() { print("Call missed") }
    func onCallNetworkFailure(participant: String) { print("Network failure — participant: \(participant)") }
    func onCallConnected() { print("Call connected") }
    func onCallFailed() { print("Call failed") }
    func onCallEnd() { print("Call ended") }
}

---

Runtime Configuration Updates

You can update meta, callerId, and product before starting a call, without reinitializing the SDK:

let config = Popin.shared?.getConfig()
config?.product = PopinProduct(
    id: "NEW-SKU",
    name: "New Product",
    image: "https://example.com/new.jpg",
    url: "https://example.com/new",
    description: "Updated product",
    extra: "$199.99"
)
config?.callerId = "new_caller_id"
config?.meta = ["source": "ios_app", "campaign": "winter_sale"]

Popin.shared?.startCall()

---

Incoming Calls via PushKit

The SDK handles PushKit internally; you do not need to implement PKPushRegistryDelegate.

Step 1: Enable Incoming Calls

let config = PopinConfig.Builder()
    .enableIncomingCalls(true)
    .build()

Step 2: Initialize Popin in AppDelegate

import UIKit
import PopinCall

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        let config = PopinConfig.Builder()
            .userName("Demo User")
            .contactInfo("[e-mail]")
            .enableIncomingCalls(true)
            .eventsListener(self)
            .build()

        Popin.initialize(token: YOUR_SELLER_TOKEN, config: config)
        return true
    }
}

Step 3: Register for VoIP Pushes Early

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    Popin.registerForVoIPPushes()

    let config = PopinConfig.Builder()
        .build()
    Popin.initialize(token: YOUR_SELLER_TOKEN, config: config)
    return true
}

Important: On iOS, PushKit requires reporting a CallKit call for every VoIP push. The SDK handles this automatically.

---

API Reference

Popin

• Popin.initialize(token: String, config: PopinConfig) – Initialize the SDK

• Popin.shared?.startCall() – Start a call

• Popin.shared?.cancelCall() – Cancel waiting for call acceptance

• Popin.shared?.setGroup(identifier:onSuccess:onFailure:) – Set user group

• Popin.shared?.getConfig() – Access current configuration

• Popin.registerForVoIPPushes() – Register for PushKit

• Popin.deinitialize() – Logout user and deinitialize SDK

---

PopinProduct

PopinProduct(
    id: "SKU-123",
    name: "Product Name",
    image: "https://...",
    url: "https://...",
    description: "Description",
    extra: "$99.99"
)

---

Listeners

PopinInitListener

Method	Description
onInitComplete(userId:)	Initialization succeeded
onInitFailed(reason:)	Initialization failed

PopinEventsListener

Method	Description
onPermissionGiven()	Camera/mic permissions granted
onPermissionDenied()	Camera/mic permissions denied
onCallStart()	Call queued
onCallAbandoned()	Call abandoned during connecting screen
onQueuePositionChanged(position:)	Queue position changed
onCallMissed()	No agent answered
onCallNetworkFailure(participant:)	Network error occurred
onCallConnected()	Call active
onCallFailed()	Call failed
onCallEnd()	Call ended