Class

INSearchCallHistoryIntent

A request to list the calls matching the specified criteria.

Overview

SiriKit creates INSearchCallHistoryIntent objects when the user asks to see previous calls from their call history. This intent object contains the values for you to match when searching the user’s call history. Users can search for calls involving a specific person, calls that occurred on specific dates, or calls that are of a specific type such as missed calls. When performing the search, use only the parameters that were provided and ignore any that have no values.

To handle this intent, the handler object in your Intents extension must adopt the INSearchCallHistoryIntentHandling protocol. Your handler should confirm the request and create an INSearchCallHistoryIntentResponse object with the results of the search. For successful searches, Siri offers the user a way to launch your app and see the results.

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

Search call history intent attributes

Attribute

Description

Supported by

Siri

Always requires unlocked device

Yes

Example Phrases

There are many ways in which users can ask Siri to search for calls. 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 searching of calls

Locale

Example 1

Example 2

en

Show my calls from Kim on <appName>

zh_CN

<appName>上查找芳芳打来的电话

查一下<appName>的通话记录

zh_HK

<appName>上搵小明打來嘅電話

<appName>上搵小明打來嘅電話

zh_TW

顯示我<appName>的通話紀錄

yue_CN

喺<appName>上揾小明打来嘅电话

喺<appName>上揾小明打来嘅电话

ar

اعرض سجل مكالمات <appName>

اعرض المكالمات من رنا على <appName>

da

Vis samtalehistorik i <appName>

vis min <appName> opkaldshistorie

de

Liste alle <appName> Anrufe

Zeige mir eine Liste meiner <appName> Anrufe

es

Ver las llamadas de <appName> de Javier

Ver mi historial de llamadas por <appName>

fi

Näytä Julian <appName> puheluhistoria

Hae Johannan <appName> puhelut

fr

Montre-moi l'historique de mes appels venant de Kim sur <appName>

Affiche mes appels <appName> de Kim

he

תראי לי את השיחות שלי ב<appName>

מה השיחה האחרונה בווטסאפ

it

Mostrami le mie chiamate da Davide su <appName>

ja

<appName>で佐藤さんからの着信を探して

佐藤さんからの<appName>の着信を見せて

ko

<appName>에서 통화목록 보여줘

<appName>에서 충헌이한테서 온 통화 목록 보여줘

ms

Tunjukkan sejarah panggilan dari Ahmad dalam <appName>

Tunjuk sejarah panggilan <appName>

nb

Vis samtalehistorikk i <appName>

Vis anrop fra Kim i <appName>

nl

Toon mijn oproepen van Kim op <appName>

Geef de belgeschiedenis van <appName> weer

pt

Mostrar meu histórico de ligações com João no <appName>

Encontra meu histórico de ligações do <appName>

ru

Покажи мою историю звонков <appName>

Найди историю звонков в <appName>

sv

Lista alla samtal från Klas med <appName>

Ta fram mina <appName> samtal från Nathalie

th

แสดงประวัติการโทรทั้งหมดของ <appName>

tr

Merve'den gelen <appName> aramalarımı göster

<appName> arama geçmişi

In the preceding examples, <appName> represents the name of the app whose Intents extension searches the call history. If your app uses custom names for contacts, you can tell Siri about those names using the INVocabulary class.

Topics

Getting the Recipient

var recipient: INPerson?

The person involved in the call.

Getting the Call History Details

var dateCreated: INDateComponentsRange?

The range of dates associated with the call records.

var callTypes: INCallRecordTypeOptions

The types of calls to search.

var callType: INCallRecordType

The call type.

Deprecated
var callCapabilities: INCallCapabilityOptions

The audio-video capabilities of the call.

struct INCallCapabilityOptions

Constants indicating the capabilities of the call.

var unseen: Bool?

A Boolean indicating whether the call has not yet been seen by the user.

Relationships

Inherits From

Conforms To

See Also

Search the Call History

protocol INSearchCallHistoryIntentHandling

The handler interface for searching the user’s call history.

class INSearchCallHistoryIntentResponse

Your app’s response to a search call history intent.