This applications are used to manage the authentication rules.


Implementation details

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



addAuthRule()


Parameters:

  • i_account - Integer. Required.
  • i_protocol - Integer. Required. Possible values are:

            1 - SIP,

            2 - H.323,

            3 - IAX2,

            4 - Calling Card PIN

  • remote_ip, incoming_cli, incoming_cld - optional string parameters. At least one of these parameters must be specified.
  • cli_translation_rule - String. Optional.
  • cld_translation_rule - String. Optional.
  • i_tariff - Integer. Optional. Null means use account's tariff
  • i_routing_group - Integer. Optional. Null means use account's routing group


Returns:

    result - OK means that operation successful. String.
    i_authentication - Integer.

    XMLRPC fault in case of any error.


updateAuthRule()


Parameters:

  • i_authentication - Integer. Required.
  • i_account - Integer. Optional. (removed in >=5.2 version)
  • i_protocol - Integer. Optional. Possible values are:

            1 - SIP,

            2 - H.323,

            3 - IAX2,

            4 - Calling Card PIN

  • remote_ip - String. Optional.
  • incoming_cli - String. Optional.
  • incoming_cld - String. Optional.
  • cli_translation_rule - String. Optional.
  • cld_translation_rule - String. Optional.
  • i_tariff - Integer. Optional. Null means use account's tariff
  • i_routing_group - Integer. Optional. Null means use account's routing group


Returns:

    result - OK means that operation 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 since in 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 since in 2.0.


Parameters:

  • i_account - Integer. Optional.
  • i_authentication - Integer. Optional.
  • i_protocol - Integer. Optional.
  • remote_ip - 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
  • cli_translation_rule
  • cld_translation_rule


 
XMLRPC fault in case of any error.