All applications below support trusted mode; i_customer should be supplied in that mode.

The applications can work with both Trunk Connections and Vendor Connections.


Available from Sippy 2025.

Liveness Failure Action and Notify On Status Change settings are independent of Quality Monitoring. They apply to both Trunk Connections and Vendor Connections.


createConnectionCheckOptions()

This application is used to create connection check options for a connection.

Required parameters:

  • i_connection - ID of a connection. Integer.

Optional parameters:

  • sip_options - Enable SIP OPTIONS check. Boolean. Default is false.
  • ping - Enable PING check. Boolean. Default is false.
  • dns - Enable DNS check. Boolean. Default is false.
  • threshold - Number of consecutive failed checks required before a check is marked failed. Integer, from 1 to 2147483647. Default is 1.
  • interval - Check interval in seconds. Integer >0. Default is 60.
  • liveness_action - Failure Action for liveness checks. String. Allowed values: make_last_in_routing, block, notify_only. Default is make_last_in_routing.
  • liveness_notification_enabled - Enable Notify On Status Change email notifications when a check becomes failed or recovers. Boolean. Default is false.

Returns:

  • result - OK - String.

XMLRPC fault in case of any error.


updateConnectionCheckOptions()

This application is used to update connection check options.

Required parameters:

  • i_connection - ID of a connection. Integer.

Optional parameters:

  • Any optional parameter from createConnectionCheckOptions().

Notes:

  • At least one optional parameter must be supplied.
  • Parameters not supplied are left unchanged.

Returns:

  • result - OK - String.

XMLRPC fault in case of any error.


deleteConnectionCheckOptions()

This application is used to remove connection check options.

Required parameters:

  • i_connection - ID of a connection. Integer.

Returns:

  • result - OK - String.

XMLRPC fault in case of any error.


getConnectionCheckOptions()

This application is used to get connection check options.

Required parameters:

  • i_connection - ID of a connection. Integer.

Returns:

  • result - OK - String.
  • i_connection - ID of a connection. Integer.
  • Connection check options as described in createConnectionCheckOptions().

XMLRPC fault in case of any error.