This is the main documentation on DID Pool managing API 
Related documentation for Incoming Routing setup of an account

addDID()


Parameters:

  • did - DID number. String. Required.
  • incoming_did - Incoming DID number. String. Required.
  • translation_rule - Translation rule applied to DID. String. Optional. (since 5.1)
  • cld_translation_rule - CLD translation rule. String. Optional. (removed since 5.1)
  • cli_translation_rule - CLI translation rule. String. Optional.
  • description - custom description. String. Optional.
  • i_ivr_application - IVR application assigned to the DID. Integer. Optional.
  • i_account - account assigned to the DID. Integer. Optional.
  • i_dids_charging_group - Charging group to be used. Integer. Optional.
  • fwd_did - Forward DID number. Boolean. Optional. (removed since 2.2)
  • i_vendor - Vendor to authenticate this DID. Integer. Optional. (since 2.2)
  • i_connection - Connection to authenticate this DID. Integer. Optional. (since 2.2)
  • buying_i_dids_charging_group - Charging group to charge vendor. Integer. Optional. (since 2.2)

Returns:


  • result - OK means that operation successful. String.
  • i_did - Integer. Id of added DID.

  • XMLRPC fault in case of any error.

updateDID()

Either of i_did or did should be specified. At least one of the parameters must be updated.

Parameters:


  • i_did - DID's Id. Integer. Optional.
  • did - DID number. String. Optional.
  • incoming_did - Incoming DID number. String. Optional.
  • translation_rule - Translation rule applied to DID. String. Optional. (since 5.1)
  • cld_translation_rule - CLD translation rule. String. Optional. (removed since 5.1)
  • cli_translation_rule - CLI translation rule. String. Optional.
  • description - custom description. String. Optional.
  • i_ivr_application - IVR application assigned to the DID. Integer. Optional.
  • i_account - account assigned to the DID. Integer. Optional.
  • i_dids_charging_group - Charging group to be used. Integer. Optional.
  • fwd_did - Forward DID number. Boolean. Optional. (removed since 2.2)
  • i_vendor - Vendor to authenticate this DID. Integer. Optional. (since 2.2)
  • i_connection - Connection to authenticate this DID. Integer. Optional. (since 2.2)
  • buying_i_dids_charging_group - Charging group to charge vendor. Integer. Optional. (since 2.2)

Returns:

  • result - OK means that operation successful. String.
  • i_did - Integer. Id of updated DID.

  • XMLRPC fault in case of any error.

deleteDID()

Either of i_did or did should be specified.

Parameters:


  • i_did - DID's Id. Integer. Optional.
  • did - DID number. String. Optional.

Returns:


  • result - OK means that operation successful. String.

  • XMLRPC fault in case of any error.

getDIDInfo()

Either of i_did or did should be specified.

Parameters:


  • i_did - DID's Id. Integer. Optional.
  • did - DID number. String. Optional.

Returns:


  • result - OK means that operation successful. String.
  • i_did - DID's Id. Integer.
  • did - DID number. String.
  • incoming_did - Incoming DID number. String.
  • translation_rule - Translation rule applied to DID. String. (since 5.1)
  • cld_translation_rule - CLD translation rule. String. (removed since 5.1)
  • cli_translation_rule - CLI translation rule. String.
  • description - custom description. String.
  • i_ivr_application - IVR application assigned to the DID. Integer.
  • i_account - account assigned to the DID. Integer.
  • i_dids_charging_group - Charging group to be used. Integer.
  • fwd_did - Forward DID number. Boolean. (removed since 2.2)
  • i_vendor - Vendor to authenticate this DID. Integer. (since 2.2)
  • i_connection - Connection to authenticate this DID. Integer. (since 2.2)
  • buying_i_dids_charging_group - Charging group to charge vendor. Integer. (since 2.2)
  • i_did_delegation - Id of DID delegation. Integer. (since 4.4)
  • delegated_to - Id of the subcustomer the DID is delegated to. Integer. (since 4.4)
  • parent_i_did_delegation - Id of the parent DID delegation entry. Integer. NULL - for the first delegation. (since 4.4)

  • XMLRPC fault in case of any error.

getDIDsList()

Parameters:


  • did - DID number pattern. String. Optional.
  • incoming_did - Incoming DID number pattern. String. Optional.
  • delegated_to - assigned customer (Id of customer the DID is delegated to). Integer. (since 4.4)
  • i_account - assigned account. String. Optional.
  • i_ivr_application - assigned IVR application. Integer. Optional
  • not_assigned - DID is not assigned to any account, customer or IVR application. Boolean. Optional
  • offset - skip first offset rows. Integer. Optional
  • limit - return only limit rows. Integer. Optional

Returns:


  • result - OK means that operation successful. String.
  • dids - array of structures:
    • i_did - DID's Id. Integer.
    • did - DID number. String.
    • incoming_did - Incoming DID number. String.
    • translation_rule - Translation rule applied to DID. String. (since 5.1)
    • cld_translation_rule - CLD translation rule. String. (removed since 5.1)
    • cli_translation_rule - CLI translation rule. String.
    • description - custom description. String.
    • i_ivr_application - IVR application assigned to the DID. Integer.
    • i_account - account assigned to the DID. Integer.
    • i_dids_charging_group - Charging group to be used. Integer.
    • fwd_did - Forward DID number. Boolean. (removed since 2.2)
    • i_vendor - Vendor to authenticate this DID. Integer. (since 2.2)
    • i_connection - Connection to authenticate this DID. Integer. (since 2.2)
    • buying_i_dids_charging_group - Charging group to charge vendor. Integer. (since 2.2)
    • i_did_delegation - Id of DID delegation. Integer. (since 4.4)
    • delegated_to - Id of the subcustomer the DID is delegated to. Integer. (since 4.4)
    • parent_i_did_delegation Id of the parent DID delegation entry. Integer. NULL - for the first delegation. (since 4.4)

getDIDChargingGroupInfo()

Parameters:

  • i_dids_charging_group - Charging group to be used. Integer.

Returns:


  • result - OK means that operation successful. String.
  • i_dids_charging_group - Integer.
  • i_customer - Integer.
  • name - String.
  • description - String.
  • connect_fee - Float.
  • free_seconds - Integer.
  • grace_period - Integer.
  • price_1 - price per one minute. Float.
  • price_n - price per one minute. Float.
  • interval_1 - Integer.
  • interval_n - Integer.
  • iso_4217 - Currency code (ex. 'USD', 'EUR') based on iso-4217. String.
  • price - monthly fee. Float.
  • setup_fee - setup fee. Float.
  • post_call_surcharge - Post Call Surcharge, fractional part. Float. (since 2.2)
  • type - Type of group. Integer. (since 2.2). Possible values:
    • 1 - Selling charging group
    • 2 - Buying charging group




addDIDDelegation()


  Delegate a DID number to a subcustomer.

  Any delegated DID number can be re-delegated to the subcustomer, e.g. Customer A delegates a DID to its subcustomer B, then subcustomer B re-delegates the DID to its subcustomer C, and so on. Number of re-delegations is not limited.


Notes

  This XMLAPI method is available since version 4.4.


Parameters:

  • i_did - Id of the delegated DID. Integer. Required.
  • delegated_to - Id of the subcustomer the DID is delegated to. Integer. Required.
  • parent_i_did_delegation - Id of the parent DID delegation entry. Integer. Required. NULL - for the first delegation.
  • i_dids_charging_group - Charging group to be used. Integer. Optional.
  • description - Description. String. Optional.


Returns:

  • result - OK means that operation successful. String.
  • i_did_delegation - Id of added DID delegation. Integer.


  • XMLRPC fault in case of any error.




updateDIDDelegation()


  Update a DID delegation entry.


Notes

  This XMLAPI method is available since version 4.4.


Parameters:

  • i_did_delegation - Id of DID delegation. Integer. Required.
  • i_dids_charging_group - Charging group to be used. Integer. Optional.
  • delegated_to - Id of the subcustomer the DID is delegated to. Integer. Required.
  • description - Description. String. Optional.


Returns:

  • result - OK means that operation successful. String.
  • i_did_delegation - Id of added DID delegation. Integer.


  • XMLRPC fault in case of any error.




deleteDIDDelegation()


Delete a DID delegation entry.


Notes

This XMLAPI method is available since version 4.4.


Parameters:

  • i_did_delegation - Id of DID delegation. Integer. Required.

Returns:

  • result - OK means that operation successful. String.


  • XMLRPC fault in case of any error.