Available since version 2020.

For versions from 2022 please follow this documentation:

XML-RPC API - Trunks management (versions from 2022) 


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

createTrunk()


This application is used to create a trunk.


Required parameters:
  • i_account - Integer.
  • name - String.
  • destination - String.


Optional parameters:

  • description - String.
  • username - String.
  • password - String.
  • destination_backup - String or Null.
  • username_backup - String.
  • password_backup - String.
  • translation_rule - CLD translation rule. String.
  • capacity - Integer or Null.
  • outbound_ip - String.
  • outbound_ip_backup. String or Null.

  • max_cps - Double or Null.

  • from_domain - String.

  • random_call_id - Boolean.


Returns:

  • result - OK - String.
  • i_trunk - ID of the newly created trunk. Integer.
  • XMLRPC fault in case of any error.

updateTrunk()


This application is used to update a trunk.


Required parameters:

  • i_trunk - Integer. Required.

Optional parameters:
  • Any from createTrunk() except i_account.

Returns:
  • result - OK - String.
  • XMLRPC fault in case of any error.

deleteTrunk()


This application is used to remove a trunk.


Required parameters:

  • i_trunk - Integer. Required.


Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.

getTrunkInfo()


This application is used to get a trunk detail.


Parameters:
  • i_trunk - Id of trunk. Integer. Required.


Returns:
  • result - OK - String.
  • trunk - Structure with trunk's attributes.
  • XMLRPC fault in case of any error.


getTrunksList()


This application is used to list trunks of an account.


Parameters:
  • i_account - Integer. Required.
  • name_pattern - Pattern to filter trunks by name (SQL syntax for the LIKE operator is used). String. Optional.

Returns:
  • result - OK - String.
  • trunks - Array of dictionaries.
  • XMLRPC fault in case of any error.