Wiki - SwyxPEDIA

This article will cover all "hidden" Server Script API functions currently not well documented in any official SwyxWare ECR manual. It will be filled over the time, so please do not expact a complete manual right from the beginning.

There are three different COM interfaces diectly available witihn an ECR script, which do not need to be declared via CreateObject.

• PBXCall
  This interface covers properties and methods being directly connected to the current call.
• PBXUser
  This interface covers properties and methods being directly connected to the user the current script is running for.
• PBXScript
  This interface covers common properties and methods connected to scripting purposes.

There is a fourth public COM/DCOM Object available, PBXConfig, which is fully covered in the Swyx Knowledgebase. The properties and methods of this object are available for any 3rd party application running on the SwyxServer or any other machine within the network having a DCOM connection to the SwyxServer machine.

The above mentioned 3 interfaces are available within an ECR Script (made by the Graphical Script Editor) only !

The following is a (not complete) list of properties and methods of these interfaces:

• PBXCall.CallingPartyNumber
• PBXCall.CallingPartyName
• PBXCall.CalledPartyNumber
• PBXCall.ConnectedNumber
• PBXCall.ConnectedName
• PBXCall.CallProceeding
• PBXCall.Alerting
• PBXCall.CLIMode
• PBXCall.IsInternal
• PBXCall.Hold
• PBXCall.Activate
• PBXCall.IsOnHold
• PBXCall.PhoneCallListEntry
• PBXCall.IsOriginatorDisconnected
• PBXCall.DialedNumber
• PBXCall.PlayMessage
• PBXCall.Disconnect
• PBXCall.SendEMail
• PBXCall.LastRecordedMessage
• PBXCall.LastRecordedMessageLength
• PBXCall.CallId
• PBXCall.CallingDeviceType
• PBXCall.DeflectionAddress
• PBXCall.CallingDeviceName

• PBXUser.IsLoggedIn
• PBXUser.IsBusy
• PBXUser.UnconditionalRedirect
• PBXUser.UnconditionalRedirectNumber
• PBXUser.BusyRedirect
• PBXUser.BusyRedirectNumber
• PBXUser.DelayedRedirect
• PBXUser.DelayedRedirectNumber
• PBXUser.DelayedRedirectTimeout
• PBXUser.DataFolder
• PBXUser.IsOutOfOffice
• PBXUser.IsOutlookBusy
• PBXUser.IsWithinWorkingHours
• PBXUser.VoicemailWelcomeMessage
• PBXUser.VoicemailRecording
• PBXUser.VoicemailRecordingTimeout
• PBXUser.VoicemailEMailAddress
• PBXUser.NumberOfNewVoicemails
• PBXUser.Pin
• PBXUser.IsConferenceUser
• PBXUser.UserID
• PBXUser.Name
• PBXUser.Now

• PBXScript.OutputTrace
• PBXScript.CreateObject
• PBXScript.Sleep
• PBXScript.DataFolder
• PBXScript.CompareNumbers
• PBXScript.PreviousScripts
• PBXScript.InstallLanguageID
• PBXScript.SystemLanguageID
• PBXScript.IsUserOrGroupBusy
• PBXScript.IsUserOrGroupBusyEx
• PBXScript.EndScript
• PBXScript.GetAudioFileLength
• PBXScript.GetUserNamesByVanityNumber
• PBXScript.SendEMail
• PBXScript.Licenses

SwyxWare v6.10 adds the following new APIs:

• PBXScript.OutputTraceEx

The following article lists all possible return values of the Server Script API functions.

• Server Script API Return Values