Class CallOptions

Abstract
Namespace: Angelfon\SDK\Rest\Api\V099\User
Located at Rest/Api/V099/User/CallOptions.php

Methods summary
`public static Angelfon\SDK\Rest\Api\V099\User\ReadCallOptions`	# read( string $recipient = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batch = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $startedBefore = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $startedAfter = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $scheduledBefore = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $scheduledAfter = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $status = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $answer = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build filters for the API response according to the specified parameters Build filters for the API response according to the specified parameters Parameters `$recipient` The phone number to call `$batch` $batchId The ID of the batch to which this call will be added `$startedBefore` Filters calls answered before the datetime specified `$startedAfter` Filters calls answered after the datetime specified `$scheduledBefore` Filters calls scheduled before the datetime specified `$scheduledAfter` Filters calls scheduled after the datetime specified `$callFrom` Filters by phone number used to make the call `$status` Filters by call status (0 => pending, 1 => failed, 2 => answered) `$answer` Filters by numeric option dialed during the call Returns `Angelfon\SDK\Rest\Api\V099\User\ReadCallOptions` The builder for read calls options
`public static Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions`	# create( integer $type = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $audioId1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $tts1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $audioId2 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $tts2 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $audioId3 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $callerId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $recipientName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callAt = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $forceSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $adjustSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build options for a new call Build options for a new call Parameters `$type` The call type `$audioId1` The ID of the audio first in the play queue `$tts1` A text to be readed `$audioId2` The ID of the audio third in the play queue `$tts2` A text to be readed `$audioId3` The ID of the audio fifth in the play queue `$callerId` Use a validated phone to show on the call `$callFrom` Use a phone number to make the call from (special users only) `$recipientName` The name of the recipient `$callAt` UTC time to schedule the call ie. '2017-05-15 14:15:00' `$forceSchedule` Schedule call regardless of user's defined restriction periods `$adjustSchedule` Schedule call at the end of the restricted period `$batchId` Add this call to a specific batch `$batchName` Name this batch Returns `Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions` The builder for create call options
`public static Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions`	# createFree( integer $audioId1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callAt = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $callerId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $recipientName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $forceSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $adjustSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build options for a new call of type 0, which has no cost. Build options for a new call of type 0, which has no cost. Parameters `$audioId1` The ID of the audio to play in the call `$callAt` UTC time to schedule the call ie. '2017-05-15 14:15:00' `$callerId` Use a validated phone to show on the call `$callFrom` Use a phone number to make the call from (special users only) `$batchName` Name this batch `$batchId` Add this call to a specific batch `$recipientName` The name of the recipient `$forceSchedule` Schedule call regardless of user's defined restriction periods `$adjustSchedule` Schedule call at the end of the restricted period Returns `Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions` The builder for create call options
`public static Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions`	# createWithSingleAudio( integer $audioId1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callAt = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $callerId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $recipientName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $forceSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $adjustSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build options for a new call of type 1, with a single audio. Build options for a new call of type 1, with a single audio. Parameters `$audioId1` The ID of the audio to play in the call `$callAt` UTC time to schedule the call ie. '2017-05-15 14:15:00' `$callerId` Use a validated phone to show on the call `$callFrom` Use a phone number to make the call from (special users only) `$batchName` Name this batch `$batchId` Add this call to a specific batch `$recipientName` The name of the recipient `$forceSchedule` Schedule call regardless of user's defined restriction periods `$adjustSchedule` Schedule call at the end of the restricted period Returns `Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions` The builder for create call options
`public static Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions`	# createWithAnswer( integer $audioId1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callAt = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $callerId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $recipientName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $forceSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $adjustSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build options for a new call of type 2, with a single audio and answer registration. Build options for a new call of type 2, with a single audio and answer registration. Parameters `$audioId1` The ID of the audio to play in the call `$callAt` UTC time to schedule the call ie. '2017-05-15 14:15:00' `$callerId` Use a validated phone to show on the call `$callFrom` Use a phone number to make the call from (special users only) `$batchName` Name this batch `$batchId` Add this call to a specific batch `$recipientName` The name of the recipient `$forceSchedule` Schedule call regardless of user's defined restriction periods `$adjustSchedule` Schedule call at the end of the restricted period Returns `Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions` The builder for create call options
`public static Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions`	# createWithSingleTts( string $tts1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callAt = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $callerId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $recipientName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $forceSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $adjustSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build options for a new call of type 6, with a single TTS. Build options for a new call of type 6, with a single TTS. Parameters `$tts1` The text to be readed in the call `$callAt` UTC time to schedule the call ie. '2017-05-15 14:15:00' `$callerId` Use a validated phone to show on the call `$callFrom` Use a phone number to make the call from (special users only) `$batchName` Name this batch `$batchId` Add this call to a specific batch `$recipientName` The name of the recipient `$forceSchedule` Schedule call regardless of user's defined restriction periods `$adjustSchedule` Schedule call at the end of the restricted period Returns `Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions` The builder for create call options
`public static Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions`	# createWithAudioAndTts( integer $audioId1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $tts1 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $audioId2 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $tts2 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, integer $audioId3 = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callAt = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $callerId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $callFrom = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $batchId = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, string $recipientName = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $forceSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE, boolean $adjustSchedule = Angelfon\SDK\Rest\Api\V099\User\Values::NONE ) Build options for a new call of type 4, with two TTS and three Audios. Build options for a new call of type 4, with two TTS and three Audios. Parameters `$audioId1` The ID of the audio first in the play queue `$tts1` A text to be readed `$audioId2` The ID of the audio third in the play queue `$tts2` A text to be readed `$audioId3` The ID of the audio fifth in the play queue `$callAt` UTC time to schedule the call ie. '2017-05-15 14:15:00' `$callerId` Use a validated phone to show on the call `$callFrom` Use a phone number to make the call from (special users only) `$batchName` Name this batch `$batchId` Add this call to a specific batch `$recipientName` The name of the recipient `$forceSchedule` Schedule call regardless of user's defined restriction periods `$adjustSchedule` Schedule call at the end of the restricted period Returns `Angelfon\SDK\Rest\Api\V099\User\CreateCallOptions` The builder for create call options