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.
--------------------------------------------------------------------------------
/AudioDeviceExample/ViewController.swift:
--------------------------------------------------------------------------------
1 | //
2 | // ViewController.swift
3 | // AudioDeviceExample
4 | //
5 | // Copyright © 2020 Twilio, Inc. All rights reserved.
6 | //
7 |
8 | import CallKit
9 | import UIKit
10 |
11 | import TwilioVoice
12 |
13 | let twimlParamTo = "to"
14 |
15 | class ViewController: UIViewController {
16 |
17 | var accessToken: String? = <#Replace with Access Token string#>
18 | var activeCall: Call?
19 | var audioDevice: ExampleAVAudioEngineDevice = ExampleAVAudioEngineDevice()
20 |
21 | var callKitProvider: CXProvider
22 | var callKitCallController: CXCallController
23 | var userInitiatedDisconnect: Bool = false
24 | var callKitCompletionCallback: ((Bool) -> Void)? = nil
25 |
26 | @IBOutlet weak var outgoingTextField: UITextField!
27 | @IBOutlet weak var callButton: UIButton!
28 | @IBOutlet weak var callControlView: UIView!
29 | @IBOutlet weak var muteSwitch: UISwitch!
30 | @IBOutlet weak var speakerSwitch: UISwitch!
31 | @IBOutlet weak var playMusicButton: UIButton!
32 |
33 | override func viewDidLoad() {
34 | super.viewDidLoad()
35 | // Do any additional setup after loading the view.
36 | }
37 |
38 | required init?(coder aDecoder: NSCoder) {
39 | let configuration = CXProviderConfiguration(localizedName: "AudioDeviceExample")
40 | configuration.maximumCallGroups = 1
41 | configuration.maximumCallsPerCallGroup = 1
42 |
43 | callKitProvider = CXProvider(configuration: configuration)
44 | callKitCallController = CXCallController()
45 |
46 | super.init(coder: aDecoder)
47 |
48 | callKitProvider.setDelegate(self, queue: nil)
49 |
50 | TwilioVoiceSDK.audioDevice = audioDevice
51 | }
52 |
53 | deinit {
54 | // CallKit has an odd API contract where the developer must call invalidate or the CXProvider is leaked.
55 | callKitProvider.invalidate()
56 | }
57 |
58 | func toggleUIState(isEnabled: Bool, showCallControl: Bool) {
59 | callButton.isEnabled = isEnabled
60 | callControlView.isHidden = !showCallControl;
61 | muteSwitch.isOn = !showCallControl;
62 | speakerSwitch.isOn = showCallControl;
63 | }
64 |
65 | // MARK: AVAudioSession
66 |
67 | func toggleAudioRoute(toSpeaker: Bool) {
68 | // The mode set by the Voice SDK is "VoiceChat" so the default audio route is the built-in receiver. Use port override to switch the route.
69 | do {
70 | try AVAudioSession.sharedInstance().overrideOutputAudioPort(toSpeaker ? .speaker : .none)
71 | } catch {
72 | NSLog(error.localizedDescription)
73 | }
74 | }
75 |
76 | func showMicrophoneAccessRequest(_ uuid: UUID, _ handle: String) {
77 | let alertController = UIAlertController(title: "Voice Quick Start",
78 | message: "Microphone permission not granted",
79 | preferredStyle: .alert)
80 |
81 | let continueWithoutMic = UIAlertAction(title: "Continue without microphone", style: .default) { [weak self] _ in
82 | self?.performStartCallAction(uuid: uuid, handle: handle)
83 | }
84 |
85 | let goToSettings = UIAlertAction(title: "Settings", style: .default) { _ in
86 | UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!,
87 | options: [UIApplication.OpenExternalURLOptionsKey.universalLinksOnly: false],
88 | completionHandler: nil)
89 | }
90 |
91 | let cancel = UIAlertAction(title: "Cancel", style: .cancel) { [weak self] _ in
92 | self?.toggleUIState(isEnabled: true, showCallControl: false)
93 | }
94 |
95 | [continueWithoutMic, goToSettings, cancel].forEach { alertController.addAction($0) }
96 |
97 | present(alertController, animated: true, completion: nil)
98 | }
99 |
100 | func checkRecordPermission(completion: @escaping (_ permissionGranted: Bool) -> Void) {
101 | let permissionStatus = AVAudioSession.sharedInstance().recordPermission
102 |
103 | switch permissionStatus {
104 | case .granted:
105 | // Record permission already granted.
106 | completion(true)
107 | case .denied:
108 | // Record permission denied.
109 | completion(false)
110 | case .undetermined:
111 | // Requesting record permission.
112 | // Optional: pop up app dialog to let the users know if they want to request.
113 | AVAudioSession.sharedInstance().requestRecordPermission { granted in completion(granted) }
114 | default:
115 | completion(false)
116 | }
117 | }
118 |
119 | @IBAction func callButtonTapped(_ sender: Any) {
120 | guard activeCall == nil else {
121 | userInitiatedDisconnect = true
122 | performEndCallAction(uuid: activeCall!.uuid!)
123 | toggleUIState(isEnabled: false, showCallControl: false)
124 |
125 | return
126 | }
127 |
128 | checkRecordPermission { [weak self] permissionGranted in
129 | let uuid = UUID()
130 | let handle = "Voice Bot"
131 |
132 | guard !permissionGranted else {
133 | self?.performStartCallAction(uuid: uuid, handle: handle)
134 | return
135 | }
136 |
137 | self?.showMicrophoneAccessRequest(uuid, handle)
138 | }
139 | }
140 |
141 | @IBAction func muteSwitchToggled(_ sender: UISwitch) {
142 | guard let activeCall = activeCall else { return }
143 |
144 | activeCall.isMuted = sender.isOn
145 | }
146 |
147 | @IBAction func speakerSwitchToggled(_ sender: UISwitch) {
148 | toggleAudioRoute(toSpeaker: sender.isOn)
149 | }
150 |
151 | @IBAction func playMusicButtonTapped(_ sender: UIButton) {
152 | audioDevice.playMusic()
153 | }
154 | }
155 |
156 | // MARK: - TVOCallDelegate
157 |
158 | extension ViewController: CallDelegate {
159 | func callDidStartRinging(call: Call) {
160 | NSLog("callDidStartRinging:")
161 |
162 | callButton.setTitle("Ringing", for: .normal)
163 | }
164 |
165 | func callDidConnect(call: Call) {
166 | NSLog("callDidConnect:")
167 |
168 | if let callKitCompletionCallback = callKitCompletionCallback {
169 | callKitCompletionCallback(true)
170 | }
171 |
172 | callButton.setTitle("Hang Up", for: .normal)
173 | toggleUIState(isEnabled: true, showCallControl: true)
174 | toggleAudioRoute(toSpeaker: true)
175 | }
176 |
177 | func call(call: Call, isReconnectingWithError error: Error) {
178 | NSLog("call:isReconnectingWithError:")
179 |
180 | callButton.setTitle("Reconnecting", for: .normal)
181 | toggleUIState(isEnabled: false, showCallControl: false)
182 | }
183 |
184 | func callDidReconnect(call: Call) {
185 | NSLog("callDidReconnect:")
186 |
187 | callButton.setTitle("Hang Up", for: .normal)
188 | toggleUIState(isEnabled: true, showCallControl: true)
189 | }
190 |
191 | func callDidFailToConnect(call: Call, error: Error) {
192 | NSLog("Call failed to connect: \(error.localizedDescription)")
193 |
194 | if let completion = callKitCompletionCallback {
195 | completion(false)
196 | }
197 |
198 | performEndCallAction(uuid: call.uuid!)
199 | callDisconnected(call)
200 | }
201 |
202 | func callDidDisconnect(call: Call, error: Error?) {
203 | if let error = error {
204 | NSLog("Call failed: \(error.localizedDescription)")
205 | } else {
206 | NSLog("Call disconnected")
207 | }
208 |
209 | if !userInitiatedDisconnect {
210 | var reason = CXCallEndedReason.remoteEnded
211 |
212 | if error != nil {
213 | reason = .failed
214 | }
215 |
216 | callKitProvider.reportCall(with: call.uuid!, endedAt: Date(), reason: reason)
217 | }
218 |
219 | callDisconnected(call)
220 | }
221 |
222 | func callDisconnected(_ call: Call) {
223 | if call == activeCall {
224 | activeCall = nil
225 | }
226 |
227 | userInitiatedDisconnect = false
228 |
229 | toggleUIState(isEnabled: true, showCallControl: false)
230 | callButton.setTitle("Call", for: .normal)
231 | }
232 | }
233 |
234 | // MARK: - CXProviderDelegate
235 |
236 | extension ViewController: CXProviderDelegate {
237 | func providerDidReset(_ provider: CXProvider) {
238 | NSLog("providerDidReset:")
239 | audioDevice.isEnabled = false
240 | }
241 |
242 | func providerDidBegin(_ provider: CXProvider) {
243 | NSLog("providerDidBegin")
244 | }
245 |
246 | func provider(_ provider: CXProvider, didActivate audioSession: AVAudioSession) {
247 | NSLog("provider:didActivateAudioSession:")
248 | audioDevice.isEnabled = true
249 | }
250 |
251 | func provider(_ provider: CXProvider, didDeactivate audioSession: AVAudioSession) {
252 | NSLog("provider:didDeactivateAudioSession:")
253 | audioDevice.isEnabled = false
254 | }
255 |
256 | func provider(_ provider: CXProvider, timedOutPerforming action: CXAction) {
257 | NSLog("provider:timedOutPerformingAction:")
258 | }
259 |
260 | func provider(_ provider: CXProvider, perform action: CXStartCallAction) {
261 | NSLog("provider:performStartCallAction:")
262 |
263 | provider.reportOutgoingCall(with: action.callUUID, startedConnectingAt: Date())
264 |
265 | performVoiceCall(uuid: action.callUUID, client: "") { success in
266 | if success {
267 | provider.reportOutgoingCall(with: action.callUUID, connectedAt: Date())
268 | action.fulfill()
269 | } else {
270 | action.fail()
271 | }
272 | }
273 | }
274 |
275 | func provider(_ provider: CXProvider, perform action: CXEndCallAction) {
276 | NSLog("provider:performEndCallAction:")
277 |
278 | if let call = activeCall {
279 | call.disconnect()
280 | }
281 |
282 | action.fulfill()
283 | }
284 |
285 | func provider(_ provider: CXProvider, perform action: CXSetHeldCallAction) {
286 | NSLog("provider:performSetHeldAction:")
287 |
288 | if let call = activeCall {
289 | call.isOnHold = action.isOnHold
290 | action.fulfill()
291 | } else {
292 | action.fail()
293 | }
294 | }
295 |
296 | func provider(_ provider: CXProvider, perform action: CXSetMutedCallAction) {
297 | NSLog("provider:performSetMutedAction:")
298 |
299 | if let call = activeCall {
300 | call.isMuted = action.isMuted
301 | action.fulfill()
302 | } else {
303 | action.fail()
304 | }
305 | }
306 |
307 |
308 | // MARK: Call Kit Actions
309 | func performStartCallAction(uuid: UUID, handle: String) {
310 | let callHandle = CXHandle(type: .generic, value: handle)
311 | let startCallAction = CXStartCallAction(call: uuid, handle: callHandle)
312 | let transaction = CXTransaction(action: startCallAction)
313 |
314 | callKitCallController.request(transaction) { error in
315 | if let error = error {
316 | NSLog("StartCallAction transaction request failed: \(error.localizedDescription)")
317 | return
318 | }
319 |
320 | NSLog("StartCallAction transaction request successful")
321 |
322 | let callUpdate = CXCallUpdate()
323 |
324 | callUpdate.remoteHandle = callHandle
325 | callUpdate.supportsDTMF = true
326 | callUpdate.supportsHolding = true
327 | callUpdate.supportsGrouping = false
328 | callUpdate.supportsUngrouping = false
329 | callUpdate.hasVideo = false
330 |
331 | self.callKitProvider.reportCall(with: uuid, updated: callUpdate)
332 | }
333 | }
334 |
335 | func reportIncomingCall(from: String, uuid: UUID) {
336 | let callHandle = CXHandle(type: .generic, value: from)
337 |
338 | let callUpdate = CXCallUpdate()
339 |
340 | callUpdate.remoteHandle = callHandle
341 | callUpdate.supportsDTMF = true
342 | callUpdate.supportsHolding = true
343 | callUpdate.supportsGrouping = false
344 | callUpdate.supportsUngrouping = false
345 | callUpdate.hasVideo = false
346 |
347 | callKitProvider.reportNewIncomingCall(with: uuid, update: callUpdate) { error in
348 | if let error = error {
349 | NSLog("Failed to report incoming call successfully: \(error.localizedDescription).")
350 | } else {
351 | NSLog("Incoming call successfully reported.")
352 | }
353 | }
354 | }
355 |
356 | func performEndCallAction(uuid: UUID) {
357 |
358 | let endCallAction = CXEndCallAction(call: uuid)
359 | let transaction = CXTransaction(action: endCallAction)
360 |
361 | callKitCallController.request(transaction) { error in
362 | if let error = error {
363 | NSLog("EndCallAction transaction request failed: \(error.localizedDescription).")
364 | } else {
365 | NSLog("EndCallAction transaction request successful")
366 | }
367 | }
368 | }
369 |
370 | func performVoiceCall(uuid: UUID, client: String?, completionHandler: @escaping (Bool) -> Void) {
371 | guard let token = accessToken, token.count > 0 else {
372 | completionHandler(false)
373 | return
374 | }
375 |
376 | let connectOptions = ConnectOptions(accessToken: token) { builder in
377 | builder.params = [twimlParamTo: self.outgoingTextField.text ?? ""]
378 | builder.uuid = uuid
379 | }
380 |
381 | let call = TwilioVoiceSDK.connect(options: connectOptions, delegate: self)
382 | activeCall = call
383 | callKitCompletionCallback = completionHandler
384 | }
385 | }
386 |
387 |
--------------------------------------------------------------------------------
/Docs/access-tokens.md:
--------------------------------------------------------------------------------
1 | ## Access Tokens
2 |
3 | The access token generated by your server component is a [jwt](https://jwt.io) that contains a `grant` for Programmable Voice, an `identity` that you specify, and a `time-to-live` that sets the lifetime of the generated access token. The default `time-to-live` is 1 hour and is configurable up to 24 hours using the Twilio helper libraries.
4 |
5 | ### Uses
6 |
7 | In the iOS SDK the access token is used for the following:
8 |
9 | 1. To make an outgoing call via `TwilioVoice.connect(...)`
10 | 2. To register or unregister for incoming notifications using VoIP Push Notifications via `TwilioVoice.registerWithAccessToken(...)` and `TwilioVoice.unregisterWithAccessToken(...)`. Once registered, incoming notifications are handled via a `TVOCallInvite` where you can choose to accept or reject the invite. When accepting the call an access token is not required. Internally the `TVOCallInvite` has its own access token that ensures it can connect to our infrastructure.
11 |
12 | ### Managing Expiry
13 |
14 | As mentioned above, an access token will eventually expire. If an access token has expired, our infrastructure will return error `TVOErrorAccessTokenExpired`/`20104` via `TVOCallDelegate` or a completion error when registering.
15 |
16 | There are number of techniques you can use to ensure that access token expiry is managed accordingly:
17 |
18 | - Always fetch a new access token from your access token server before making an outbound call.
19 | - Retain the access token until getting a `TVOErrorAccessTokenExpired`/`20104` error before fetching a new access token.
20 | - Retain the access token along with the timestamp of when it was requested so you can verify ahead of time whether the token has already expired based on the `time-to-live` being used by your server.
21 | - Prefetch the access token whenever the `UIApplication`, or `UIViewController` associated with an outgoing call is created.
--------------------------------------------------------------------------------
/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(^)(NSArray
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/migration-guide-2.x-3.x.md:
--------------------------------------------------------------------------------
1 | ## 2.x to 3.x Migration Guide
2 | This section describes API or behavioral changes when upgrading from Voice iOS 2.x to Voice iOS 3.x. Each section provides code snippets to assist in transitioning to the new API.
3 |
4 | 1. [Making a Call](#making-a-call)
5 | 2. [TVOCallInvite Changes](#tvocallinvite-changes)
6 | 3. [Specifying a Media Region](#specifying-a-media-region)
7 | 4. [TVOConnectOptions & TVOAcceptOptions](#tvoconnectoptions-and-tvoacceptoptions)
8 | 5. [Media Establishment & Connectivity](#media-establishment-and-connectivity)
9 | 6. [CallKit](#callkit)
10 | 7. [Microphone Permission](#microphone-permission)
11 |
12 | #### 
44 |
45 | If the number is not validated at **A** level or there is no verification information
46 |
47 | 
48 |
--------------------------------------------------------------------------------
/Images/audio-device-example-call-bob.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/audio-device-example-call-bob.png
--------------------------------------------------------------------------------
/Images/audio-device-example-play.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/audio-device-example-play.png
--------------------------------------------------------------------------------
/Images/audio-engine-example.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/audio-engine-example.jpg
--------------------------------------------------------------------------------
/Images/client-to-client.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/client-to-client.png
--------------------------------------------------------------------------------
/Images/client-to-pstn.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/client-to-pstn.png
--------------------------------------------------------------------------------
/Images/hang-up.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/hang-up.png
--------------------------------------------------------------------------------
/Images/incoming-call.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/incoming-call.png
--------------------------------------------------------------------------------
/Images/keychain-api-key-secret.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/keychain-api-key-secret.png
--------------------------------------------------------------------------------
/Images/unverified-caller-number.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/unverified-caller-number.png
--------------------------------------------------------------------------------
/Images/update_push_credential.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/update_push_credential.png
--------------------------------------------------------------------------------
/Images/verified-caller-number.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/twilio/voice-quickstart-ios/d1fa0a409224cd75b51cad78a7935a47952e490f/Images/verified-caller-number.png
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright © 2016-2017 Twilio, Inc. All rights reserved.
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/ObjcVoiceQuickstart.xcodeproj/project.xcworkspace/contents.xcworkspacedata:
--------------------------------------------------------------------------------
1 |
2 | 
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 | ## 15 | 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 |