-
38 pages in this category
-
PBXCall.Activate()
Lua → VBScript SwxWare v13.10 This functions activates a call previously being put on hold. Activating in fact means stop playing the music on hold. local nReturn = PBXCall.Activate() This function returns a PBXResult value of PBXSuccess or PBXFailure. To put a call on hold you can use the PBXCall.Hold() function. All GSE Play Sound blocks as also all "Connect" blocks like Connect To, Follow Me and Loop will automatically - 113 views
-
PBXCall.Alerting()
Lua → VBScript SwxWare v13.10 This function sends an alerting message to the originator of the current call. local nReturn = PBXCall.Alerting() This function returns a PBXResult value of PBXSuccess, PBXFailure or PBXCallTermOriginatorDisconnected. If the current call is already in state Alerting or Connected the function call will be ignored. Common usage of this function is to signal s standard ringing tone will be played - 129 views
-
PBXCall.CalledPartyName()
Lua SwxWare v13.10 This function returns the name of the user that has been called. local sName = PBXCall.CalledPartyName() This function returns a string value. To figure which number has been called you can use the PBXCall.CalledPartyNumber() function. - 229 views
-
PBXCall.CalledPartyNumber()
Lua → VBScript SwxWare v13.10 This function returns the dialed number that has lead 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 sNumber = PBXCall.CalledPartyNumber() This function returns a string value. This function is identical to the GSE build in function CalledNumber(). This function returns the internal - 165 views
-
PBXCall.CalledPartyNumberCanonical()
Lua → VBScript SwxWare v13.10 This function returns called number that has leaded the call to reach the current script. A script is connected to a user who has internal and external numbers. This functions returns the external number. local sNumber = PBXCall.CalledPartyNumberCanonical() This function returns a string value. This function returns the external number of the script user that was called. If you are interested in the inter - 87 views
-
PBXCall.CallId()
Lua → VBScript SwxWare v13.10 This function returns the unique call id the server has reserved for the current call. local nCallId = PBXCall.CallId() This function returns a number value. SwyxServer reserves a unique id for each call within the system. This id will also be stored in the Call Detail Records. Do mot mistake this id with the caller number. Do also not mistake this CallId by the unique call id you - 163 views
-
PBXCall.CallingDeviceName()
Lua → VBScript SwxWare v13.10 This function returns the name of the calling device. local sName = PBXCall.CallingDeviceName() This function returns a string value. If the call is "external", i.e. it comes via a gateway trunk, link trunk or sip trunk, this function returns the name of that trunk as configured in the SwyxWare Administration. If you need to figure the calling device type as well you can use the function PBXCa - 178 views
-
PBXCall.CallingDeviceType()
Lua → VBScript SwxWare v13.10 This function returns the name of the calling device type. local sType = PBXCall.CallingDeviceType() This function returns a string value. This is a list of possible return strings: String Type ------------- ------------------------------------------------------- COMClient SwyxIt! (<v6.1x) Conference Conferunce User MobileApp Swyx Mobile App DesktopApp Swyx macOS De - 106 views
-
PBXCall.CallingPartyName()
Lua → VBScript SwxWare v13.10 This function sets or returns the name of the current caller. -- get the calling party name local sName = PBXCall.CallingPartyName() -- set new calling party name PBXCall.CallingPartyName("Erika Mustermann") This function sets 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. Addi - 193 views
-
PBXCall.CallProceeding()
Lua → VBScript SwxWare v13.10 This function sents a "Call Proceeding" message to the originator of the current call. local nReturn = PBXCall.CallProceeding() This function returns a PBXResult value of PBXSuccess, PBXFailure or PBXCallTermOriginatorDisconnected. If the current call is already in state Proceeding, Alerting or Connected the function call will be ignored. Common usage of this function is to signal call proceed - 169 views
-
PBXCall.CallType()
Lua SwxWare v13.10 This funtion returns the type of the current call. local sType = PBXCall.CallType() This function returns a string value. The returned value can be any of the following: "Normal" "Group" "Direct" "Supervisor" "Notification" "unknown" - 163 views
-
PBXCall.Charges()
Lua → VBScript SwxWare v13.10 This function returns the charges of the current call. local nCharges = PBXCall.Charges() This function returns a number value. The returned number (e.g. 1,73) does not contain any currency information. - 156 views
-
PBXCall.ConnectedName()
Lua → VBScript SwxWare v13.10 This function returns the name of the user a call was connected to right after a Connect To GSE block. local sName = PBXCall.ConnectedName() This function returns a string value. It returns an empty string once the call is disconnected. If you connect a call to a group and need to know which user of this group has taken the call, this property can be requested right after leaving the Connected - 162 views
-
PBXCall.ConnectedNumber()
Lua → VBScript SwxWare v13.10 This function returns the intenal extension of the user a call was connected to right after a Connect To GSE block. local sNumber = PBXCall.ConnectedNumber() This function returns a string value. It returns an empty string once the call was disconnected. If you connect a call to a group and need to know which user of this group has taken the call, this property can be requested right after lea - 128 views
-
PBXCall.DeletePhoneCallListEntry()
Lua SwxWare v13.10 This function deletes the phone call list entry of the current call. local nReturn = PBXCall.DeletePhoneCallListEntry() This function return a PBXResult value of PBXSuccess or PBXFailure. By calling this function you can prevent that an entry in the phone call list will appear for the current call. This comes in handy when creating a blacklist call routing for unwanted calls. - 170 views
-
PBXCall.DialedNumber()
Lua → VBScript SwxWare v13.10 This function returns the dialed number that has leaded the call to reach the current script. It returns *all* digit, not just the first digits to correctly identify the script user but also the so called post dialing digits. local sNumber = PBXCall.DialedNumber() This function returns a string value. There is another function available PBXCall.CalledPartyNumber() which returns just the first digits to co - 131 views
-
PBXCall.Disconnect()
Lua → VBScript SwxWare v13.10 This functions disconnects the current call. local nReturn = PBXCall.Disconnect(nCause) This function returns a PBXResult value of PBXSuccess or PBXFailure. This function can be called before the call is connected to a user (by using e.g. the Connect To block in the GSE) or after the call was connected. Parameter nCause Optional. Default: PBXCallTermNormalCallClearin - 202 views
-
PBXCall.Hold()
Lua → VBScript SwxWare v13.10 This function sets the current call on hold, meaning it starts playing the given music on hold file (wav) and returns. local nReturn = PBXCall.Hold(sMusicOnHold) This function returns a PBXResult value of PBXSuccess or PBXFailure. In opposite to the GSE block Play Message which plays a wav file completely before returning, the hold function/block returns immediately. The one parameter of this - 144 views
-
PBXCall.IsFaxToneDetected()
Lua → VBScript SwxWare v13.10 This function returns true, if a fax tone was detected in the current call. local bFaxTone = PBXCall.FaxToneDetected() This function returns an boolean value. If a fax tone has beend detected the call can then be connected to an extension a fax machine or SwyxFax is connected to. - 199 views
-
PBXCall.IsInternal()
Lua → VBScript SwxWare v13.10 This function returns true if the current call has an SwyxWare internal initiator. if PBXCall.IsInternal() then -- do something end This function returns a boolean value. - 84 views
-
PBXCall.IsOnHold()
Lua → VBScript SwxWare v13.10 This function returns true if the current call is currently on hold. if PBXCall.IsOnHold() then PBXCall.Activate() end This function returns a boolean value. You can use the PBXCall.Hold() function to put a call on hold, and the PBXCall.Activate() function to activate a call again. - 151 views
-
PBXCall.IsOriginatorDisconnected()
Lua → VBScript SwxWare v13.10 This function returns true if the originator of the current call has disconnected it. if PBXCall.IsOriginatorDisconnected() then -- do something end This function returns a boolean value. An example would be to put a call on hold with PBXCall.Hold() and then to wait for an avaible agent within a loop. Don't miss to use the PBXScript.Sleep() function when looping while waiting for something to prevent 100% - 201 views
-
PBXCall.LastRecordedMessage()
Lua → VBScript SwxWare v13.10 This function returns the name (incl. path) of the last recorded message (by the Record Message block). local sFileName = PBXCall.LastRecordedMessage() This function returns a string value. When making use of the Record Message functionality the SwyxServer defines the unique name of the WAV file to take the recording. After a recording this name can be requested from the server i.e. by this property. The - 127 views
-
PBXCall.LastRecordedMessageLength()
Lua → VBScript SwxWare v13.10 This function returns the length of the last recorded message in seconds. local nLength = PBXCall.LastRecordedMessageLength() The property takes or returns a number value. When using either the PBXCall.RecordMessage() function of the Record Message block a wav file is getting recorded. This function returns the length of this recording in seconds. - 193 views
-
PBXCall.OriginalCallingPartyName()
Lua SwxWare v13.10 This function returns the original unmodified calling party name. local sName = PBXCall.OriginalCallingPartyName() This function returns a string value. By using the function PBXCall.CallingPartyName() it is possible to modify the calling party name before a call is connected to a destination. The modified name will then be displayed in the destinations display. The PBXCall.OriginalCallingPartyName() function will a - 69 views
-