INStartAudioCallIntent
A request to start an audio-only call with one or more users.
Declaration
class INStartAudioCallIntentOverview
SiriKit creates INStartAudioCallIntent objects when the user wants to place an audio call using your app. An audio call intent object contains the users to call. Your intent handler matches the information in this object to contacts in your app and to initiate the resulting call.
Your Intents extension receives this intent when the user tries to initiate a call from the Siri interface. If your app supports CallKit, you may also receive this intent when the user tries to initiate a call from system interfaces such as the Recents tab of the Phone app.
To handle this intent, the handler object in your Intents extension must adopt the INStartAudioCallIntentHandling protocol. Use your handler to confirm the request and create an INStartAudioCallIntentResponse object to indicate that it’s possible to begin the call. Don’t try to initiate calls directly from your Intents extension. SiriKit launches your app and passes it an NSUserActivity object that your app must then use to initiate the call. SiriKit places an INInteraction object in the user activity object with this intent. For calls initiated through Siri, the interaction object also includes the response provided by your Intents extension.
For a list of other intents in the VoIP calling domain, see INCallsDomainHandling.
Additional Intent Attributes
The following table lists additional attributes of this intent object:
Attribute | Description |
|---|---|
Supported by | Siri |
Always requires unlocked device | If your app adopts CallKit, the system doesn’t require an unlocked device. Instead, your app runs in the background and the system displays the in-call user interface on your app’s behalf. [Image] If your app doesn’t adopt CallKit, SiriKit prompts the user to unlock the device so that it can launch your app. If the device is already unlocked, SiriKit launches the app in the foreground. |
Apps can optionally ask the user to unlock the device before handling this intent. To require unlocking of the device, include the name of this class in the IntentsRestrictedWhileLocked key of your Intents extension’s Info.plist file.
Example Phrases
Users can ask Siri to place an audio call. The table below provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list isn’t exhaustive and Siri may recognize many other phrases.
Locale | Example 1 | Example 2 |
|---|---|---|
en | Call Andrew on | |
zh_CN | 用 | |
zh_HK | 喺 | 喺 |
zh_TW | 用 | |
yue_CN | 喺打电话比小明 | 喺打电话比Jeffrey |
ar | اتصل ب رنا عبر | اتصال على محمد عن طريق |
da | Ring til Peter med | via fyi lav et opkald til john |
de | Ruf Thomas mit | Rufe Thomas an mit |
es | Llámale a Sandra por | Llamar a Juan con |
fi | Soita | Pirauta Annalle |
fr | Contacte Jean avec | Appelle Halim sur |
he | תתקשרי למשה ב | תתקשרי למשה באמצעות |
it | Chiama Riccardo usando | |
ja |
| 花子に |
ko |
|
|
ms | Telefon Alham menggunakan | Buat panggilan |
nb | Ring Petter med | Ring med |
nl | Bel Jan via | Telefoneer naar Marie met |
pt | Ligar pro Rafael utilizando | Liga para Maria no |
ru | Позвони Илье с помощью | А ты можешь позвонить Анне по |
sv | Använd | Ring ett |
th | โทรหาวิภาวีโดยใช้ | |
tr | Hasan’ı | Halim’i |
In the preceding examples, <appName> represents the name of the app whose Intents extension initiates the call. If your app uses custom names for contacts, you can tell Siri about those names using the INVocabulary class.