Rate this page:


This article will help you to start building your iOS application with Voximplant.

There are two ways to add Voximplant libraries to your Xcode project: Cocoapods and Swift Package Manager.

Start with Cocoapods

Copy URL

Skip this section if you are using Swift Package Manager.

See Available Roles
  1. Install CocoaPods (See CocoaPods getting started guide)
  2. If you do not have a podfile, create it by running pod init in the project directory
  3. Add VoxImplantSDK dependency in the Podfile:
platform: ios, '11.0'

target 'MyApp' do
    // other dependencies and configurations
    pod 'VoxImplantSDK'
  1. Run the pod install command in the project directory to install the SDK
  2. From now on, open your project via the newly created .xcworkspace file
Bitcode support

We discontinued bitcode support since the 2.48.0 SDK version.

See Available Roles

Start with Swift Package Manager

Copy URL

Skip this section if you are using CocoaPods.

See Available Roles

Alternatively, you can use Swift Package Manager to add the dependencies to your project.

  1. Open your project in Xcode
  2. Go File → Swift Packages → Add Package Dependency
  3. Add the iOS SDK github repository contents.
  4. Select the SDK version
  5. Declare the package in the Package.swift file's dependencies section:
dependencies: [
    .package(url: "https://github.com/voximplant/ios-sdk-releases.git", .upToNextMinor(from: "2.51.0"))

The Voximplant Swift Package does not fully meet the semantic versioning, so backwards compability is not guaranteed. Please check the changelog before a version update.

See Available Roles

Initialize the SDK

Copy URL
  1. If you need to use camera and microphone in your app, open the Info.plist file in your project and add the following keys:
  • Privacy - Camera Usage Description

  • Privacy - Microphone Usage Description

Provide values to the added keys. The value is what a device shows when prompts for camera or microphone access.

  1. Declare four Background modes. Go to your project's main file, Singing & Capabilities tab, click the "+" button on the top and choose "Background modes". To enable calls and push notification functionality, choose the following modes as you see on the screenshot:
Background modes

Now you are ready to create a Voximplant client instance. To do so, import VoxImplantSDK to your swift class and create an instance of VIClient as shown below:

Create a client instance

Create a client instance

Connect to the Voximplant cloud and login

Copy URL

To create a client instance and to connect, import VoxImplantSDK to your swift class. Also, your class should support the VIClientSessionDelegate protocol.

On the class initialization, create a Voximplant client instance and declare your class as a session delegate for the client instance (see the code example below). Then call the connect method to connect to the cloud.

In the clientSessionDidConnect function, call the login(password) method to log in to the platform with password or the login(oneTimeKey) to log in with one time key.

Refer to this code example to understand the login process:

Connect and login

Connect and login

Start implementing functionality

Copy URL

Now you have your application and SDK set up and successfully connected to the Voximplant cloud. To start implementing desired functionality, such as calls, conferences, messages, and more, go to the Guides section of our documentation and pick the features you need.

iOS SDK demos

Copy URL

Implement the desired functionality by following step-by-step Guides or download and test our latest iOS SDK here:

  • Audio call: Demonstrates the basic voice call functionality of the Voximplant iOS SDK.

  • Audio call with CallKit: Demonstrates the CallKit integration with the basic voice call functionality of the Voximplant iOS SDK.

  • Video call: Demonstrates the basic video call functionality of the Voximplant iOS SDK.

  • Video call with CallKit: Demonstrates how to integrate CallKit with the basic video call functionality of the Voximplant iOS SDK.

  • Messaging: Demonstrates how to create your web and mobile messaging client based on the Voximplant SDKs.