XML-RPC API - Account Incoming Routing management



updateIncomingRoute()


This application is used to update an Incoming Routing entry configured for an account.


Implementation details:

  • This function supports trusted mode in which case i_customer (integer) parameter should be supplied


Parameters:

  • i_incoming_route - incoming route Id. Integer. Required.
  • i_trunk - i_trunk where to route the call. Integer. Optional. Possible values:
    • null means 'Registered Account'
  • i_forward_did_mode - Forward DID number. Integer. Optional. Possible values:
  • self_managed - whether account can manage this incoming route. Boolean. Optional.

Returns:

  • result - OK means that operation successful. String.
  • XMLRPC fault in case of any error.


getIncomingRoutesList()

This application is used to get list of incoming routes configured for an account.


Implementation details:

  • This function supports trusted mode in which case i_customer (integer) parameter should be supplied


Parameters:

  • i_account - assigned account. String. Required.
  • i_did - did id. Integer. Optional. (since 2023)
  • offset - skip first offset rows. Integer. Optional. Default is 0.
  • limit - return only limit rows. Integer. Optional. Default is 50.

Returns:

  • result - OK means that operation successful. String.
  • incoming_routes- array of structures:
    • i_incoming_route - incoming route Id. Integer.
    • i_did - i_did of DID where the call came from. Integer. Possible values:
      • null means 'On-Net Calls'
    • did - DID number. String.
    • i_trunk - i_trunk where to route the call. Integer. Possible values:
      • null means 'Registered Account'
    • trunk_name - trunk name. String.
    • i_forward_did_mode - Forward DID number. Integer.
    • self_managed - whether account can manage this incoming route. Boolean.
  • pagination - pagination metadata:
    • page - the current page number (1-based). Integer.
    • items_per_page - the requested limit (or the total when no limit is given). Integer.
    • total_items - the total number of plans that match the parameter filters, ignoring limit/offset. Integer.
  • XMLRPC fault in case of any error.