Jump to content
  • References

    References

    35 pages in this category

    1. CallDuration()

      Last Updated:
      VBScript   → Lua   This function returns the duration (in seconds) of the current call.   Dim nDuration nDuration = CallDuration()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the duration to the caller:     This function returns an integer value.   This function can be called at any time within the call routing script.   The duration will be calculated from the Call
      • 301 views

    2. CalledNumber()

      Last Updated:
      VBScript   → Lua   This function returns the dialed number that has leaded the call to reach the current script. It returns just the first digits to correctly identify the script user but *not* any so called post dialing digits.   Dim sCalledNumber sCalledNumber = CalledNumber()     This function returns a string value.   This function is identical to the Server Script API function PBXCall.CalledPartyNumber.   This function replaces the obso
      • 252 views

    3. CallID()

      Last Updated:
      VBScript   → Lua   This function returns the unique call id of the current call.   Dim nCallID nCallID = CallID()     This function returns an integer value.   This function is identical to the Server Script API function PBXCall.CallId.   Every call within SwyxWare (regardless if internal or external) will be tagged with a unique id by the SwyxServer. This id will also be written into the Call Detail Records (CDR).   If a call will
      • 356 views

    4. CallStart()

      Last Updated:
      VBScript   → Lua   This function returns date and time when the current call reached the call routing of the user.   Dim vCallStart vCallStart = CallStart()   or if being used directly within a GSE property dialog, e.g. in a Say Time block to directly announce the start time to the caller:     This function returns a date / time value.   This function can be called at any time within the call routing script.   The start date/t
      • 206 views

    5. CurDate()

      Last Updated:
      VBScript   → Lua   This function returns the current date according to the script user's location.   Dim vDate vDate = CurDate()   or if being used directly within a GSE property dialog, e.g. in a Say Date block to directly announce the current date to the caller:       This function returns a date / time value. The returned value does not contain any time information, unlike CurDateTime().   Note:   This function is not
      • 183 views

    6. CurDateTime()

      Last Updated:
      VBScript   → Lua   This function returns the current date and time according to the script user's location.   Dim vDateTime vDateTime = CurDateTime()   or if being used directly within a GSE property dialog, e.g. in a Say Date block to directly announce the current date to the caller:         This function returns a date / time value. The returned value contains date and time information, unlike CurDate() and CurTime().   Note
      • 265 views

    7. CurDay()

      Last Updated:
      VBScript   → Lua   The function returns the current day (01-31) according to the script user's location.   Dim sDay sDay = CurDay()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current day to the caller:       This function returns a two digit stringvalue.   This function can be called at any time within the call routing script.   The current date will be re
      • 231 views

    8. CurDayOfWeek()

      Last Updated:
      VBScript   → Lua   The function returns the current day of the week (1-7) according to the script user's location.   Dim nDayOfWeek nDayOfWeek = CurDayOfWeek()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current day of the week (as a number) to the caller:       This function returns an integer value.   The returned number evaluates to:   1 - Monday
      • 188 views

    9. CurHour()

      Last Updated:
      VBScript   → Lua   The function returns the current hour (01-24) according to the script user's location.   Dim sHour sHour = CurHour()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current hour to the caller:       This function returns a two digit string value.   This function can be called at any time within the call routing script.   The current time will
      • 254 views

    10. CurMinute()

      Last Updated:
      VBScript   → Lua   The function returns the current minute (00-59) according to the script user's location.   Dim sMinute sMinute = CurMinute()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current minute to the caller:       This function returns a two digit string value.   This function can be called at any time within the call routing script.   The current
      • 189 views

    11. CurMonth()

      Last Updated:
      VBScript   → Lua   The function returns the current month (01-12) according to the script user's location.   Dim sMonth sMonth = CurMonth()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current month to the caller:       This function returns a two digit string value.   This function can be called at any time within the call routing script.   The current date
      • 201 views

    12. CurSecond()

      Last Updated:
      VBScript   → Lua   The function returns the current second (00-59) according to the script user's location.   Dim sSecond sSecond = CurSecond()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current second to the caller:       This function returns a two digit string value.   This function can be called at any time within the call routing script.   The current
      • 183 views

    13. CurTime()

      Last Updated:
      VBScript   → Lua   This function returns the current time according to the script user's location.   Dim vTime vTime = CurTime()   or if being used directly within a GSE property dialog, e.g. in a Say Time block to directly announce the current time to the caller:       This function returns a date / time value. The returned value does not contain any date information, unlike CurDateTime().   Note:   This function is not
      • 354 views

    14. CurYear()

      Last Updated:
      VBScript   → Lua   The function returns the current year (yyyy) according to the script user's location.   Dim sYear sYear = CurYear()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the current year (read as single digits, not a number) to the caller:       This function returns a four digit string value.   This function can be called at any time within the call routing scr
      • 140 views

    15. ExternalCall()

      Last Updated:
      VBScript   → Lua   This function returns True if the current call is an external call.   If ExternalCall() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the External Call status and place it the block exits:         This function returns a boolean value.   This function can be called at any time within the call
      • 117 views

    16. InternalCall()

      Last Updated:
      VBScript   → Lua   This function returns True if the current call is an internal call.   If InternalCall() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the Internal Call status and place it the block exits:         This function returns a boolean value.   This function can be called at any time within the call
      • 132 views

    17. IpPbx.Away

      Last Updated:
      VBScript   → Lua   SwxWare 2011   This property takes or returns the current away status of the script user.   ' Getting the script users current away state Dim bAway bAway = IpPbx.Away ' Setting the script users away state IpPbx.Away = True     This property takes or returns a boolean value.   If being used in a group context (from SwyxWare v13.27) this property returns false. Read more about user and group context differences here.   Th
      • 178 views

    18. IpPbx.CallingName

      Last Updated:
      VBScript   → Lua   This property takes or returns the name of the current caller.   ' Retrieving the caller name Dim sName sName = IpPbx.CallingName ' Setting the caller name IpPbx.CallingName = "Erika Mustermann"     This property takes or returns a string value.   This property can be used to modify the name being displayed on a client (SwyxIt!, SwyxPhone). It does not modify the caller list entry. This can be achieved using the PBXCall.PhoneCallLi
      • 487 views

    19. IpPbx.CallingNumber

      Last Updated:
      VBScript   → Lua   This property takes or returns the number of the current caller.   ' Retrieving the caller number Dim sNumber sNumber = IpPbx.CallingNumber ' Setting the caller number IpPbx.CallingNumber = "123456789"     This property takes or returns a string value.   This property can be used to modify the number being displayed on a client (SwyxIt!, SwyxPhone). It does not modify the caller list entry. This can be achieved using the PBXCall.Ph
      • 364 views

    20. IpPbx.DoNotDisturb

      Last Updated:
      VBScript   → Lua   SwxWare 2011   This property takes or returns the current do not disturb status of the script user.   ' Getting the script users current do not disturb (dnd) state Dim bDoNotDisturb bDoNotDisturb = IpPbx.DoNotDisturb ' Setting the script users do not disturb (dnd) state IpPbx.DoNotDisturb = True     This property takes or returns a boolean value.   If being used in a group context (from SwyxWare v13.27) this property returns fals
      • 209 views

    21. IpPbx.OneWayConference

      Last Updated:
      VBScript   → Lua   This property takes or returns the "one way" conference status of the current call. If the call is transfered into a conference this flag defines, if the caller is in "listen only" mode or not.   ' Retrieving the current oneway conference status Dim bOneWayConference bOneWayConference = IpPbx.OneWayConference ' Setting the oneway conference status IpPbx.OneWayConference = True   This property takes or returns a boolean value.   A "one w
      • 183 views

    22. IpPbx.SecondaryCallingNumber

      Last Updated:
      VBScript   → Lua   SwxWare 2011   This function returns the secondory calling party number, i.e. the network provided number.   IpPbx.SecondaryCallingNumber     This function returns a string value.   The function IpPbx.CallingNumber provides the so called user provided number. This number can either be suppressed or manipulated (via "clip no screening") by the caller.   The network provided number can't be manipulated by the caller. Usual
      • 130 views

    23. IpPbx.UserFreeStatusText

      Last Updated:
      VBScript   → Lua   SwxWare 2011   This property takes or returns the current free status text of the script user.   ' Getting the script users free status text Dim sUserFreeStatusText sUserFreeStatusText = IpPbx.UserFreeStatusText ' Setting the script users free status text IpPbx.UserFreeStatusText = "I am out for lunch"     This property takes or returns a string value.   If being used in a group context (from SwyxWare v13.27) this property return
      • 212 views

    24. IsAway()

      Last Updated:
      VBScript   → Lua   SwxWare 2011   This function returns the current script users' Away status.   If IsAway() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the Away status and place it the block exits:         This function returns a boolean value.   If being used in a group context (from SwyxWare v13.27) this
      • 210 views

    25. IsBusy()

      Last Updated:
      VBScript   → Lua   This function returns the current script users' Busy status.   If IsBusy() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the Busy status and place it the block exits:           This function returns a boolean value.   This function can be called at any time within the call routing script.
      • 150 views

    26. IsDoNotDisturb()

      Last Updated:
      VBScript   → Lua   SwxWare 2011   This function returns the current script users' DoNotDisturb (DND) status.   If IsDoNotDisturb() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the DoNotDisturb status and place it the block exits:           This function returns a boolean value.   If being used in a grou
      • 185 views

    27. IsLoggedIn()

      Last Updated:
      VBScript   → Lua   This function returns the current script users' logged in status.   If IsLoggedIn() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the logged in status and place it the block exits:       This function returns a boolean value.   This function can be called at any time within the call routing script.
      • 135 views

    28. IsOutlookBusy()

      Last Updated:
      VBScript   → Lua   This function returns the current script users' Outlook Busy status.   If IsOutlookBusy() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the Outlook Busy status and place it the block exits:         This function returns a boolean value.   If being used in a group context (from SwyxWare v13.27
      • 173 views

    29. IsOutOfOffice()

      Last Updated:
      VBScript   → Lua   This function returns the current script users' Outlook Out Of Office status.   If IsOutOfOffice() Then ' do something Else ' do something else End If   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the Outlook Out Of Office status and place it the block exits:         This function returns a boolean value.   If being used in a group context (fr
      • 108 views

    30. LastCause()

      Last Updated:
      VBScript   → Lua   The function returns the return value from the latest connect to attempt.   Dim nLastCause nLastCause = LastCause()   This function returns an integer value.   After having used a Connect To block within the call routing script where the result of the connect to attempt was evaluated by the extis of the block it is possible to use this LastCause() function to request that result again.   To evaluate the return values refer to S
      • 208 views

    31. OneWayConferenceSuffix()

      Last Updated:
      VBScript   → Lua   This function returns the suffix to dial when connecting the call to a conference to switch the "one way" conference mode on for this call.   Dim sSuffix sSuffix = OneWayConferenceSuffix()   or if being used directly within a GSE property dialog, e.g. in a Connect To block to connect the call to a conference room in "one way" mode:       This function returns a string value.   The suffix is fixed to the value #ow
      • 108 views

    32. PIN()

      Last Updated:
      VBScript   This function returns the pin which is configured for the current script user to login to his SwyxPhone.   Dim sPhonePIN sPhonePIN = PIN()   This function returns a string value.   If being used in a group context (from SwyxWare v13.27) this function returns an empty string. Read more about user and group context differences here.   This pin is configured within the SwyxWare Administration User Configuration panel.     Atten
      • 164 views

    33. PostDialingDigits()

      Last Updated:
      VBScript   → Lua   This function returns the digits that where dialed by the caller after the current script was already reached.   Dim sPostDialingDigits sPostDialingDigits = PostDialingDigits()     This function returns a string value.   This function must be called before connecting the call to a device by using the Connect To block.   Post dialing digits are the digits the caller has dialed after the user was already unambiguously identi
      • 222 views

    34. RecordLen()

      Last Updated:
      VBScript   → Lua   This functions returns the length in seconds of the last recorded message using the Record Message block of the GSE.   Dim nLength nLength = RecordLen()   or if being used directly within a GSE property dialog, e.g. in a Say Number block to directly announce the length of the last recorded message to the caller:       This function returns a long value.   This function is identical to the Server Script API functi
      • 207 views

    35. VoicemailOriginatorEMailAddress()

      Last Updated:
      VBScript   → Lua   This function returns the email address being configured within the SwyxWare Administration as to be used as "From" address for all voicemails to be sent by the server.   Dim sFrom sFrom = VoicemailOriginatorEMailAddress()   This function returns a string value.   This function is identical to the Server Script API function PBXConfig.VoicemailFromAddress.   If you make use of the Send E-mail block within the GSE to sent your ow
      • 164 views
×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use and have taken note of our Privacy Policy.
We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.

  I accept