reportNewIncomingVoIPPushPayload(_:completion:)

Reports a new incoming call after your notification service extension decrypts a VoIP call request.

Declaration

class func reportNewIncomingVoIPPushPayload(_ dictionaryPayload: [AnyHashable : Any], completion: (@Sendable ((any Error)?) -> Void)? = nil)

class func reportNewIncomingVoIPPushPayload(_ dictionaryPayload: [AnyHashable : Any]) async throws

Parameters

dictionaryPayload:
A dictionary containing additional data about the incoming call. All keys and values in the dictionary must implement the Nssecurecoding protocol.
completion:
A block that CallKit executes after allowing or disallowing the call. CallKit executes the block on a private serial queue. The completion handler takes the following parameter:
error
When the system disallows a call, it sets this parameter to an error object that contains information about why it disallowed the call; otherwise it’s nil.

Mentioned in

Sending End-to-End Encrypted VoIP Calls

Discussion

important:

You can call this method from synchronous code using a completion handler, as shown on this page, or you can call it as an asynchronous method that has the following declaration:

class func reportNewIncomingVoIPPushPayload(_ dictionaryPayload: [AnyHashable : Any]) async throws

For information about concurrency and asynchronous code in Swift, see Calling Objective-C APIs Asynchronously.

Call this method when your notification service extension receives an encrypted VoIP call request. The system then launches your app and calls your pushRegistry(_:didReceiveIncomingPushWith:for:completion:) method. From this point, the app handles the call just like any incoming VoIP call. For more information, see Sending End-to-End Encrypted VoIP Calls.

To call this method, your notification service extension must have the com.apple.developer.usernotifications.filtering entitlement.