24U Phone Companion 3.0 Syntax

Specification revision: 6, 2018-07-03.

Created by: Lukáš Liebzeit, Martin Vraný, Zdenek Hejl, ©2018 24U Software.

1. 24U Phone Companion 3.0 Syntax

Phone_Version( { versionFormat } )

Returns version string of the active 24U PhoneCompanion Plug-In, formatted as requested by the parameter.

Parameters

Parameter values for versionFormat

Description

This function is very important and it has the same output format in all 24U Plug-Ins. You should call this function every time you need to check if the plug-in is properly installed to the FileMaker. Even if the plug-in is not registered (or badly registered) this function should work. Calling this function in the startup script of your solution is recommended.

Result

Returns requested version format or platform. If this function returns "?", then the plug-in is not properly installed or FileMaker cannot load and activate it for some reason.

Examples

Phone_Version( "long" )
This will return the plug-in name and its version. In this case it is 24U PhoneCompanion Plug-In 3.0

Phone_Version( "platform" )
Returns "Mac OS X" , because no other platform is allowed.

Phone_Version( "autoupdate" )
Returns 03000000 for version 3.0.0 of the plug-in.

Phone_Register ( selector )

Provides special functionality to operate with plugin serial numbers.

Parameters

Parameter values for selector

Description

Use this function to register or unregister 24U PhoneCompanion Plug-In, to get information about current registration state, or to invoke GUI providing basic registration information and purchase capabilities.

Result

Returns zero or error code depending on the selector.

Examples

Phone_Register( "address@example.com" )
This will send on email address@example.com confirmation, if you confirm than you will get trial version on this product verified by this email. Note: In case of trial version only few steps can be processed.

Phone_Register( "PHC30C050-ABCD-1234-QWER-ASDF" )
This will register this product. Registration will allow you use all features of this product.

Phone_Register( "Unregister" )
This will remove all registration of this product.

Phone_Connect( "serverIP" ; "serverPort" { ; "timeout" } )

Connect to STLI server.

Parameters

Description

Call this function establish TCP connection to STLI server. This server is needed to control the line. All phone functions will work only if the plug-in is properly connected.

Result

Function returns 0 in case of success or one of the error codes.

Examples

Phone_Connect( "10.0.0.2" ; 26535 )
The plug-in will attempt to connect to server with IP 10.0.0.2 on port 26535.

Phone_Connect( "132.65.28.17" ; 25001 ; 9.5 )
The plug-in will attempt to connect to server with IP 132.65.28.17 on port 25001 with 9.5 seconds timeout.

Phone_Disconnect

Disconnect from STLI server.

Description

This function will cause that TCP connection to STLI server will be terminated. Use this function when you no longer need phone services.

Result

Function returns 0 if the connection was terminated. It returns 0 even if there was no previous connection. Error code is returned when the connection was not terminated in the standard way (abnormal termination).

Examples

Phone_Disconnect
Function has no parameters. This will always terminate the connection and return status code.

Phone_Dial ( localDevice ; calledDirectoryNumber )

Dials a specified telephone number on the specified calling device.

Parameters

Description

This function will dial the number on the local phone. The format should be FileMaker text. It can contain all numbers, "*", "#" and "+".

Result

Function returns 0 if the number was successfully dialed. It doesn't matter if the other side accepted the call or not. If some error occurred (line is not ready, server is not ready, line was forcefully disconnected or similar) the status number is returned.

Examples

Phone_Dial( "11" ; "17" )
This will dial the number 17 on the device with number 11.

Phone_Dial( "103" ; "05555925" )
You can use any number for outside calls. This will dial 05555925 number on the device with local number 103.

Phone_Answer ( localDevice )

Answers (off-hook) an incoming call.

Parameters

Description

The called local device should be able to accept incoming call. It should be either speakerphone or headset equipped phone. The local device should be monitored for incoming calls. Use Phone_SetScriptEvent function to monitor incoming calls.

Result

Function returns 0 if the call was successfully accepted. It the device cannot accept call or another problem occurred than the status code is returned.

Examples

Phone_Answer( "19" )
This will accept the call on the local device with number 19.

Phone_HangUp ( localDevice )

Hang up a call.

Parameters

Description

This function will hang up a call on the local phone. The call should be properly established and local device should be monitored with some event. Use Phone_SetScriptEvent to start monitoring events.

Result

Function returns 0 if the phone was properly hanged up. In case of error the function returns negative error code.

Examples

Phone_HangUp( "19" )
This will hang up a call on the phone with number 19.

Phone_RawCommand ( commandString )

Sends a raw command to the server.

Parameters

Description

This function can be used to send low level commands directly to the server.

Result

Function returns 0 if the command was successfully sent. It doesn't matter if the other side accepted the command. Note: This function does not wait for response. Use Phone_SetScriptRawEvent in conjunction with raw commands to catch server responses

Examples

TeamCall and TeamCall Express:
Phone_RawCommand( "HoldCall 199348" )
Send command "HoldCall" with number 199348 to the server. Do not wait for reply. What the server will do is undefined.

Phone Companion Server:
Phone_RawCommand( "{\"method\" : \"GET\", \"resource\" : \"/restapi?name=24u\"}" )
Send HTTP request directly to the provider. Phone Companion Server returns 24U STLI success message in case of 200 OK response family at the provider. And error message in all other scenarios.

Phone_SetScriptEvent ( localDevice ; event ; scriptName )

Tell the plug-in to launch the script when specified event is triggered from outside.

Parameters

Parameter values for event

Description

The function will call the specified script when the event of the specified type occurs. The script will receive a parameter which contains the number of controlled phone on the first line and the phone number of the second side on the second line.

To remove event for some number call Phone_SetScriptEvent( localDevice ; event ; "" ).
To remove all events for some number call Phone_SetScriptEvent( localDevice ; "" ; "" ).
To remove all events for all numbers call Phone_SetScriptEvent( "" ; "" ; "" )

Result

Function returns 0 if event is successfully installed or uninstalled. In case of error the function returns negative error code.

Note

Each triggered script from plug-in receives script parameter which can be read by Phone_Get( ScriptParameter ) script step. The parameter consists of several lines of text. See the notes below to learn what each line of script parameter means (parameters are sorted from the first line) :

Parameters passed to the "onIncomingCall" handler

Parameters passed to the "onAnswerCall" handler

Parameters passed to the "onHangUp" handler

Parameters passed to the "onCalling" handler

Examples

Phone_SetScriptEvent( "19" ; "onAnswerCall" ; "Save answered call" )
This will install the script named "Save answered call" for the local device with number 19.

Phone_SetScriptEvent( "105" ; "onCalling" ; "Show announcement" )
The script "Show announcement" will be called every time the user makes a call from the phone with number 105.

Phone_SetScriptRawEvent ( pattern ; scriptName )

Tell the plug-in to launch the script when it receives a message which corresponds to regular expression.

Parameters

Description

This function is similar to Phone_SetScriptEvent. It does not recognize the meaning of events. It just filters them using regular expressions and triggers the script on match. It is recommended to always use some kind of filter. Using this function without filter can slowdown FileMaker application.

To remove triggers with some script name call Phone_SetScriptRawEvent( "" ; scriptName ).
To remove all triggers use Phone_SetScriptRawEvent( "" ; "" ).

Result

Function returns 0 if script trigger is successfully installed or uninstalled. In case of error the function returns negative error code.

Note

Each triggered script from plug-in receives script parameter which can be read by Get( ScriptParameter )script step. The parameter contains the message which triggered the script. The message is read into the FileMaker using UTF-8 encoding.

Examples

Phone_SetScriptRawEvent( "^[Ff]ailed .*" ; "Handle Failed Call" )
Call the script "Handle Failed Call" when incoming message contains word Failed or failed on the start.

Phone_SetScriptRawEvent( "^[Dd]evice[Ii]nformation 34 .*" ; "Read Phone Information" )
The script "Read Phone Information" will be called every time something happens on phone with number 34.

Phone_SetScriptRawEvent( "" ; "Read Phone Information" )
The script "Read Phone Information" will not be triggered in the future. It will be removed from all pattern queues.

Phone_SetScriptRawEvent( "^[Ff]ailed .*" ; "" )
All scripts triggered by "^[Ff]ailed .*" regular expression will be removed from the queue. No such script will be called in the future.

Phone_Get ( what )

Function to get plug-in or phone server settings and other useful data.

Parameters

Parameter values for what

Description

Use this function to get important parameters.

Result

Function returns data if everything is OK. In case of error, the function returns "?". Use Phone_Get with parameter "lastError" to obtain the error code.

Examples

Phone_Get( "lastError" )
Returns last function error code or 0 if last function was performed properly.

Phone_Set ( what ; newValue )

Set plug-in or phone server settings and other useful parameters.

Parameters

Parameter values for what

Description

Use this function to set important parameters. Default communication delays and timeouts are set to work on local area networks. You can set longer values on slower networks (slow wireless networks) but the plug-in reactions will be also slower. Try to keep serverCommunicationDelay parameter as low as possible. Setting it too high (>1s) will essentially delay plug-in responses and probably will not help on broken link.

Result

Function returns the real value of parameter if everything is OK. In case of error the function returns "?". Use Phone_Get with parameter "lastError" to obtain the error code.

Examples

Phone_Set( "serverResponseTimeout" ; 4.5 )
he plug-in will wait for each answer from TeamCall up to 4.5 seconds. This also means that FileMaker will frozen for 4.5 seconds if TeamCall does not respond - do not set it too high.

3. Error Codes Table

Here is the list of all error codes which can be returned by the plug-in. The error codes are derived from MacErrors.h header file from Mac OS. Plug-in's custom error codes are positive numbers in the range between 2400 and 9999. If function fails it either returns "?" signaling an error or it returns the error code directly. If it returns "?" you can use Phone_Get( "lastError" ) to obtain the code.