This applications are used to manage the post-authentication rules.


Implementation details

This applications support trusted mode in which case the i_customer (integer) parameter should be provided. In Sippy >=2022 wildcard support was added


Available

Since version 2020.

addPostAuthRule()


Mandatory parameters:

  • i_account - unique ID of Account to add Rule to. Integer.


At least one of parameters below should be specified:

  • remote_ip - Caller's IP address. String. Optional.
  • cli - Caller's number (CLI). String. Optional. 
  • cld  - Callee's number (CLD). String. Optional. 


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


Returns:

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

    XMLRPC fault in case of any error.


updatePostAuthRule()



Mandatory parameters:

  • i_post_auth_rule - Integer. Required.

Optional parameters:

  • remote_ip - Caller's IP address. String. Optional.
  • cli - Caller's number (CLI). String. Optional. 
  • cld  - Callee's number (CLD). String. Optional. 
  • 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


Returns:

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

    XMLRPC fault in case of any error.

deletePostAuthRule()


Parameters:

  • i_post_auth_rule - Integer. Required.

 

Returns:

  • result - OK means that operation successful. String.


    XMLRPC fault in case of any error.

getPostAuthRuleInfo()


Parameters:

  • i_post_auth_rule - Integer. Required.


Returns:

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

    XMLRPC fault in case of any error.



listPostAuthRules()


Parameters:

  • i_account - unique ID of Account. Integer. Required.
  • remote_ip - Caller's IP address. String. Optional.
  • offset - skip first offset records. Integer. Optional.
  • limit - return only limit records. Integer. Optional.


Returns:

  • result - OK means that operation successful. String.
  • post_auth_rules - array of authrules:
    • i_post_auth_rule
    • remote_ip
    • cli
    • cld
    • cli_translation_rule
    • cld_translation_rule
    • i_tariff
    • i_routing_group


 XMLRPC fault in case of any error.