Jump to content
  • References

    References

    36 pages in this category

    1. CallDuration()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the duration (in seconds) of the current call.   local 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 a number value.   This function can be called at any time within the call routing script.   The call duration is meassur
      • 244 views

    2. CalledNumber()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   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.   local sCalledNumber = CalledNumber()     This function returns a string value.   This function is identical to the Server Script API function PBXCall.CalledPartyNumber().   There is a Server Scr
      • 202 views

    3. CallID()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the unique call id of the current call.   local nCallID = CallID()     This function returns a number 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
      • 190 views

    4. CallStart()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns date and time when the current call reached the call routing of the user.   local sCallStart = CallStart() -- in "%d.%m.%Y %H:%M:%S" format   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 string value. The date/time is formatted like "%d.%m.%Y %H:%M:%S".  
      • 256 views

    5. CurDate()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current date according to the script user's location.   local sDate = CurDate() -- in "%d.%m.%Y" format   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 string value. The date is formatted like "%d.%m.%Y".   Note: this function is not the same as the
      • 207 views

    6. CurDateTime()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current date and time according to the script user's location.   local sDateTime = CurDateTime() -- in "%d.%m.%Y %H:%M:%S" format   or if being used directly within a GSE property dialog, e.g. in a Say Date block to directly announce the current date and time to the caller:       This function returns a string value. The date and time is formatted like "%d.%m.%Y %H:%M:%S".
      • 232 views

    7. CurDay()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current day (1-31) according to the script user's location.   local nDay = 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 number value.   This function can be called at any time within the call routing script.   The current date wil
      • 221 views

    8. CurDayOfWeek()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current day of the week (1-7) according to the script user's location.   local 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 a number value.   The returned number evaluates to:   1 - Sund
      • 122 views

    9. CurHour()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current hour (01-24) according to the script user's location.   local nHour = 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 number value.   This function can be called at any time within the call routing script.   The current tim
      • 268 views

    10. CurMinute()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current minute (0-59) according to the script user's location.   local nMinute = 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 number value.   This function can be called at any time within the call routing script.   The curr
      • 239 views

    11. CurMonth()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current month (1-12) according to the script user's location.   local nMonth = 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 number value.   This function can be called at any time within the call routing script.   The current
      • 160 views

    12. CurSecond()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current second (0-59) according to the script user's location.   local nSecond = 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 number value.   This function can be called at any time within the call routing script.   The curr
      • 206 views

    13. CurTime()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current time according to the script user's location.   local sTime = CurTime() -- in "%H:%M:%S" format   or if being used directly within a GSE property dialog, e.g. in a Say Date block to directly announce the current time to the caller:       This function returns a string value. The time is formatted like "%H:%M:%S".   Note: this function is not the same as the
      • 331 views

    14. CurYear()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the current year (0-9999) according to the script user's location.   local nYear = 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 number value.   This function can be called at any time within the call rout
      • 239 views

    15. ExternalCall()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns true if the current call is an external call.   if (ExternalCall() == true) then -- do something else -- do something else end   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 calle
      • 230 views

    16. InternalCall()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns true if the current call is an internal call.   if (InternalCall() == true) then -- do something else -- do something else end   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 calle
      • 201 views

    17. IpPbx.Away()

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

    18. IpPbx.CallingName()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function takes or returns the name of the current caller.   -- Retrieving the caller name local sName = IpPbx.CallingName() -- Setting the caller name IpPbx.CallingName("Erika Mustermann")     This function takes or returns a string value.   This function can be used to modify the name being displayed on a client (SwyxIt!, SwyxPhone). It does not modify the caller list entry.   Additionally you ca
      • 219 views

    19. IpPbx.CallingNumber()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function takes or returns the number of the current caller.   -- Retrieving the caller number local sNumber = IpPbx.CallingNumber() -- Setting the caller number IpPbx.CallingNumber("123456789")     This function takes or returns a string value.   This function can be used to modify the number being displayed on a client (SwyxIt!, SwyxPhone). It does not modify the caller list entry.   Additionally
      • 182 views

    20. IpPbx.DoNotDisturb()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function takes or returns the current do not disturb status of the script user.   -- Getting the script users current do not disturb (dnd) state local bDoNotDisturb = IpPbx.DoNotDisturb() -- Setting the script users do not disturb (dnd) state IpPbx.DoNotDisturb(true)     This function takes or returns a boolean value.   If being used in a group context (from SwyxWare v13.27) this function returns false. Rea
      • 202 views

    21. IpPbx.OneWayConference()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function 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 local bOneWayConference = IpPbx.OneWayConference() -- Setting the oneway conference status IpPbx.OneWayConference(true)     This function takes or returns a boolean value.  
      • 185 views

    22. IpPbx.SecondaryCallingNumber()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the secondory calling party number, i.e. the network provided number.   local sSecondaryCallingNumber = 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 ca
      • 124 views

    23. IpPbx.UserFreeStatusText()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function takes or returns the current free status text of the script user.   -- Getting the script users free status text local sUserFreeStatusText = IpPbx.UserFreeStatusText() -- Setting the script users free status text IpPbx.UserFreeStatusText("I am out for lunch")     This function takes or returns a string value.   If being used in a group context (from SwyxWare v13.27) this function returns an empty s
      • 203 views

    24. IsAway()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current script users' Away status.   if (IsAway() == true) then -- do something else -- do something else end   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
      • 212 views

    25. IsBusy()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current script users' Busy status.   if (IsBusy() == true) then -- do something else -- do something else end   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 withi
      • 277 views

    26. IsDoNotDisturb()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current script users' DoNotDisturb (DND) status.   if (IsDoNotDisturb() == true) then -- do something else -- do something else end   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
      • 193 views

    27. IsLoggedIn()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current script users' logged in status.   if (IsLoggedIn() == true) then -- do something else -- do something else end   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
      • 198 views

    28. IsOutlookBusy()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current script users' Outlook Busy status.   if (IsOutlookBusy() == true) then -- do something else -- do something else end   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
      • 204 views

    29. IsOutOfOffice()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the current script users' Outlook Out Of Office status.   if (IsOutOfOffice() == true) then -- do something else -- do something else end   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 bein
      • 198 views

    30. LastCause()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   The function returns the return value from the latest connect to attempt.   local nLastCause = LastCause()   This function returns a number value.   After having used a Connect To block (or Follow Me or Loop) 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.   Possible
      • 239 views

    31. NotLoggedIn()

      Last Updated:
      Lua   SwxWare v13.10   This function returns the current script users' logged off status.   if (NotLoggedIn() == true) then -- do something else -- do something else end   or if being used directly within a GSE property dialog, e.g. in an Evaluate block to directly evaluate the logged off status and place it the block exits:       This function returns a boolean value.   This function can be called at any time within the call rout
      • 190 views

    32. OneWayConferenceSuffix()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   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.   local 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
      • 191 views

    33. PostDialingDigits()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This function returns the digits that where dialed by the caller after the current script was already reached.   local 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 ide
      • 234 views

    34. RecordLen()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   This functions returns the length in seconds of the last recorded message using the Record Message block of the GSE.   local 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 number value.   This function is identical to the Server S
      • 188 views

    35. RIPIN()

      Last Updated:
      Lua   SwxWare v13.10   This functions returns the pin the script user has configured for his remote inquiry.   local sPIN = RIPIN()   or if being used directly within a GSE property dialog, e.g. in an Evalute block to check if the caller has entered a correct pin via DTMF:         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
      • 214 views

    36. VoicemailOriginatorEMailAddress()

      Last Updated:
      Lua   → VBScript   SwxWare v13.10   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.   local sFrom = VoicemailOriginatorEMailAddress()   This function returns a string value.   If you make use of the Send E-mail block within the GSE to sent your own emails from the script and want these emails to have the globally configured voicemail
      • 213 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