XML-RPC API - Trunks management

S
Written by Sergiiy
Updated 11 months ago

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

The application has an extension - TrunkConnections():

createTrunk()

This application is used to create a trunk.

Required parameters:

  • i_account - Id of an account the trunk belongs to. Integer.
  • name - a name of trunk. String.

Optional parameters:

  • description - String.

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 - Id of a trunk to update. Integer.


Optional parameters:

  • Any from createTrunk() except i_account.


Returns:

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

  • XMLRPC fault in case of any error.

deleteTrunk()

This application is used to remove a trunk.

Required parameters:

  • i_trunk - Id of a trunk to delete. Integer. 

 

Returns:

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

  • XMLRPC fault in case of any error.

 

getTrunkInfo()

This application is used to get a trunk detail.

Required parameters:

  • i_trunk - Id of a trunk. Integer.

Returns:

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

  • XMLRPC fault in case of any error.

getTrunksList()

This application is used to list trunks of an account.

Required parameters:

  • i_account - Id of an account the trunks 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.
  • trunks - Array of structures with trunk attributes.

  • XMLRPC fault in case of any error.
Did this answer your question?