This applications are used to manage the authentication rules.


Implementation details

This applications support trusted mode in which case the i_customer (integer) parameter should be provided.



addAuthRule()


Mandatory parameters:

  • i_account - unique ID of Account to add Rule to. Integer.
  • i_protocol - protocol ID. Integer. Possible values are:

            1 - SIP

            2 - H.323 (Deprecated starting from Sippy 2020)

            3 - IAX2

            4 - Calling Card PIN


At least one of parameters below should be specified:

  • remote_ip - Caller's IP address. String. Optional.
  • incoming_cli - Caller's number (CLI). String. Optional. 
  • incoming_cld  - Callee's number (CLD). String. Optional. 
  • to_domain - hostname in To header of incoming INVITE. String. Optional. (from Sippy 2020)
  • from_domain - hostname in From header of incoming INVITE. String. Optional. (from Sippy 2020)


Optional parameters:

  • cli_translation_rule - Caller's number (CLI) Translation Rule. String. Optional.
  • cld_translation_rule - Callee's number (CLD) Translation Rule. String. Optional.
  • i_tariff - Unique ID of existing Tariff. Integer. Optional. Null means use tariff from Account's Service Plan (Base Tariff)
  • i_routing_group - Unique ID of existing Routing Group. Integer. Optional. Null means use the Account's routing group
  • max_sessions - Concurrent calls limit for the rule. Integer. Optional. -1 means Unlimited. (from Sippy 2020)
  • max_cps - Call rate limit for the rule. Double. Optional. Null means Unlimited. (from Sippy 2020)


Returns:

  • result - OK means that the operation was successful. String.
  • i_authentication - Integer.

    XMLRPC fault in case of any error.



updateAuthRule()



Mandatory parameters:

  • i_authentication - Integer. Required.
  • i_account - unique ID of Account to add Rule to. Integer. Optional. (removed in >=5.2 version)
  • i_protocol - protocol ID. Integer. Possible values are:

            1 - SIP

            2 - H.323 (Deprecated starting from Sippy 2020)

            3 - IAX2

            4 - Calling Card PIN

  • remote_ip - Caller's IP address. String. Optional.
  • incoming_cli - Caller's number (CLI). String. Optional. 
  • incoming_cld  - Callee's number (CLD). String. Optional. 
  • to_domain - hostname in To header of incoming INVITE. String. Optional. (from Sippy 2020)
  • from_domain - hostname in From header of incoming INVITE. String. Optional. (from Sippy 2020)
  • cli_translation_rule - Caller's number (CLI) Translation Rule. String. Optional.
  • cld_translation_rule - Callee's number (CLD) Translation Rule. String. Optional.
  • i_tariff - Unique ID of existing Tariff. Integer. Optional. Null means use tariff from Account's Service Plan (Base Tariff)
  • i_routing_group - Unique ID of existing Routing Group. Integer. Optional. Null means use the Account's routing group
  • max_sessions - Concurrent calls limit for the rule. Integer. Optional. -1 means Unlimited. (from Sippy 2020)
  • max_cps - Call rate limit for the rule. Double. Optional. Null means Unlimited. (from Sippy 2020)


Returns:

  • result - OK means that the operation was successful. String.

    XMLRPC fault in case of any error.

delAuthRule()


Parameters:

  • i_authentication - Integer. Required.

 

Returns:

  • result - OK means that operation successful. String.


    XMLRPC fault in case of any error.


getAuthRuleInfo()


Available from 4.5.


Parameters:

  • i_authentication - Integer. Required.


Returns:

  • result - OK means that operation successful. String.
  • authrule - structure as described in addAuthRule()

    XMLRPC fault in case of any error.




listAuthRules()


Available from 2.0.


Parameters:

  • i_account - unique ID of Account. Integer.
  • i_authentication - Integer. Optional.
  • i_protocol - protocol ID. Integer. Possible values are:

            1 - SIP

            2 - H.323 (Deprecated starting from Sippy 2020)

            3 - IAX2

            4 - Calling Card PIN

  • remote_ip - Caller's IP address. String. Optional.
  • offset - skip fist offset records. Integer. Optional.
  • limit - return only limit records. Integer. Optional.


Returns:

  • result - OK means that operation successful. String.
  • authrules - array of authrules:
    • i_authentication
    • i_account
    • remote_ip
    • incoming_cli
    • incoming_cld
    • to_domain (from Sippy 2020)
    • from_domain (from Sippy 2020)
    • cli_translation_rule
    • cld_translation_rule


XMLRPC fault in case of any error.