SBN Media

• Index

Functions

• API3.exec (apiName, params)
• API3.getMessage (language, company, messageNumber, fallback)

Modules

• alarmqueue
• api3
• config
• device
• installation
• logger
• nats
• sbnivr
• script-control
• script-globals
• search
• signal
• sip
• sms
• tonerecognizer
• tts
• uniqueid
• url

Module api3

Execute SBN API3 calls This uses the SBN Front End service to execute API3 calls, returning results in a LUA friendly format

Functions

API3.exec (apiName, params)

Execute an SBN API3 call

Parameters:

• apiName string The API3 call to execute
• params table A key value map of parameters to pass to the API3 call

Returns:

1. number ReturnCode
2. table | nil Result array of key value maps

API3.getMessage (language, company, messageNumber, fallback)

Get a GUI message from SBN.

Parameters:

• language integer -- The language to use
• company integer -- The company number
• messageNumber integer -- The GUI message number
• fallback string -- Any string that will be returned if the GUI message cannot be retrieved

Returns:

string Result