Setting up an ANI Callback



General Configuration of Callback Services

Configure Access from PSTN

Configure an IVR Application

Customize Parameters of the IVR Application

Create a Tariff for End Users

Enter Rates

Create a Product

Create a Customer

Create ANI Account



This chapter demonstrates how to set up an ANI callback. An ANI callback is the type of callback during which a user is authenticated by the number he calls from. The account is associated with this phone number and registered in PortaBilling®, therefore when a user establishes a callback, he is not asked to enter a PIN to make outgoing calls.


Consider the following example:

A user from France wants to call his friend who is in China. A regular phone call to China using the PSTN is too expensive so the user dials an ITSP’s callback access number instead. The call is dropped and a callback is initiated by the PortaSIP® Media Server. The user picks up the phone, enters the Chinese number following the IVR prompts, and is connected to his friend using VoIP.


Print the following page and use it to mark the operations you have completed while performing the system setup according to the instructions in this chapter. Please make sure that you perform all of the operations in the order designated (all of the boxes should be checked), otherwise the service will not work.




General Configuration


Perform the general configuration of callback services

[     ]

Rating configuration (Vendor)


Configure the vendor that provides the IVR access number

[     ]

Configure a “Calls from Vendor via SIP” connection to the vendor that provides the IVR

[     ]

IVR Application configuration


Set up the Callback calling application and associate an access number with it

[     ]

Configure the parameters of the Callback calling application

[     ]

Rating configuration (Customer)


Create a tariff B, which will be applied to callback users

[     ]

Insert rates in tariff B for the destinations to which the callback will be initiated (legA,) and to which your customers will make outgoing calls (legB)

[     ]

Create your callback product

[     ]

Include a rating entry in the callback product’s rating list that will contain your PortaSIP® node and tariff B containing the callback calling rates

[     ]

Account provisioning


Create a retail customer

[     ]

Create an ANI account for this customer

[     ]

General Configuration of Callback Services

Follow the steps described in the Setting up Callback Services. General Configuration handbook that describes the initial instructions for configuring callback services.

Configure Access from PSTN

Since the main purpose of this service is to give your customers access to your callback application from PSTN (by dialing your access number from their landline or mobile phone), you have to ensure that calls to that access number are correctly delivered to your network and then passed on to the PortaSIP® Media Server.


Please refer to the instructions in the Incoming Calls from PSTN section for complete details about how to set up a vendor and connections.

Configure an IVR Application

You need to define which IVR application launches when an end user dials the access number for callback services.

1.    In the  Routing section of the Admin interface, choose IVR Applications.

2.     Click the Add button.

3.     In the Name field, enter a name for the IVR application. In the Application Type list, select Callback calling.

4.     Click save_add Save icon on the left side of the row.


Create an IVR application


5.     Click on the application’s name to further configure this IVR application.


Select the application


6.     To add the access number, click the Add button.

7.     In the Access Number field, enter your callback calling access number.

8.     Click save Save.


Add access number


timesaver You can associate multiple access numbers using the Quick Upload tool:

1.     Click the Quick Upload button and type in or paste the list of access numbers.

2.     When you are done, click Next and then Upload.


Uppload access numbers



Customize Parameters of the IVR Application

You may further customize the parameters that affect the IVR flow and enable features of your callback application.


Customize the IVR parameters


1.     Click on the access number to get access to the parameters of the callback application.

2.     Select the IVR Settings tab.

3.     Set up required parameters:

o   Authenticate By – Select ani for ANI callback.

o   ANI Translation Rule – Specify a translation rule to be used for transforming the calling numbers to the E.164 format, if necessary. This field contains a regular expression. Please refer to the PortaBilling® Help for more details and examples on composing regular expressions.

o   Languages – Specify the languages in which end users will hear the IVR prompts.

o   Brand Prompts – Specify the folder name with your custom IVR prompts. These prompts will be used instead of the default ones. Please refer to the How to section for a detailed description of how to upload and use custom IVR prompts.

o   Special Charge if LegB Fails – When this check box is selected, a special tariff will be used to charge the legA part of the call if a call to a legB destination number cannot be established (e.g. the destination number is busy or not answering).


During ANI authentication, the voice application authenticates the customer’s phone number (so that the customer will not have to enter a PIN).

In order to prevent confusion and clearly distinguish between accounts used for residential SIP services and for callback services, it is recommended that a naming convention be used. One good example of a naming convention is to use the prefix “cb” for your callback accounts. A corresponding translation rule (e.g. s/^/cb/) will add the prefix “cb” to the calling number and the ANI authenticated account will be the one initiating the callback call that will be charged once the call is completed.


Please refer to the APPENDIX A.  Configuration Parameters for IVR Applications section of the PortaSIP® Media Applications Guide to read more about the callback calling IVR configuration parameters.

NOTE: There is a helpful tool-tip for each option. Just point your mouse to the desired option to bring it up.

4.     Click save_close Save & Close.

Create a Tariff for End Users

At this step it is necessary to create a tariff that your customers will be charged for using the callback services.

A callback call consists of two parts (call legs): a call to the calling party (legA) and a call to the destination number (legB), therefore this tariff will be used to create charges for both call legs. The total charge for the whole callback call is the sum of charges for call legA and call legB.


Create a tariff for end users


Fill in the tariff information


1.     In the Rating section of the Admin-Index page, choose Tariffs.

2.     On the Tariff Management page, choose Add.

3.     Fill in the Add Tariff form:

o   Name – A short name for the tariff object; this is the name you will see in the select menus.

o   Currency – Indicates the currency in which you charge your customers.

NOTE: The currency for the tariff can only be chosen once; it cannot be changed later.

o   Applied To – Choose “Customer,” as this tariff will be used to charge your customers.

o   Managed By – Choose Administrator only here.

o   Service – Choose Voice Calls.


4.     Click save_close Save & Close.

NOTE: You can charge separately for call legs. Please refer to the How to section for a detailed description of the necessary steps for setting that up.

Enter Rates

Since a callback call consists of two call legs, rates for both destination call legs need to be entered into the tariff.




Specify rating parameters


Check the rated added


1.     On the Edit Rates screen, click Add.

2.     Fill in the required information:

o   Destination – A destination prefix may be entered directly (e.g. 33 for France) or you can access the destinations directory by clicking the Destination link (in the column header). Here you will find all prefixes listed by country name.

NOTE: You should create an entry for the phone prefixes in the Destination register before creating a rate for them in the tariff.

o   Interval First – First billing unit in seconds.

o   Interval Next – Next billing unit in seconds.

o   Price First – Per minute price for first interval.

o   Price Next – Per minute price for next interval.

3.     Click the save Save button in the toolbar, or the save_add icon on the left side of the row.

4.     Repeat these steps if you need to enter more rates.

Create a Product

Accounts for accessing callback services will have a specific product assigned to them. Products are powerful tools that define different ways for billing accounts. Product definition is always done using these steps: product type definition, service definition and configuration and creation of a rating list.


Create a product


Fill in the product information


In the Rating section of the Admin-Index page, choose Products.

1.     On the Product Management page, click the Add icon.

2.     Fill in the “New Product” form:

o   Product Name – Type in the internal name of the product.

o   Product Name Visible to End User – Specify the name of the product that your customers will see on their self-care interface.

o   Account Role – Select Universal from the list.

o   Currency – Specify the product currency; only tariffs which have the same currency will be permitted in the rating list.

o   Product Type – Choose Main Product here.

Included Services tab

o   Service Type – Select the Voice Calls check box.

Usage Charges tab

The rating list on the Usage Charges tab has two functions: it defines permitted access points (nodes and access numbers) and specifies which tariff should be used for billing each of these points.


Add usage charges for access number


1.     Click Add to add a new rating entry.

2.     Fill in the required information:

o   Node – Select the PortaSIP® node.

o   Access Code – Type the access number (e.g. 18882325698) assigned to the callback IVR application.

o   Service – Choose Voice Calls.

o   Tariff – Select the tariff that will be used to calculate the charges for callback calls.

o   Click Update.


Add usage charges for failed calls


3.     Click Add to enter another rating entry. This rating entry will define what tariff should be selected if one of the call legs fails to be established (e.g. the destination number is busy or not answering).

4.     Fill in the required information:

o   Node – Select the PortaSIP® node.

o   Access Code – Type in the CALLBACK_FAIL access code here.

o   Service – Choose Voice Calls.

o   Tariff – Select the callback tariff for unsuccessful calls.

NOTE: You can use a special tariff for this rating entry (e.g. if you do not charge your customers for unsuccessful calls to destination numbers, create a separate tariff and enter a rate of zero for a “|” wildcard destination in it). Find the description of the tariff creation and rates enter in the sections above.

5.     Click Update.

Additional Info tab

o   Breakage – Specify the minimum amount of funds the account must have for using these services.

o   Description Visible to End User – Provide a product description to be shown to end users on their self-care interfaces.

o   Description – Your internal comments about the intended use of this product.

o   Click Next.

Notepad tab

Here you may leave your notes about this product. Insert a timestamp (the current time in your time zone) by clicking Time Stamp.


6.     Click Done.

Create a Customer

A customer owns their accounts. The customer’s contact information is used to distribute account usage information, call statistics, invoices, etc.


Create a customer


Add a customer information


1.     In the Participants section of Admin-Index, choose Customers.

2.     On the Customer Management page, click Add Customer (we assume you are creating the customer manually, so choose Manually from the list and do not use any of the Quick Form options). Your customers would usually be retail customers.

3.     Fill in the New Customer form. Please note that there are several tabs containing extra information on the screen. The most important fields are:

Main form (top)

o   Customer ID – Short name for the customer object; will be used on the web interface.

o   Customer Class – Customer class allows you to define a policy for automated payment collection. By choosing a specific class here the customer will automatically inherit all of the class properties (grace period, invoice template, etc.). Choose Default customer class, if no specific parameters are to be applied to this customer.

o   Balance Control – Choose Postpaid from the list.

o   Currency – The currency in which this customer will be charged.

o   Permanent Credit Limit – Specify the credit limit value for this customer.

Address Info tab

o   Email – Email address for distribution of accounting information. After the billing period is over, a list of xDRs and other statistics will be sent to this address.

o   Bcc – Here specify your account representative’s email address. The system automatically delivers a copy of all outgoing emails sent to the customer to this email address; this may be used for debugging and archiving purposes.

Web Self-Care tab

o   Login – Specify the login used to access the customer self-care interface.

o   Password – Specify the password used to access the customer self-care interface.

o   Time Zone – The time zone for the customer self-care interface.

o   Web Interface Language – Language to be used on the customer self-care web interface.

Life Cycle tab

o   Billing Time Zone – Time zone in which customer’s billing period will be closed and invoices will be generated.

o   Billing Period – Frequency of invoice generation. For more details about the different available billing periods, see the PortaBilling Administrator Guide.

o   Last Day of the Period – Read-only field available only during customer creation; shows the last date of the customer’s first billing period.

o   Invoiced on – Read-only field available only during customer creation; shows the date when customer’s invoice will be generated.

Balance & Credits tab

o   Credit Limit Warning Threshold – The customer can be notified by email when his balance is dangerously close to the credit limit when service will be blocked. Here you can enter the value for the warning threshold. This can be entered:

-      as a percentage (e.g. 90%). The warning will be sent when the customer’s balance exceeds that percentage of his credit limit. So if the credit limit is USD 1000.00 and the threshold is 90%, a warning will be sent as soon as the balance exceeds USD 900.00. This is only applicable when the customer has a positive credit limit.

-      as an absolute value. The warning will be sent as soon as the balance goes above the specified value.


4.     Click save_close Save & Close.

Create ANI Account

1.     Go to the Customers screen (the one containing the list of customers). It should resemble the screenshot below.


Create ANI account


2.     Next to the customer name, click on the accounts icon (the one in the Accounts column) to go to account management for that customer.

3.     Click on the Add icon.


Add an account


Add the account information


4.     Fill in the “Add account” form:

o   Account Role – Select the type of the account. Select Universal from the list

o   Main Product – Choose the main product, which you would like your account to have.

o   Account ID – Type in the end user’s ANI number with a cb prefix to distinguish it from accounts used for the basic SIP service (e.g. cb33602784052).

o   Blocked – You may create your account as blocked, although this is rarely done with SIP service accounts.

Account Info tab

o   Type – Account type; select credit for postpaid and debit for prepaid service.

o   Balance Control – Choose the way the balance of the account is controlled. Subordinate – The balance will directly depend on the customer; Individual Credit Limit – This account may have its own balance and credit limit (the customer credit limit still applies).

o   Service Password – Specify the service password for this account. It is very important to assign a secure (difficult to guess) password to prevent the account from being wrongfully entered and used to inject fraudulent calls to your network.

o   Email – Enter the account owner’s email address here. If he ever forgets his password for the web self-care pages, he will be able to reset it, and a new password will be sent to this email address. You can also just leave this field empty.

Products tab

o   Main Product – Choose the product you have just created for callback services.

Web Self-care tab

o   Login – Provide the account login to web self-care pages. Can be the same as account ID.

o   Password – Type in the password for the web self-care pages.

o   Time Zone – The time zone for the account self-care interface.

o   Web Interface Language – The language to be used on the account self-care web interface.

Life Cycle tab

o   Start Using – The date from which the account is usable.

o   Expiration Date – Account expiration date.

o   Life Time – Relative expiration date; account will expire on “first usage date” + “life time” days. If you do not want to use this feature, leave the field blank.


5.     After clicking save_close Save & Close, you will see a confirmation screen announcing that a new account has been created.