Class

INStartAudioCallIntent

A request to start an audio-only call with one or more users.

Overview

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 be called. It is 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 INStartAudioCallIntentHandling protocol. Your handler should confirm the request and create an INStartAudioCallIntentResponse object to indicate that it is possible to begin the call. Do not 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

Table 1 lists additional attributes of this intent object.

Table 1

Start audio call intent attributes

Attribute

Description

Supported by

Siri

Always requires unlocked device

If your app adopts CallKit, the system does not 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.

If your app does not adopt CallKit, SiriKit prompts the user to unlock the device so that your app can be launched. 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 an audio call. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list is not exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the placing of an audio call

Locale

Example 1

Example 2

en

Call Andrew on <appName>

zh_CN

<appName>打电话给13800123455

zh_HK

<appName>打電話比小明

<appName>打電話比Jeffrey

zh_TW

<appName>打電話

yue_CN

喺<appName>打电话比小明

喺<appName>打电话比Jeffrey

ar

اتصل ب رنا عبر <appName>

اتصال على محمد عن طريق <appName>

da

Ring til Peter med <appName>

via fyi lav et opkald til john

de

Ruf Thomas mit <appName> an

Rufe Thomas an mit <appName>

es

Llámale a Sandra por <appName>

Llamar a Juan con <appName>

fi

Soita <appName>lla Antille

Pirauta Annalle <appName>lla

fr

Contacte Jean avec <appName>

Appelle Halim sur <appName>

he

תתקשרי למשה ב<appName>

תתקשרי למשה באמצעות <appName>

it

Chiama Riccardo usando <appName>

ja

<appName>で花子に電話

花子に<appName>で電話

ko

<appName>을 사용해서 충헌이한테 전화해

<appName>로 충헌한테 전화해

ms

Telefon Alham menggunakan <appName>

Buat panggilan <appName> ke Sherly

nb

Ring Petter med <appName>

Ring med <appName> til Stian

nl

Bel Jan via <appName>

Telefoneer naar Marie met <appName>

pt

Ligar pro Rafael utilizando <appName>

Liga para Maria no <appName>

ru

Позвони Илье с помощью <appName>

А ты можешь позвонить Анне по <appName>

sv

Använd <appName> och ring upp Johan

Ring ett <appName> samtal till Lisen

th

โทรหาวิภาวีโดยใช้ <appName>

tr

Hasan'ı <appName> ile ara

Halim'i <appName> üzerinden ara

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.

Topics

Creating the Intent Object

init(contacts: [INPerson]?)

Initializes the start audio call intent object with the specified contacts.

Deprecated

Getting the Call Attributes

Relationships

Inherits From

Conforms To

See Also

Start an Audio Call

protocol INStartAudioCallIntentHandling

The handler interface for initiating an audio call from your app.

class INStartAudioCallIntentResponse

Your app’s response to a start audio call intent.