Wholesale SMS delivery

Similarly to wholesale voice traffic termination, you can configure PortaSwitch to serve as an intermediate SMS aggregator: it will collect SMS traffic from your customers and deliver the traffic to large SMS aggregators via the SMPP protocol. You, as the service provider and PortaSwitch owner, receive a profit from the difference between:

• The price you charge your customers for passing the SMS traffic received from them to SMS aggregators and
• The price you pay the SMS aggregators for the SMS traffic transmission.

Typically, SMS aggregators operate with MCC/MNC codes for destinations. Therefore, enable HLR lookup in PortaSwitch to identify which mobile network a message recipient belongs to and to which SMS aggregator the message must be routed. Please refer to the PortaBilling Administrator Guide for a detailed description of SMS routing with real-time HLR lookup.

This chapter provides instructions for such a configuration.

Customer SmartNet sends bulk SMS traffic to your network from their gateway via the SMPP protocol. You authorize SmartNet using the IP address and re-send their SMS traffic to the SMS aggregator (e.g., http://www.lleida.net) for further delivery to subscribers.

SmartNet, as the SMSC (Short Message Service Center), requires that PortaSwitch establish a binding connection with their gateway. Thus, SmartNet is configured both as a vendor (for PortaSwitch to bind to their system as a transceiver) and as a customer, since SmartNet is charged for sending SMS traffic.

Use this checklist to check off the operations you have completed while performing the system setup according to the instructions in this chapter. Please be sure to perform all of the operations in the order designated (all of the boxes should be checked), otherwise, the service will not work.

If you have just installed the PortaBilling software or dedicated a new billing environment to configure the services described in this handbook, make sure to first perform the initial configuration of PortaBilling. To do this, use the Initial configuration of PortaBilling handbook.

1. On the Configuration server, clone the existing configuration to modify it.
2. Select BillingEngine on the Configuration Tree. Enable the Messaging Service in the ServiceTypes group.

   

3. Click the Save button and then the  Verify button.
4. Verify the new configuration and click the  Check/Apply button.

1. Set up an account with www.hlr-lookups.com. You will be provided with the credentials for API communication.
2. On the Configuration server clone the currently active configuration to modify it.

   

3. From the Configuration tree select Web Cluster->Global->HLRNumberLookup and fill in the following information:
   • Enabled – select Yes.
   • Username – type in your account ID.
   • Password – specify the password.

     

4. Select the SIP cluster and set Yes in the use_hlr_lookup option in the ProcessingNodeIMGate group.
5. Click the Save button and then the  Verify button.
6. Verify the new configuration and click the  Check/Apply button.

The majority of SMS aggregators operate with destinations that are defined in the E.212 format. This format defines destinations as a combination of the mobile country code (MCC) and the mobile network code (MNC). Therefore, to easily operate with SMS aggregators, enter destinations in PortaBilling in the E.212 format.

1. On the navigation menu, type Destinations in the  Search field.
2. On the Destination panel, click Upload.
3. In the Upload destinations dialog box, select Default destinations and click the arrow  next to the E.212 destinations format.
4. Save a set of destinations as a .csv (comma-separated values) file.
5. Open this file in Microsoft Excel or any other suitable program. Edit the data if necessary and save your changes.

   

6. Switch back to the PortaBilling admin interface and on the Destination panel, click Upload again.
7. In the Upload destinations dialog box, select Default destinations.
8. Select the checkbox for I have checked the default destinations.
9. Select the E.212 destinations format checkbox and click Upload.

   

1. On the navigation menu, type Destinations in the  Search field.
2. Open the Create a destination panel.
3. Select E.212 in the Format field.
4. Fill in the destination information. This includes the MCC and MNC codes. Start typing the code to narrow the search. The Country and Network fields will be auto-populated. You can use the Description field to store extra information about the destination (e.g., proper).

   

5. Click Save.
6. Repeat these steps for any additional destinations you would like to add.

A service policy is a set of parameters that defines how the subsystems of PortaSwitch must operate to provide the Messaging service.

At this point, it is necessary to create a domain service policy. This policy is used for internal communication between PortaSIP and the billing engine.

1. On the navigation menu, type Service policies in the  Search field.
2. Open the Create service policy panel.
3. Fill in the service policy details:
   • Name – specify the name of the service policy (e.g., SMS service).
   • Service type – select Messaging service.
   • Recipient domain pattern – specify a pattern according to which the service policy will be selected. Type % for the SMS service.
4. Click Save.

   

5. On the Service policy panel, fill in the following fields:
   • Match priority – specify 5 in this field.
   • ·Description – provide a short text description of the service policy.
6. Open the Attributes panel.
7. Select the Processing messages over SIP/SMPP panel.
8. Specify the following attributes:
   • External routing – select the check box. Use the slider to enable sending SMS traffic to off-net vendors.
   • Local lookup – select the check box. Leave the slider as it is (disabled).
   • Outgoing AAA – select the check box. Use the slider to enable outgoing message authorization and billing.
   • Transport protocol – select the check box and choose the SMPP option from the list.
   • Userpart Е164 translation – select the check box. Use the slider to enable using the dialing rules for phone number translation.
9. Click Save.

   

   Note that any service policy changes will not be applied immediately. It will take several minutes until they are propagated to PortaSIP.

The service policy for a vendor connection defines the specific parameters for this connection. For these parameters to apply, the service policy must be associated with the corresponding vendor connection.

1. On the navigation menu, type Service policies in the  Search field.
2. Open the Create service policy panel.
3. Fill in the service policy details:
   • Name – specify the name of the service policy (e.g., SMS aggregator).
   • Service type – select Messaging service.
4. Click Save.

   

5. On the Service policy panel, add the following fields:
   • Description – provide a short text description of the service policy.
6. Open the Attributes panel.
7. Select the Processing messages over SIP/SMPP panel.
8. Specify the following attributes:
   • Transport protocol – select the check box and choose the SMPP option from the list.
   • Bind as – select the transceiver option from the list for the option to send and receive messages.
   • Heartbeat interval – specify the interval (in seconds) in which ENQUIRE_LINK requests are sent to verify a connection. The zero default means no requests will be sent. Specify 30 for the SMS aggregator.
9. Click Save.

   

   In case your customer’s parameters differ, in this case, SmartNet (e.g., Heartbeat interval is 10 seconds), create a new service policy specifically for this customer.

    

   Note that any service policy changes will not be applied immediately. It will take several minutes until they are propagated to PortaSIP.

This tariff will contain your SMS aggregator’s transmission rates.

1. On the navigation menu, type Tariffs in the  Search field.
2. On the Create tariff panel, fill in the tariff details:
   • Name – a short name for the tariff object; this is the name you will see in the select menus (e.g., Lleida Networks).
   • Currency – indicates the currency in which the SMS aggregator charges you.
     The currency for the tariff may only be chosen once and cannot be changed later.
   • Service – choose Messaging service here.
   • Format – select the format the SMS aggregator operates with. Select E.212 from the list.
   • Applied to – choose Vendor in the Applied to select menu.
   • Routing – use the slider to enable this option since this tariff will be used both to calculate your costs and to route SMS messages.
3. Click Save.

   

Upload per-destination sending rates provided by your SMS aggregator from a .csv or .xsl file. As messaging services are charged per message, the rating parameters will be as follows:

• MCC/Country – destination mobile country code.
• MNC/Network – destination mobile network code.
• Unit Price – price per message (e.g., $0.01).

You can define route categories in the .csv file and upload the rates with the route categories assigned to them.

Please consult the Rate import handbook for more details.

 Perform the Create tariff and Upload sending rates steps described above until you have created a tariff with termination costs for each transmission partner you have.

SmartNet is your customer and is charged for sending SMS traffic according to the Customer tariff (which will be created later). Since SmartNet requires that PortaSwitch bind to their system, SmartNet will be created as a vendor, too. Thus, a vendor tariff is required for a SmartNet connection. You do not need rates for this tariff, since it will not be used for SMS message routing.

1. On the navigation menu, type Tariffs in the  Search field.
2. On the Create tariff panel, fill in the tariff details:
   • Name – a short name for the tariff object; this is the name you will see in the select menus (e.g., SmartNet).
   • Currency – indicates the currency.
     The currency for the tariff may only be chosen once and cannot be changed later.
   • Service – choose Messaging service here.
   • Format – select the format the SMS aggregator operates with. Select E.212 from the list.
   • Applied to – choose Vendor in the Applied to select menu.
   • Routing – make sure this option is disabled, since this tariff will not be used for SMS message routing.
3. Click Save.

   

As your SMS transmission partner, Lleida Networks must be provisioned as a vendor in PortaBilling. To do this:

1. On the navigation menu, type Vendors in the  Search field.
2. On the Create vendor panel, fill in the vendor details:
   • Name – type a short name for the vendor object; this will be used on the web interface (e.g., Lleida Networks).
   • Currency – choose the currency in which this vendor charges you.
   • Opening balance – this indicates a starting balance for the vendor; the default is zero.
   • Billing period – split period for vendor statistics.
3. Click Save.

   

   When a message is sent from your network to the vendor’s gateway, the vendor performs an authorization for the message and provides you with a username and password to use for message authorization. These credentials must be stored with the “vendor authorization” info and then associated with a specific connection so that they can be used during actual message transmission.

4. Create an account for digest authorization of outgoing messages.
5. On your vendor’s panel (Lleida Networks), click General configuration, then click Authorization.
6. On the Authorization panel, click Add and enter the credentials provided by the vendor.
7. Click Save.

   

The connection is the point where SMS messages leave or enter your network and is therefore where costs are incurred.

1. On your vendor’s panel (Lleida Networks), click Connections.
2. On the Create connection panel, fill in the connection details:
   • Description – give a short description to the connection that will be shown on the list of connections.
   • Service type – select Messaging service here.
   • Type of connections – select SMPP.
   • Tariff – choose the tariff that defines your termination costs for this connection/vendor.
   • Active – use the slider to set this connection as active.
   • Gateway ID – specify the IP address or ID of the vendor’s gateway.
   • Service policy – select the service policy you created for this connection (e.g., SMS aggregator).
3. Click Save.

   

4. Click General configuration panel.
   • Vendor authorization – select the vendor authorization you created for this connection (e.g., Lleida SMS).
5. Click Save.

   

Your customer, SmartNet, is a SMSC and requires that PortaSwitch establish a binding connection with their gateway. Thus, SmartNet must be provisioned as a vendor in PortaBilling. To do this:

1. On the navigation menu, type Vendors in the  Search field.
2. On the Create vendor panel, fill in the vendor details:
   • Name – type a short name for the vendor object; this will be used on the web interface (e.g., SmartNet).
   • Currency – choose the currency in which this vendor charges you.
   • Opening balance – this indicates a starting balance for the vendor; the default is zero.
   • Billing period – split period for vendor statistics.
3. Click Save.

   

   When establishing a binding connection with SmartNet, PortaSwitch sends credentials that SmartNet provides for authorization. These credentials must be stored with the “vendor authorization” info and then be associated with a specific connection so that they can be used during an actual binding procedure.

4. Create an account for the digest authorization of incoming messages:
5. On your vendor’s panel (SmartNet), click General configuration, then click Authorization.
6. On the Authorization panel, click Add and enter the credentials provided by the vendor.
7. Click Save.

   

1. On your vendor’s panel (SmartNet), click Connections.
2. On the Create connection panel, fill in the connection details:
   • Description – give a short description for the connection that will be shown on the list of connections.
   • Service type – select Messaging Service here.
   • Type of connections – select SMPP.
   • Tariff – choose the tariff that defines your termination costs for this connection/vendor.
   • Active – use the slider to set this connection as active.
   • Gateway ID – specify the IP address or ID of the vendor’s gateway (e.g., 192.143.12.6).
   • Service policy – select the service policy you created for this connection (e.g., SMS aggregator).
3. Click Save.

   

4. Click General configuration panel.
   • Vendor authorization – select the vendor authorization you created for this connection (e.g., SmartNet).
5. Click Save.

   

This tariff will contain your customer’s rates for sending SMSs.

1. On the navigation menu, type Tariffs in the  Search field.
2. On the Create tariff panel, fill in the tariff details:
   • Name – type a short name for the tariff object; this is the name you will see in the select menus (e.g., SMS delivery).
   • Currency – indicates the currency in which you charge your customers.
     The currency for the tariff is chosen only once and cannot be changed later.
   • Service – choose Messaging service here.
   • Format – select E.212 from the list.
   • Applied to – select Customer, as this tariff will be used to charge your customers.
   • Managed by – select Administrator only here, since we are setting up a service without the involvement of resellers.
3. Click Save.

   

1. On the Tariff panel, fill in the Add rate details:
   • MCC/Country – select the MCC/Country pair from the list (e.g., 230 for the Czech Republic).
   • MNC/Network – select the MNC/network pair from the list (e.g., 1 for T-Mobile).
     You must create an entry for MCC/MNC codes in the Destination register before creating a rate for them in the tariff.
   • Unit Price – price per message (e.g., $0.02).
2. Click Save.
3. Repeat these steps if you need to enter more rates.

   

Your wholesale customers’ remote gateways are represented as accounts and are therefore billed according to the products you create for those accounts.

1. On the navigation menu, type Products in the  Search field.
2. On the Create product panel, fill in the product details:
   • Name – type in a short name for the product object; this is the name you will then see in the select menus (e.g., Wholesale SMS).
   • Name visible to end users – specify the name of the product that your customers will see on their self-care interface (e.g., Easy SMS).
   • Product type – choose Main product here.
   • Currency – product currency; only tariffs that share the same currency will be permitted in the rating list.
   • Managed by – choose Administrator only here, since we are setting up a service without the involvement of resellers.
   • Account default ACL – choose an Access Control List (ACL) for accounts with this product assigned. ACLs control which objects end users can have access to and which actions they can perform.
   • Account role – select IPv4 address from the list.
3. Click Save.

   

4. On the Product panel, click Services and then Add a service.
5. Select the Messaging service and click Add.
6. Click Save.

   

The Charges section provides access to a group of panels where you can set up overdraft protection and define how to charge your customer for a messaging service. On the Product panel, click Charges.

On the General info panel you can define special pricing such as volume discounts, regular payments such as subscriptions, and set up overdraft protection.

• Overdraft protection – leave this box checked to prevent overdraft for users who use this product.
• Breakage – specify the minimum amount of funds the account must contain to use the services.
• Default discount plan – this allows you to assign a discount plan for the product. Leave None as no volume discount plan is specified for this service.
• Subscription – this allows you to choose a subscription plan for the product, so that this plan will be automatically applied to every account with this product assigned. Skip this step if no subscription plan is specified for this service.

  

The Usage charges panel has two functions: it defines the permitted access points (nodes and access numbers) and specifies which tariff must be used for billing at each of these points.

7. On the Product panel, click Charges, then click Usage charges.
8. On the Usage charges panel, click Add.
9. Fill in the required information:
   • Service – select Messaging service from the list.
   • Node – select the PortaSIP node.
   • Access code – leave this field empty.
   • Tariff – select the tariff that will be applied to your customers for sending SMSs (e.g., SMS delivery).
   • Overdraft protection – use the slider to send alerts when overdraft is detected.
10. Click Save.

    

Define additional settings for the product.

1. On your product’s panel, click Additional information.
2. On the Additional information panel, fill in the following product information:
   • Notes – open the Notes panel to make notes about the product.
   • Product group – a product group is a custom grouping of add-on products on the account self-care interface. Select None for this product.
   • Account default ACL – the access level assigned by default to new accounts created with this product. The ACL determines which operations may be performed by accounts on the self-care pages. The default ACL value “Account self-care” allows all possible operations.
   • Information URL – if you have an external server with a description of product features, enter the URL here (e.g., http://www.myproduct.com). Your customers will be able to go there from their self-care page.
   • Description – your internal comments about the intended use of this product.
   • Description visible to end users – provide a product description to be shown to end users on their self-care interfaces.
3. Click Save.

   

At the end of the billing period, PortaBilling can produce invoices for your customers. An invoice reflects all the transactions (calls, payments, refunds, subscription charges, etc.) that occurred during a specific period. It serves as the primary record of services provided to a certain customer as well as the primary record of their status. To enable invoice generation you need to create a template for the invoice layout first.

Create an invoice template as described in the Setting up a wholesale traffic exchange handbook.

Customer class provides the ability to globally define a group of parameters in a centralized way, and then apply those parameters to many customers at once.

1. On the navigation menu, type Customer classes in the  Search field.
2. On the Create a customer class panel, fill in the customer class details:
   • Name – type a short name for this customer class.
   • Currency – specify the currency in which you want to set the Collection threshold. When specified, this customer class can only be assigned to customers with the same currency. Once the currency selection is saved, it cannot be changed.
   • Business model – select which customers this customer class will apply. Select SIP trunking from the list.
   • Managed by – select Administrator only.
3. Click Save.

   

4. On your customer class panel, click Finances, then click General info.
5. On the General info panel, fill in general information about the customer class:
   • The billing period is closed – select Automatically.
   • Configure the Statistics parameters:
     • Generate statistics – leave this option enabled to generate statistics for customers.
     • Send statistics via email – define how you will provide statistics to your customers.
   • Configure the Status change parameters:
     • Suspend customers – here you can specify whether PortaBilling must check whether the customer has sufficient funds for their subscription charges.
     • Block debit accounts – specify whether PortaBilling must check whether a debit account has sufficient funds for their subscription charges.
     • Permanently terminate customers after provisional termination – use the slider to enable the option. Specify the amount of days (e.g., 90) after which the provisionally terminated customer becomes permanently terminated.
   • Configure the Other parameters:
     • Description – your comments about the intended use of this customer class.
6. Click Save.

   

7. On your customer class panel, click Finances, click Invoicing, then click Regular invoices.
8. On the Regular invoices panel, specify the invoicing parameters for the customer class:
   • Use regular invoices – enable this parameter to generate regular invoices for customers who belong to this customer class.
   • Invoice template – select the appropriate template which will be used to create a .pdf file with the invoice for your customers (e.g., Wholesale invoice template).
   • Generate invoice pdf – leave the default option At the end of the billing period to generate the .pdf files once the billing period ends.
   • Send the invoice via email – select Automatically to automatically send an invoice to a customer at the end of the billing period.

     Please consult the PortaBilling help for a description of other parameters available here.

9. Click Save.

   

10. On the Invoicing panel, click Out-of-turn invoices (optional) to enable generation of the out-of-turn invoices (to cover only a few specific items) on demand for customers that belong to this customer class. Specify the invoice template and copy the settings from Regular invoices panel.
11. On the Taxation panel, specify the taxation method to be applied to your customers.
12. Click Save.

    

A customer is a company that sends SMS traffic for you to transmit and pays depending upon the amount of traffic sent. The customer’s contact information is used to distribute account usage information, service usage statistics, invoices, etc.

In this example, we will describe how to manually create a new customer.

1. On the navigation menu, type Customers in the  Search field.
2. On the Create customer panel, fill in the customer details:
   • Name – type a short name for the customer object; this will be used on the web interface.
   • Balance control – specify the way the customer will pay for the service: Postpaid – after consuming the services; Prepaid – prior to consuming the services. Select Postpaid in this field.
   • Currency – choose the currency in which this customer will be billed.
   • Credit limit – assign a credit limit for the customer.
   • Business model – select SIP trunking for this customer. A business model defines what type of service is to be provided to the customer.
   • Customer class – select the previously created customer class for wholesale customers. By choosing a specific class here the customer will automatically inherit all of the class properties (grace period, invoice template, etc.).
   • Billing period – choose a billing period for the customer. A billing period defines the frequency of invoicing for this customer.
   • Billing period time zone – choose a time zone in which customer’s billing period will be closed and invoices will be generated.
3. Click Save.

   

Define the customer's personal information (such as name, email address, and etc.).

1. On your customer’s panel, click Personal, then click General info.
2. On the General info panel, fill in the customer’s personal information and an email address for the receipt of accounting information. After the billing period is over, a list of xDRs and other statistics will be sent to this address.

1. While on the Personal panel, click Address info.
2. On the Address info panel specify the customer’s address. In the BCC field type in the email address of your account representative. They will receive a copy of every outgoing email sent to the customer; this may be used for debug and archiving purposes.

Define credentials and preferred settings (such as language, time zone, date input and output formats) for this customer's self-care interface.

1. On your customer’s panel, click Personal, click General info, then click Web self-care.
2. On the Web self-care panel, define credentials for the customer self-care interface (such as login, password, time zone, etc.) and other preferred settings.

Define whether to suspend the customer when their balance is insufficient to cover subscription charges.

1. On your customer’s panel, click Finances, click General info, then click Subscriptions.
2. On the Subscriptions panel, set the Suspend on insufficient funds parameter. This defines whether the system must check that the customer has sufficient funds for their subscription charges.

1. On your customer’s panel, click Finances, click General info, then click Credit limit.
2. On the Credit limit panel, define the Credit limit warning threshold parameter. The customer can be notified by email when his balance is dangerously close to the credit limit and service will soon be blocked. The threshold can be specified:
   • 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.
     To specify several credit limit warning thresholds, enter the values by clicking Add .

Define whether to send this customer their statistics and invoices by email.

1. On your customer’s panel, click Finances, and then click Invoices and taxation.
2. On the Invoices and taxation panel, set the Send Statistics via email option to Summary only. This delivers a call summary only and do not attach a details file; this could be useful in the case of a large number of calls. Other options are Full Statistics (attach a complete list of xDRs) or Do not send (this option prevents the delivery of event statistics to this customer via email).

1. On your customer’s panel, click Services.

   The Services panel provides an access to a group of panels where you can activate/deactivate various features of the voice calls service provided to the customer.

   This is a convenient way for managing parameters which are the same for a whole set of accounts. Instead of trying to configure them for each individual account, you can define them once at the customer level, then specify in the account configuration that the value in the customer’s configuration be used. If you wish to change this value later, you need only modify it once for the change to be automatically propagated to all accounts.

   For now, you may leave these with their default values. If you change them later, these changes will automatically affect all accounts created under this customer.

2. Click Save.

Accounts enable the authorization of a customer’s actual end-points. In our example, we assume that the authorization is performed by the IP address of the remote gateway/proxy.

1. On your customer’s panel, click Accounts.
2. On the Create an account panel, fill in the account information:
   • ID – the IP address for the customer’s proxy or gateway (must be identical to the IP that is mentioned in the connection).
   • Account role – select the IPv4 address from the list.
   • Product – choose the main product that you would like your account to have.
   • Activation date – choose the date from which the account is usable. By default, the account is activated immediately upon creation.
   • Type – select Credit in this field.
   • Balance control – choose Subordinate, since a credit limit is controlled at the customer level.
3. Click Save.

   

1. On your account’s panel, click Services.

   On this panel, you can activate/deactivate various features of the voice calls service provided to this account (e.g., assign a routing plan, etc.).

2. Click Save.

You may check the routing for an SMS in your system prior to actually sending a message. The system will perform the HLR lookup and you will see the routing results based on the MCC/MNC codes for the destination number.

1. On the navigation menu, type SMS routing simulation in the  Search field.
2. On the Routing simulation panel, enter the destination phone number.
3. Click Test to display a list of applicable routes.

   

   

You can configure the SMPP client/gateway to send messages to your PortaSIP server. To do this, use the PortaSIP’s virtual IP address and port for incoming SMPP connections (which is 2775 by default).

Since authorization is performed by the SMPP client/gateway IP address, you can set any values for the SMPP login and password. Then send a message.