VoIP Calling

Initiate calls and search the user's call history.

Overview

With the VoIP domain, users can ask Siri to initiate audio and video calls or search for calls already received by your app. Your Intents app extension validates the intent parameters but does not place calls or perform searches directly. Instead, SiriKit expects you to hand off control to your app, which is responsible for displaying the search results and managing calls.

Figure 1

Initiating an audio call from Siri

Initiating an audio call from Siri

Topics

First Steps

INCallsDomainHandling

Provides a convenient way to adopt all of the protocols in the VoIP calling domain.

Search the Call History

Search for calls by type, date, or recipient.

INSearchCallHistoryIntentHandling

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

INSearchCallHistoryIntent

A request to list the calls matching the specified criteria.

INSearchCallHistoryIntentResponse

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

Start an Audio Call

Initiate a new audio-only call, transferring control to your app for the call itself.

INStartAudioCallIntentHandling

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

INStartAudioCallIntent

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

INStartAudioCallIntentResponse

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

Start a Video Call

Initiate a new video call, transferring control to your app for the call itself.

INStartVideoCallIntentHandling

The handler interface for initiating a video call from your app.

INStartVideoCallIntent

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

INStartVideoCallIntentResponse

Your response to a start video call intent.

Data Objects

INCallRecord

The details about a call handled by your app.

INCallRecordType

Constants describing the type of the call.

INCallRecordTypeOptions

Constants describing the types of calls to include during a search.

INCallDestinationType

Constants describing the destination of a call.

Resolution Results

INCallDestinationTypeResolutionResult

A resolution result for the destination type of a call.

INCallRecordTypeResolutionResult

A resolution result for the types of calls that your app handled.

INCallRecordTypeOptionsResolutionResult

A resolution result for the call types to include in a search.

See Also

Intent Domains

Messaging

Send messages and search the user's received messages.

Lists and Notes

Create and manage notes and to-do list items.

Workouts

Start, end, and manage fitness routines.

Payments

Send payments between users or pay bills.

Visual Codes

Convey contact and payment information using Quick Response (QR) codes.

Photos

Search for and display photos.

Ride Booking

Book rides and report their status.

Car Commands

Manage vehicle door locks and get the vehicle's status.

CarPlay

Interact with a vehicle's CarPlay system.

Restaurant Reservations

Create and manage restaurant reservations with help from the Maps app.