TVOCallInvite

@brief From value of the Call Invite.

@discussion This may be nil if the notification passed in <[TwilioVoiceSDK handleNotification:delegate:delegateQueue:callMessageDelegate:]> method does not have valid information in it.

@brief To value of the Call Invite.

@brief A server assigned identifier (SID) for the incoming Call.

@discussion Accepting a TVOCallInvite yields a TVOCall which inherits this SID.

@brief Custom parameters embedded in the VoIP notification payload.

@discussion The custom parameters will be received in the notification payload with the twi_params key and in query-string format, e.g. key1=value1&key2=value2. To receive custom parameters on the mobile client, add <Parameter> tags into the <Client> tag in the TwiML response.

 <?xml version="1.0" encoding="UTF-8"?>
 <Response>
   <Dial callerId="client:alice">
     <Client>
       <Identity>bob</Identity>
       <Parameter name="caller_first_name" value="alice" />
       <Parameter name="caller_last_name" value="smith" />
     </Client>
   </Dial>
 </Response>

The customParameters value would be:

 {
     "caller_first_name" = "alice";
     "caller_last_name" = "smith";
 }

Note: While the value field passed into <Parameter> gets URI encoded by the Twilio infrastructure and URI decoded when parsed during the creation of a TVOCallInvite, the name does not get URI encoded or decoded. As a result, it is recommended that the name field only use ASCII characters.

@brief The TVOCallerInfo that represents SHAKEN/STIR status information about the caller.

@brief Accepts the incoming Call Invite.

@discussion This method is guaranteed to return a <TVOCall> object. It’s possible for the returned Call to either succeed or fail to connect.

The <TVOCallDelegate> will receive the Call state update callbacks. The callbacks are listed here.

If accept fails, call:didFailToConnectWithError: or call:didDisconnectWithError: callback is raised with an NSError object. [error localizedDescription], [error localizedFailureReason] and [error code] provide details of the failure.

If <[TVOCallInvite acceptWithDelegate:]> fails due to an authentication error, the SDK receives the following error.

If any connection fails because of any other error then the SDK will receive one of the following errors.

Insights

If connection fails then an error event will be published.

** An example of using the acceptWithDelegate: API **

 @interface CallViewController () <TVOCallDelegate, TVONotificationDelegate, ... >

 // property declarations

 @end

 @implementation CallViewController

 // ViewController setup and other code ...

 - (void)callInviteReceived:(TVOCallInvite *)callInvite {
     self.call = [callInvite acceptWithDelegate:self];
 }

 #pragma mark - TVOCallDelegate

 - (void)call:(TVOCall *)call didFailToConnectWithError:(NSError *)error {
     NSLog("Failed to Connect the Call: %@\n\t  - reason: %@", [error localizedDescription], [error localizedFailureReason]);
 }

 - (void)call:(TVOCall *)call didDisconnectWithError:(NSError *)error {
     if (error) {
         NSLog(@"Call disconnected with error: %@", error);
     } else {
         NSLog(@"Call disconnected");
     }
 }

 - (void)callDidConnect:(TVOCall *)call {
     NSLog(@"Call connected.");
 }

 @end

@brief Accepts the incoming Call Invite.

@discussion This method is guaranteed to return a <TVOCall> object. It’s possible for the returned Call to either succeed or fail to connect.

The <TVOCallDelegate> will receive the Call state update callbacks. The callbacks are same as acceptWithDelegate: API.

If accept fails, call:didFailToConnectWithError: or call:didDisconnectWithError: callback is raised with an NSError object. [error localizedDescription], [error localizedFailureReason] and [error code] provide details of the failure. The error codes are same as acceptWithDelegate: API.

Insights

If connection fails then an error event will be published.

** An example of using the acceptWithOptions:delegate: API **

 @interface CallViewController () <TVOCallDelegate, TVONotificationDelegate, ... >

 // property declarations

 @end

 @implementation CallViewController

 // ViewController setup and other code ...

 - (void)callInviteReceived:(TVOCallInvite *)callInvite {
     TVOAcceptOptions *options = [TVOAcceptOptions optionsWithCallInvite:callInvite
                                                                   block:^(TVOAcceptOptionsBuilder *builder) {
         builder.uuid = callInvite.uuid;
     }];
     self.call = [callInvite acceptWithOptions:options delegate:self];
 }

 #pragma mark - TVOCallDelegate

 - (void)call:(TVOCall *)call didFailToConnectWithError:(NSError *)error {
     NSLog("Failed to Connect the Call: %@\n\t  - reason: %@", [error localizedDescription], [error localizedFailureReason]);
 }

 - (void)call:(TVOCall *)call didDisconnectWithError:(NSError *)error {
     if (error) {
         NSLog(@"Call disconnected with error: %@", error);
     } else {
         NSLog(@"Call disconnected");
     }
 }

 - (void)callDidConnect:(TVOCall *)call {
     NSLog(@"Call connected.");
 }

 @end

@brief Rejects the incoming Call Invite.

Insights

@brief Sends a user-defined message to the endpoints that subscribe to the user-defined messages of this Call Invite.

@discussion The result will be raised to the TVOCallMessageDelegate provided in the [TwilioVoiceSDK handleNotification:delegate:delegateQueue:callMessageDelegate:] on the same dispatch queue. Dispatch main queue will be used if not specified.

@discussion Sending a call message with content size that exceeds 10 KB or sending more than 10 call messages within one minute will result in the [TVOCallMessageDelegate call:didFailToSendMessage:error] callback.

@discussion A call message with content that does not match the content type will not result in the [TVOCallMessageDelegate call:didFailToSendMessage:error] callback but will generate an error in your Twilio developer console. For example, a call message with content type “application/json” but with the content “Hello World”, which is not a valid JSON object, will result in such error.

@discussion A subscription with a user-defined message callback is required prior to calling this method. Calling the [TVOCallInvite sendMessage:] method without subscribing first will result in an error in your Twilio developer console.

@discussion This method returns an empty string and will not send out the Call Message if the Call Invite has been accepted or rejected.

@discussion This feature is currently in Beta.

@brief Call Invites cannot be instantiated directly. See <TVONotificationDelegate> instead.

@brief UUID of the Call Invite.

@discussion Use this UUID for CallKit methods. Accepting a TVOCallInvite yields a TVOCall which inherits its UUID from the Invite.

@brief Returns true if the provided payload would result in a TVOCallInvite via the [TVONotificationDelegate callInviteReceived:] callback when passed into [TwilioVoiceSDK handleNotification:delegate:delegateQueue:callMessageDelegate:].