voice-quickstart-ios: An Objective-C repository from Twilio

Twilio Voice Quickstart for iOS

Please see our iOS 13 Migration Guide for the latest information on iOS 13.

Get started with Voice on iOS

Quickstart - Run the swift quickstart app
Examples - Sample applications

References

Access Tokens - Using access tokens
Managing Audio Interruptions - Managing audio interruptions
Managing Push Credentials - Managing push credentials
Managing Regional Push Credentials using Conversations Credential Resource API - Create or update push credentials for regional usage
More Documentation - More documentation related to the Voice iOS SDK
Issues and Support - Filing issues and general support

Voice iOS SDK Versions

Migration Guide from 5.x to 6.x - Migrating from 5.x to 6.x
Migration Guide from 4.x to 5.x - Migrating from 4.x to 5.x
4.0 New Features - New features in 4.0
Migration Guide from 3.x to 4.x - Migrating from 3.x to 4.x
3.0 New Features - New features in 3.0
Migration Guide from 2.x to 3.x - Migrating from 2.x to 3.x

Quickstart

To get started with the quickstart application follow these steps. Steps 1-5 will enable the application to make a call. The remaining steps 6-9 will enable the application to receive incoming calls in the form of push notifications using Apple’s VoIP Service.

Install the TwilioVoice framework
Use Twilio CLI to deploy access token and TwiML application to Twilio Serverless
Create a TwiML application for the access token
Generate an access token for the quickstart
Run the Swift Quickstart app
Create a Push Credential with your VoIP Service Certificate
Receive an incoming call
Make client to client call
Make client to PSTN call

1. Install the TwilioVoice framework

Swift Package Manager

Twilio Voice is now distributed via Swift Package Manager. To consume Twilio Voice using Swift Package Manager, add the https://github.com/twilio/twilio-voice-ios repository as a Swift Pacakge.

2. Use Twilio CLI to deploy access token and TwiML application to Twilio Serverless

You must have the following installed:

Node.js v10+
NPM v6+ (comes installed with newer Node versions)

Run npm install to install all dependencies from NPM.

Install twilio-cli with:

$ npm install -g twilio-cli

Login to the Twilio CLI. You will be prompted for your Account SID and Auth Token, both of which you can find on the dashboard of your Twilio console.

$ twilio login

Once successfully logged in, an API Key, a secret get created and stored in your keychain as the twilio-cli password in SKxxxx|secret format. Please make a note of these values to use them in the Server/.env file.

This app requires the Serverless plug-in. Install the CLI plugin with:

$ twilio plugins:install @twilio-labs/plugin-serverless

Before deploying, create a Server/.env by copying from Server/.env.example

$ cp Server/.env.example Server/.env

Update Server/.env with your Account SID, auth token, API Key and secret

ACCOUNT_SID=ACxxxx
AUTH_TOKEN=xxxxxx
API_KEY_SID=SKxxxx
API_SECRET=xxxxxx
APP_SID=APxxxx (available in step 3)
PUSH_CREDENTIAL_SID=CRxxxx (available in step 6)

The Server folder contains a basic server component which can be used to vend access tokens or generate TwiML response for making call to a number or another client. The app is deployed to Twilio Serverless with the serverless plug-in:

$ cd Server
$ twilio serverless:deploy

The server component that's baked into this quickstart is in Node.js. If you’d like to roll your own or better understand the Twilio Voice server side implementations, please see the list of starter projects in the following supported languages below:

Follow the instructions in the project's README to get the application server up and running locally and accessible via the public Internet.

3. Create a TwiML application for the Access Token

Next, we need to create a TwiML application. A TwiML application identifies a public URL for retrieving TwiML call control instructions. When your iOS app makes a call to the Twilio cloud, Twilio will make a webhook request to this URL, your application server will respond with generated TwiML, and Twilio will execute the instructions you’ve provided.

Use Twilio CLI to create a TwiML app with the make-call endpoint you have just deployed (Note: replace the value of --voice-url parameter with your make-call endpoint you just deployed to Twilio Serverless)

$ twilio api:core:applications:create \
    --friendly-name=my-twiml-app \
    --voice-method=POST \
    --voice-url="https://my-quickstart-dev.twil.io/make-call"

You should receive an Appliciation SID that looks like this

APxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

4. Generate an access token for the quickstart

Install the token plug-in

$ twilio plugins:install @twilio-labs/plugin-token

Use the TwiML App SID you just created to generate an access token

$ twilio token:voice --identity=alice --voice-app-sid=APxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Copy the access token string. Your iOS app will use this token to connect to Twilio.

5. Run the Swift Quickstart app

Now let’s go back to the VoiceQuickstart.xcworkspace. Update the placeholder of accessToken with access token string you just copied

import UIKit
import AVFoundation
import PushKit
import CallKit
import TwilioVoice

let accessToken = "PASTE_YOUR_ACCESS_TOKEN_HERE"
let twimlParamTo = "to"

let kCachedDeviceToken = "CachedDeviceToken"

class ViewController: UIViewController {
    ...
}

Build and run the app. Leave the text field empty and press the call button to start a call. You will hear the congratulatory message. Support for dialing another client or number is described in steps 8 and 9. Tap "Hang Up" to disconnect.

6. Create a Push Credential with your VoIP Service Certificate

The Programmable Voice SDK uses Apple’s VoIP Services to let your application know when it is receiving an incoming call. If you want your users to receive incoming calls, you’ll need to enable VoIP Services in your application and generate a VoIP Services Certificate.

Go to Apple Developer portal and generate a VoIP Service Certificate.

Once you have generated the VoIP Services Certificate, you will need to provide the certificate and key to Twilio so that Twilio can send push notifications to your app on your behalf.

Export your VoIP Service Certificate as a .p12 file from Keychain Access and extract the certificate and private key from the .p12 file using the openssl command.

$ openssl pkcs12 -in PATH_TO_YOUR_P12 -nokeys -out cert.pem -nodes
$ openssl x509 -in cert.pem -out cert.pem
$ openssl pkcs12 -in PATH_TO_YOUR_P12 -nocerts -out key.pem -nodes
$ openssl rsa -in key.pem -out key.pem

Note: if you run into the unsupported encryption algorithm (RC2-40-CBC) issue like below, try adding -legacy to the openssl pkcs12 command.

Error outputting keys and certificates
C0EF094DF87F0000:error:0308010C:digital envelope routines:inner_evp_generic_fetch:unsupported:crypto/evp/evp_fetch.c:355:Global default library context, Algorithm (RC2-40-CBC : 0), Properties ()

Use Twilio CLI to create a Push Credential using the cert and key.

$ twilio api:chat:v2:credentials:create \
    --type=apn \
    --sandbox \
    --friendly-name="voice-push-credential (sandbox)" \
    --certificate="$(cat PATH_TO_CERT_PEM)" \
    --private-key="$(cat PATH_TO_KEY_PEM)"

This will return a Push Credential SID that looks like this

CRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

The --sandbox option tells Twilio to send the notification requests to the sandbox endpoint of Apple's APNS service. Once the app is ready for distribution or store submission, create a separate Push Credential with a new VoIP Service certificate without the --sandbox option.

Note: we strongly recommend using different Twilio accounts (or subaccounts) to separate VoIP push notification requests for development and production apps.

Now let's generate another access token and add the Push Credential to the Voice Grant.

$ twilio token:voice \
    --identity=alice \
    --voice-app-sid=APxxxx \
    --push-credential-sid=CRxxxxs

7. Receive an incoming call

You are now ready to receive incoming calls. Update your app with the access token generated from step 6 and rebuild your app. The TwilioVoiceSDK.register() method will register your mobile client with the PushKit device token as well as the access token. Once registered, hit your application server's /place-call endpoint: https://my-quickstart-dev.twil.io/place-call?to=alice. This will trigger a Twilio REST API request that will make an inbound call to the identity registered on your mobile app. Once your app accepts the call, you should hear a congratulatory message.

    TwilioVoiceSDK.register(accessToken: accessToken, deviceToken: cachedDeviceToken) { error in
        if let error = error {
            NSLog("An error occurred while registering: \(error.localizedDescription)")
        } else {
            NSLog("Successfully registered for VoIP push notifications.")                
        }
    }

Please note that your application must have voip enabled in the UIBackgroundModes of your app's plist in order to be able to receive push notifications.

8. Make client to client call

To make client to client calls, you need the application running on two devices. To run the application on an additional device, make sure you use a different identity in your access token when registering the new device.

Use the text field to specify the identity of the call receiver, then tap the "Call" button to make a call. The TwiML parameters used in TwilioVoice.connect() method should match the name used in the server.

9. Make client to PSTN call

To make client to number calls, first get a verified Twilio number to your account via https://www.twilio.com/console/phone-numbers/verified. Update your server code and replace the callerNumber variable with the verified number. Restart the server so it uses the new value.

Examples

You will also find additional examples that provide more advanced use cases of the Voice SDK:

AudioDevice - Provide your own means to playback and record audio using a custom TVOAudioDevice and CoreAudio.
Making calls from history - Use the INStartAudioCallIntent in the user activity delegate method to start a call from the history.

Twilio Helper Libraries

To learn more about how to use TwiML and the Programmable Voice Calls API, check out our TwiML quickstarts:

Issues and Support

Please file any issues you find here on Github: Voice Swift Quickstart. Please ensure that you are not sharing any Personally Identifiable Information(PII) or sensitive account information (API keys, credentials, etc.) when reporting an issue.

For general inquiries related to the Voice SDK you can file a support ticket.

License

MIT

twilio/voice-quickstart-ios