Class

INStartCallIntent

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

Declaration

class INStartCallIntent : INIntent

Overview

SiriKit creates INStartCallIntent objects when the user wants to place a call using your app. A call intent object contains the users to 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 INStartCallIntentHandling protocol. Your handler should confirm the request and create an INStartCallIntentResponse object that indicates it’s possible to begin the call. Don’t try to initiate calls directly from your Intents extension. Instead, 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.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Start call intent attributes

Attribute

Description

Supported by

Siri Intents, Siri Suggestions

Always requires unlocked device

No

Example Phrases

Users can ask Siri to search for calls in a variety of ways. Table 2 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.

Table 2

Siri phrases that trigger the start of a call

Locale

Example 1

Example 2

en

Call Andrew on <appName>

zh_CN

<appName>打电话给13800123455

用QQ打视频电话给小白

zh_HK

<appName>打電話比小明

<appName>打電話比Jeffrey

zh_TW

<appName>打電話

用<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>

Chiama Riccardo con <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>

โทรหามีนาด้วย <appName>

tr

Hasan'ı <appName> ile ara

Halim'i <appName> üzerinden ara

In Table 2, <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.

Relationships

Inherits From

Conforms To

See Also

Start a Call

protocol INStartCallIntentHandling

An interface that handles requests to start audio and video calls.

class INStartCallIntentResponse

Your app’s response to a start call intent.