13 |
14 | Please note, ExampleAVAudioEngineDevice requires iOS 11.0 or above.
15 |
16 | ### Setup
17 |
18 | See the master [README](https://github.com/twilio/voice-quickstart-ios/blob/master/README.md) for instructions on how to generate access tokens and make an outbound Call.
19 |
20 | This example requires Xcode 11.0 and the iOS 12.0 SDK, as well as a device running iOS 11.0 or above.
21 |
22 | ### Running
23 |
24 | Once you have configured your access token, build and run the example. Use the text field to make an outgoing call:
25 |
26 | 
27 |
28 | Once the Call is connected, tap the "Play Music" button and let ExampleAVAudioEngineDevice mix some tunes into your track.
29 |
30 | 
31 |
32 | ### Known Issues
33 |
34 | The AVAudioSession is configured and activated at device initialization time. Ideally, it would be better to activate the AVAudioSession only when audio playback or recording is needed.
--------------------------------------------------------------------------------
/Docs/verified-caller-number.md:
--------------------------------------------------------------------------------
1 | # Display verified caller number using TVOCallerInfo
2 |
3 | The [TVOCallerInfo](https://twilio.github.io/twilio-voice-ios/docs/latest/Classes/TVOCallerInfo.html) provides information about the caller. The `verified` property represents whether or not the caller's phone number has been verified by Twilio using **SHAKEN/STIR** validation.
4 |
5 | Use the information and display in the CallKit incoming call UI upon receiving the call invite
6 |
7 | ```.swift
8 | func callInviteReceived(_ callInvite: TVOCallInvite) {
9 | var callKitProviderName = "Voice Quickstart\n"
10 | let callerInfo: TVOCallerInfo = callInvite.callerInfo
11 | if let verified: NSNumber = callerInfo.verified {
12 | if verified.boolValue {
13 | callKitProviderName = "✅ Caller Verified\n"
14 | }
15 | }
16 |
17 | let configuration = CXProviderConfiguration(localizedName: callKitProviderName)
18 | configuration.maximumCallGroups = 1
19 | configuration.maximumCallsPerCallGroup = 1
20 |
21 | callKitProvider = CXProvider(configuration: configuration)
22 | callKitProvider.setDelegate(self, queue: nil)
23 |
24 | // Report to CallKit
25 | let callHandle = CXHandle(type: .generic, value: callInvite.from)
26 | let callUpdate = CXCallUpdate()
27 | callUpdate.remoteHandle = callHandle
28 |
29 | callKitProvider.reportNewIncomingCall(with: uuid, update: callUpdate) { error in
30 | if let error = error {
31 | NSLog("Failed to report incoming call successfully: \(error.localizedDescription).")
32 | } else {
33 | NSLog("Incoming call successfully reported.")
34 | }
35 | }
36 | }
37 | ```
38 |
39 | * Please note that the designated initializer `[CXProviderConfiguration initWithLocalizedName:]` has been deprecated on iOS 14.
40 |
41 | If the number of the caller is verified
42 |
43 | 
44 |
45 | If the number is not validated at **A** level or there is no verification information
46 |
47 | 
48 |
--------------------------------------------------------------------------------
/Docs/managing-push-credentials.md:
--------------------------------------------------------------------------------
1 | ## Managing Push Credentials
2 |
3 | A push credential is a record for a push notification channel, for iOS this push credential is a push notification channel record for APNS VoIP. Push credentials are managed in the console under [Mobile Push Credentials](https://www.twilio.com/console/voice/sdks/credentials).
4 |
5 | Whenever a registration is performed via `TwilioVoice.registerWithAccessToken:deviceTokenData:completion` in the iOS SDK the `identity` and the `Push Credential SID` provided in the JWT based access token, along with the `device token` are used as a unique address to send APNS VoIP push notifications to this application instance whenever a call is made to reach that `identity`. Using `TwilioVoice.unregisterWithAccessToken:deviceTokenData:completion` removes the association for that `identity`.
6 |
7 | ### Updating a Push Credential
8 |
9 | If you need to change or update your credentials provided by Apple you can do so by selecting the Push Credential in the [console](https://www.twilio.com/console/voice/sdks/credentials) and adding your new `certificate` and `private key` in the text box provided on the Push Credential page shown below:
10 |
11 | 
12 |
13 | ### Deleting a Push Credential
14 |
15 | We **do not recommend that you delete a Push Credential** unless the application that it was created for is no longer being used.
16 |
17 | If **your APNS VoIP certificate is expiring soon or has expired you should not delete your Push Credential**, instead you should update the Push Credential by following the `Updating a Push Credential` section.
18 |
19 | When a Push Credential is deleted **any associated registrations made with this Push Credential will be deleted**. Future attempts to reach an `identity` that was registered using the Push Credential SID of this deleted push credential **will fail**.
20 |
21 | If you are certain you want to delete a Push Credential you can click on `Delete this Credential` on the [console](https://www.twilio.com/console/voice/sdks/credentials) page of the selected Push Credential.
22 |
23 | Please ensure that after deleting the Push Credential you remove or replace the Push Credential SID when generating new access tokens.
--------------------------------------------------------------------------------
/Docs/call-from-history.md:
--------------------------------------------------------------------------------
1 | ## Making Calls from Call History
2 |
3 | The document show a quick example of how to make outgoing calls from recent call history or from contacts.
4 |
5 | ### Steps
6 |
7 | #### 1. Specify supported handle types when initializing the `CXProvider` object. User activity callback will not be triggered if this is not set.
8 |
9 | ```.swift
10 | let configuration = CXProviderConfiguration(localizedName: "Voice Quickstart")
11 | configuration.maximumCallGroups = 1
12 | configuration.maximumCallsPerCallGroup = 1
13 |
14 | // Specify supported handle types so the app gets user activity callback when a call is made from call history
15 | configuration.supportedHandleTypes = [.generic, .phoneNumber]
16 |
17 | if let provider = CXProvider(configuration: configuration) {
18 | provider.setDelegate(self, queue: nil)
19 | }
20 |
21 | ```
22 |
23 | ```.objc
24 | CXProviderConfiguration *configuration = [[CXProviderConfiguration alloc] initWithLocalizedName:@"Voice"];
25 | configuration.maximumCallGroups = 1;
26 | configuration.maximumCallsPerCallGroup = 1;
27 |
28 | // Specify supported handle types so the app gets user activity callback when a call is made from call history
29 | configuration.supportedHandleTypes = [NSSet setWithArray:@[@(CXHandleTypeGeneric), @(CXHandleTypePhoneNumber)]];
30 |
31 | self.callKitProvider = [[CXProvider alloc] initWithConfiguration:configuration];
32 | [self.callKitProvider setDelegate:self queue:nil];
33 |
34 | ```
35 |
36 | #### 2. Implement the `[UIApplication continueUserActivity:restorationHandler:]` delegate method and use the `INStartAudioCallIntent` to start a call.
37 |
38 | ```.swift
39 | func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
40 | if let callIntent = userActivity.interaction?.intent as? INStartAudioCallIntent,
41 | let contact = callIntent.contacts?[0] {
42 | guard let handle = contact.personHandle?.value else { return false }
43 | // Start a new call with CallKit
44 | makeCall(handle)
45 | }
46 |
47 | return true
48 | }
49 | ```
50 |
51 | ```.objc
52 | - (BOOL)application:(UIApplication *)application
53 | continueUserActivity:(NSUserActivity *)userActivity
54 | restorationHandler:(void(^)(NSArray15 | Congratulations you just started a new Twilio 16 | Serverless project. 17 |
18 | 19 |Assets
20 |21 | Assets are static files, like HTML, CSS, JavaScript, images or audio 22 | files. 23 |
24 | 25 |26 | This HTML page is an example of a public asset, you can 27 | access this by loading it in the browser. The HTML also refers to 28 | another public asset for CSS styles. 29 |
30 |
31 | You can also have private assets, there is an example
32 | private asset called message.private.js in the
33 | /assets directory. This file cannot be loaded in the
34 | browser, but you can load it as part of a function by finding its path
35 | using Runtime.getAssets() and then requiring the file.
36 | There is an example of this in
37 | /functions/private-message.js.
38 |
Functions
41 |42 | Functions are JavaScript files that will respond to incoming HTTP 43 | requests. There are public and 44 | protected functions. 45 |
46 | 47 |
48 | Public functions respond to all HTTP requests. There is
49 | an example of a public function in
50 | /functions/hello-world.js.
51 |
54 | Protected functions will only respond to HTTP requests
55 | with a valid Twilio signature in the header. You can read more about
56 | validating requests from Twilio in the documentation. There is an example of a protected function in
59 | /functions/sms/reply.protected.js
60 |
twilio-run
63 | 64 |
65 | Functions and assets are served, deployed and debugged using
66 | twilio-run. You can serve the project locally with the command
69 | npm start which is really running
70 | twilio-run --env under the hood. If you want to see what
71 | else you can do with twilio-run enter
72 | npx twilio-run --help on the command line or check out
73 | the project documentation on GitHub.
76 |
64 |
65 | This app requires the [Serverless plug-in](https://github.com/twilio-labs/plugin-serverless). Install the CLI plugin with:
66 |
67 | $ twilio plugins:install @twilio-labs/plugin-serverless
68 |
69 | Before deploying, create a `Server/.env` by copying from `Server/.env.example`
70 |
71 | $ cp Server/.env.example Server/.env
72 |
73 | Update `Server/.env` with your Account SID, auth token, API Key and secret
74 |
75 | ACCOUNT_SID=ACxxxx
76 | AUTH_TOKEN=xxxxxx
77 | API_KEY_SID=SKxxxx
78 | API_SECRET=xxxxxx
79 | APP_SID=APxxxx (available in step 3)
80 | PUSH_CREDENTIAL_SID=CRxxxx (available in step 6)
81 |
82 | 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:
83 |
84 | $ cd Server
85 | $ twilio serverless:deploy
86 |
87 | 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:
88 |
89 | * [voice-quickstart-server-java](https://github.com/twilio/voice-quickstart-server-java)
90 | * [voice-quickstart-server-node](https://github.com/twilio/voice-quickstart-server-node)
91 | * [voice-quickstart-server-php](https://github.com/twilio/voice-quickstart-server-php)
92 | * [voice-quickstart-server-python](https://github.com/twilio/voice-quickstart-server-python)
93 |
94 | Follow the instructions in the project's README to get the application server up and running locally and accessible via the public Internet.
95 |
96 | ### 
147 |
148 | ### 
213 |
214 | ### 
221 |
222 | ### 
227 |
228 | ##