INStartVideoCallIntent
A request to start a video call with one or more users.
Declaration
class INStartVideoCallIntentOverview
The system creates INStartVideoCallIntent objects to let you know when the user wants to place a video call using your app. A video call intent object contains the users to include in the call. It’s up to you to match 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 INStartVideoCallIntentHandling protocol. Your handler confirms the request and creates an INStartVideoCallIntentResponse 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
There are many ways in which users can ask Siri to place a video 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 | ||
zh_CN | ||
zh_HK | 喺 | |
zh_TW | 用 | |
yue_CN | 喺打俾Gary | |
ar | مكالمة فيديو عبر | اتصل فيديو باستخدام |
da | ||
de | Videoanruf bei Hans mit | Videokonferenz mit Hans mit |
es | Llamada de video a Salvador en | Vídeollamada a Gustavo por |
fi | Soita videopuhelu Annalle | Soita |
fr | Fais un appel vidéo avec Alexandre sur | Appelle Alexandre sur |
he | תתקשרי למשה ב | תתקשרי ל-0525552222 באמצעות |
it | ||
ja |
| 山田に |
ko |
|
|
ms | Buat panggilan video | Buat panggilan video ke Aaron menggunakan |
nb | Start en videosamtale til Stein med | Videosamtale med |
nl | Start een videogesprek met Piet via | Bel Sara met video via |
pt | Fazer uma ligação de vídeo pro João no | Ligar com vídeo para Maria usando |
ru | Видео звонок моему папе по | Начать видео звонок с Ильёй через |
sv | Ring ett videosamtal med | Ring Maja med |
th | Facetime หา ผ่าน | |
tr | Hasan’ı | Halim’e |
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.