Available since version SoftSwitch 2022 and FreightSwitch 2022.


All applications bellow support trusted mode, i_customer should be supplied in that mode.


The application has a parent structure element - Trunks():

https://support.sippysoft.com/a/solutions/articles/3000116551

createTrunkConnection()


This application is used to create a trunk connection.


Required parameters:

  • i_trunk - Id of a trunk the connection belongs to. Integer.
  • name - a name of the trunk connection. String.
  • destination - destination IP or hostname. String.


Optional parameters:

  • order_no - order no. Default is 'last'. Possible values:
    • # - set order no to #. Integer
    • first - make the connection the first entry in order. String
    • last - make the connection the last entry in order. String.
  • username - username used on the connection. String.
  • password - password used on the connection. String.
  • outbound_ip - outbound IP-address used on the connection. Possible values:
    • IP address - set to IP address. String.
    • null - set to Auto.
  • outbound_cld - outbound CLD used on the connections. String.
  • i_proto_transport - 'protocol' used on the trunk connections. Integer. Available Options: SIP/TCP, SIP/UDP, see getSystemDictionary(protocols). Available starting from 2023 version.
  • i_privacy_mode - Integer. See getSystemDictionary(privacy_modes). From 2023 version
  • trusted_privacy_domain - Controls if Privacy Id is sent to a vendor. Boolean. Default is True. From 2023 version
  • use_priv_id_as_cli - Use Privacy Id as CLI. Boolean. From 2023 version
  • use_asserted_id - Use CLI as Privacy ID. Boolean. From 2023 version
  • asserted_id_translation - Privacy translation rule. String. From 2023 version
  • enable_diversion - allows Diversion header. Boolean. From 2022 version
  • huntstop_scodes - comma-separated list (without spaces) of SIP "final negative response" codes (e.g: 486,503,501). String. From 2024 version
  • blocked - Indicates whether the trunk connection is currently blocked (disabled). Boolean. When set to true, no traffic will be sent through this connection. Default is false. From 2024 version


Shared (among all the connections belonged to one trunk) parameters:

  • capacity - capacity applied on the connections. Possible values:
    • # - set capacity to #. Integer.
    • null - unlimited capacity.

  • max_cps - CPS applied on the connections. Possible values:

    • # - set CPS to #. Double.

    • null - unlimited CPS.

  • from_domain - 'From Domain' used on the connections. String.

  • random_call_id - 'Random Call-Id'  used on the connections. Boolean.


Returns:

  • result - OK - String.
  • i_trunk_connection - Id of the newly created trunk connection. Integer.


  • XMLRPC fault in case of any error.

updateTrunkConnection()


This application is used to update a trunk connection.


Required parameters:

  • i_trunk_connection - Id of the trunk connection to update. Integer.


Optional parameters:

  • Any from createTrunkConnection() except i_trunk.
  • order_no - 2 additional values are available:
    • up - increase the order no by 1. String.
    • down - decrease the order no by 1. String.


Returns:

  • result - OK - String.
  • i_trunk_connection - Id of the updated trunk connection. Integer.


  • XMLRPC fault in case of any error.

deleteTrunkConnection()


This application is used to remove a trunk connection.


Required parameters:

  • i_trunk_connection - Id of the trunk connection to delete. Integer. 


Returns:

  • result - OK - String.
  • i_trunk_connection - Id of the deleted trunk connection. Integer.


  • XMLRPC fault in case of any error.


getTrunkConnectionInfo()


This application is used to get a trunk connection detail.


Required parameters:

  • either i_trunk_connection or i_connection


Optional parameters:

  • i_trunk_connection - Id of the trunk connection. Integer.
  • i_connection - Id of the underlying connection. Integer.


Returns:

  • result - OK - String.
  • trunk_connection - Structure with trunk connection attributes.


  • XMLRPC fault in case of any error.


getTrunkConnectionsList()


This application is used to list trunk connectionss of a trunk.


Required parameters:

  • i_trunk - Id of a trunk the connections belong to. Integer.


Optional parameters:

  • name_pattern - Pattern to filter trunks by name (SQL syntax for the ILIKE operator is used). String.


Returns:

  • result - OK - String.
  • trunk_connections - Array of structures with trunk connection attributes.


  • XMLRPC fault in case of any error.