Instant Messaging Service

Checklist

Initial Configuration of PortaSwitch®

Enable the Messaging Service

Create a Service Policy

Create Internal Vendor Tariff

Enter Rates for Internal Vendor Tariff

Define a Connection for the Internal Vendor

Add a special destination for instant messages

Create a Customer Tariff

Enter Rates to the Customer Tariff

Modify Included Services and Usage Charges for a Product

Testing

 

It is popular among users to install messengers (i.e. web applications like ICQ, WhatsApp, etc.) on either their mobile phones or computers and exchange messages via the Internet within the same network.

 

For instance, if a user has registered with WhatsApp, they can send free on-net messages (i.e. instant messages) to other WhatsApp users. This service is known as Instant messaging.

 

With PortaSwitch®, you can enable your VoIP customers to use Instant messaging service by registering their SIP accounts with various messengers (that support the SIP protocol).

 

Moreover, you can develop a custom application to bundle voice calls and messaging services and then distribute the application among users of different networks (VoIP and mobile), and thereby expand your customer list.

 

This chapter demonstrates how to configure an Instant messaging service so that in addition to voice calling, your VoIP customers can send instant messages.

Checklist

Print the following page and use it 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.

 

 

Operation

 

Done

General Configuration

 

Enable the Messaging Service on the Configuration server

[     ]

Network configuration

 

Create a service policy (e.g. Instant messaging). It determines the use of SIP protocol for on-net messages and it is also used for internal communications between PortaSIP® and the billing engine.

[     ]

Rating configuration (Internal Vendor)

 

Create a vendor tariff for IM services (that will be referred to as tariff A later on). Make sure this tariff has the Messaging service assigned and the Routing option disabled!

[     ]

In tariff A, enter a rate for the wildcard destination (|)

[     ]

Create an “Internal messaging via SIP” connection for your “internal” vendor (e.g. Internal vendor, the one you have created in the basic SIP service configuration for handling SIP on-net calls) used for “SIP-UA” string and tariff A

[     ]

Rating configuration (Customer)

 

Create a tariff (referred to as tariff B later on), which will be applied to end users

[     ]

In tariff B, enter the rates for the destinations to which your customers will send messages

[     ]

Modify a product for end users:

Include the Messaging Service and add a new usage charge entry for this product using the PortaSIP node and tariff B

[     ]

Testing

 

Configure the messaging client (e.g. Linphone) and send an instant test message

[     ]

Initial Configuration of PortaSwitch®

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

Enable the Messaging Service

1.     Clone the existing configuration.

2.     Select BillingEngine on the Configuration Tree. Enable the Messaging Service in the ServiceTypes group.

 

Enable the messaging service

 

3.     Click the Save button and then the Verify button.

4.     Verify the new configuration and click the Check / Apply button.

Create a Service Policy

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 service policy that is used for internal communications between PortaSIP® and the billing engine regarding routing and transport protocol that is used for message delivery.

 

1.     In the Networking section of the admin interface, choose Service Policies.

2.     On the Service Policies page, click  Add a new policy in the Messaging Service section.

 

Create the domain service policy

 

3.     Add the following attributes to the service policy:

·      Policy name – Specify the name of the service policy.

·      Description – Provide the short text description of the service policy.

·      Match priority – Specify 5. Please refer to the PortaBilling Help for detailed description of this field.

·      Recipient domain pattern – This is the pattern according to which the service policy is selected. Specify % in this field. This means that the service policy is applied to all outgoing messages sent by your end users.

·      External_routing – Select No.

·      Local_lookup – Select Yes to enable the lookup for destinations within the network.

·      Outgoing_aaa – Select Yes to enable outgoing message authorization and billing.

·      Transport_protocol – Select SIP.

·      Userpart_e164_translation – Choose Yes.

 

Add a service policy

 

4.     Click  Save.

 

 Note that it will take several minutes until the changes are propagated to PortaSIP® and Radius server.

Create Internal Vendor Tariff

To correctly bill for on-net instant messages (i.e. those delivered to accounts within your network), you will need to create a special tariff for the internal (virtual) vendor:

 

1.     On the navigation menu to the left, select Service catalog and click Tariffs.

2.     On the Create tariff panel, fill in the tariff details:

 

Create a vendor tariff

 

·       Name – Type a short name for the tariff object; this is the name you will see in the select menus (for example, Instant messaging).

·       Currency – Choose the currency in which the vendor charges you.

NOTE: The currency for the tariff may be chosen only once, and cannot be changed later.

·       Service – Choose Voice Calls here.

·       Applied to – Choose Vendor in the Applied to list.

·       Routing – Leave the Routing option disabled for this tariff.

 

 

Enter Rates for Internal Vendor Tariff

1.     On the vendor tariff’s panel (Instant messaging), click Rates.

2.     On the Add rate panel, fill in the rate details:

·       Rate Code – Type in ‘|’ (pipe) in the field. This will create a special rate that matches any number the message is sent to.

·       Unit price – Set zero as the price since there are no actual costs for on-net instant messages.

·       Leave the other fields in the form as they are.

 

Enter rates

 

3.     Click Save.

Define a Connection for the Internal Vendor

In this step, you will add a new connection to the internal vendor.

1.     On the navigation menu, select Infrastructure, then select Vendors.

2.     On the Search vendor panel, type the vendor name and click Apply filters:

3.     On the Results panel click the vendor name.

 

Add a vendor

 

4.     On the Vendor panel, click Connections.

5.     On the Create connection panel, fill in the connection details:

·       Description –Type a descriptive name for this connection. It will be displayed in the list of connections (e.g. Instant messaging).

·       Service type – Select Messaging service.

·       Type of connections – Select SIP/SIMPLE.

·       Tariff – Select the tariff that you have created before (e.g. Instant messaging.)

·       Active – Leave as is.

·       Internal – Use the slider to set this connection as active.

·       Use for – Leave the Route to internally registered SIP accounts (SIP-UA) as is

6.     Click Save.

 

 

Add a special destination for instant messages

 

The special MSGN destination covers messages sent to an IP phone connected to PortaSwitch (regardless of the actual phone number). Adding a rate for this destination allows you a set a unified price for all on-net messages. Please consult the Special destinations chapter of the PortaSIP Administrator Guide.

 

1.     On the navigation menu, select Service catalog, Rate Codes and then Destinations.

2.     On the Create connection panel, fill in the destination details: 

·       Format – Select Custom.

·       Prefix – Type in MSGN.

·       Description – Write a short description for the destination.

 

 

3.     Click Save.

Create a Customer Tariff

1.       On the navigation menu to the left, select Service catalog and click Tariffs.

2.       On the Create tariff panel, fill in the tariff details:

 

Create a customer tariff

 

·       Name – Type a short name for the tariff object; this is the name you will see in the select menus (for example, On-net messaging.)

·       Currency – Choose the currency in which you charge your customers.

NOTE: The currency for the tariff may be chosen only once, and cannot be changed later.

·       Service – Select Messaging Service here.

·       Applied to – Select Customer.

·       Managed by – Leave Administrator only.

 

3.       Click Save.

Enter Rates to the Customer Tariff

1.     On the customer tariff’s panel (e.g. On-net messaging), click Rates.

2.     On the Add rate panel, fill in the rate details:

·       Rate Code – Select MSGN.

A destination prefix may be entered directly (e.g. 1604) or you can start typing the destination and then select it from the list.

·       Unit price – Specify the price per message or put a zero if you provide instant messaging services free of charge.

·       Leave the other fields in the form as they are.

 

 

3.     Click Save.

Modify Included Services and Usage Charges for a Product

Since the IP devices and applications connect to PortaSIP® via SIP protocol for both messaging and voice calls services, the product for messaging product must include voice calls and messaging services.

 

1.       On the navigation menu to the left, select Service catalog and click Products.

2.       Select the product that you wish to modify.

3.       On the Product panel, click Services and then Add a service

4.       Select the Messaging service and click Add.

 

 

5.       On the Product panel, click Charges, Usage Charges and then click Add:

·       Select Messaging Service from the Service list.

·       Select the PortaSIP® node in the Node field.

·       In the Tariff field, select the tariff that applies to your customers for sending instant messages (e.g. On-net messages).

 

 

 

6.       Click Save.

NOTE: There is currently no need to create a special tariff and rating entry for incoming messages as they are considered free by default.

Now your SIP subscribers who have this product can use instant messaging service in addition to VoIP services.

 

Note that if you have more than one virtual environment where you will provide instant messaging service, you will need to perform the above steps for each virtual environment.

Testing

Configure the messenger client. As an example, we use Linphone (http://www.linphone.org/releases/windows/Linphone-3.9.1-win32.exe).

 

Download Linphone and perform its configuration.

1.     On the main page, select Use SIP account:

 

 

2.     Fill in the Assistant form.

3.     The most important fields are:

·       Username – Specify your account ID here.

·       Password – Specify the service password in this field.

·       Domain – Specify the VIP of your PortaSIP® cluster.

·       Display name – Specify your name. This is a display name that will be shown to the party you call or send messages to.

·       Transport – Select UDP.

 

 

4.     Click Login.

5.     Select Chat and Add Conversation.

 

 

6.     Enter the number and send a message.

 

 

Note that with PortaSwitch® you can use the following Windows clients for instant messaging service:

·       Linphone (http://www.linphone.org/releases/windows/Linphone-3.9.1-win32.exe)

·       Jitsi (https://download.jitsi.org/jitsi/windows/jitsi-latest-x86.exe)

·       Ekiga (http://ftp.gnome.org/pub/gnome/binaries/win32/ekiga/4.0/ekiga-setup-4.0.1+.exe)