INFO: Reference - Server Script API (kb3496)

The information in this article applies to:

• SwyxWare all versions

[ Summary | Information ]

---

Summary

Summary

SwyxServer provides a script api (application programing interface), containing a number of usefull properties and methods.

---

Information

Information

The Wiki (SwyxPEDIA) on the Swyx Forum website (http://www.swyx-forum.com) describes the most important and most used APIs in detail.

• Swyx Forum - SwyxPEDIA - Server Script API

 

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

• PBXUser.IsLoggedIn
• PBXUser.IsBusy
• PBXUser.UnconditionalRedirect
• PBXUser.UnconditionalRedirectNumber
• PBXUser.BusyRedirect
• PBXUser.BusyRedirectNumber
• PBXUser.DelayedRedirect
• PBXUser.DelayedRedirectNumber
• PBXUser.DelayedRedirectTimeout
• PBXUser.DataFolder

• PBXScript.OutputTrace
• PBXScript.OutputTraceEx
• PBXScript.CreateObject
• PBXScript.Sleep
• PBXScript.DataFolder
• PBXScript.CompareNumbers
• PBXScript.PreviousScripts
• PBXScript.InstallLanguageID
• PBXScript.SystemLanguageID

 

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

• Server Script API Return Values

 

Beside the Server Script API the Graphical Script Editor (GSE) provides a couple of build in functions:

• GSE build in functions

 

---

Comment

Comment on this article

If we have any follow-up questions, where can we contact you?

E-Mail Address (optional)

Note

This feedback form can't be used for support requests. Those requests must be directed to your Swyx reseller or distributor.

---

Updates

Created: 03.09.2007