IM Solution User Panel Documentation

1.User Module #

 

End user can log-in to user module to trigger a new campaign, manage contacts, view MO/MT traffic, download reports, configure new activities, manage profile and manage various settings.

Upon log-in, you are taken to dashboard, which will give you an insight of your traffic summary for last three days. You can also see multiple TABS on the top depending on plugins enabled for your account. Details of TABs and associated functions a described below

1.1.Dashboard #

 

Dashboard: Snapshot of Traffic Summary for last three days

SMS-MT : All functionality related your outbound A2P SMS campaign (MT-Mobile terminated)

SMS-MO: All functionality related to your inbound P2A SMS traffic (MO-Mobile originated)

Administration: This Tab is available for account Role Reseller. You can manage everything related to your child account

Developer API: It will take you to detail documentation on Developer API

Note: Details of every tab are described in individual sections

1.2.SMS #

 

When you click on the SMS-MT tab, it will should various navigation menu options on the left side of the page. Very first menu SMS has three sub-menus as shown in the figure below.

1.2.1.Compose SMS #

 

Click on the Compose SMS link from the left sub-menu available under SMS menu to trigger your A2P SMS campaign. This will show you a compose SMS form. Enter a friendly name for Campaign Name field. By default a name is created automatically with current date time and prefix Camp_.

 

1.2.1.1.Campaign Name #

 

Click on the Compose SMS link from the left sub-menu available under SMS menu to trigger your A2P SMS campaign. This will show you a compose SMS form. Enter a friendly name for Campaign Name field. By default a name is created automatically with current date time and prefix Camp_.

1.2.1.2.Sender Id #

 

In Sender ID field, you can see a drop down to select your preferred sender ID.

Sender ID is also known as from address or originator address.

Selected Sender ID will appear as senders address in recipient mobile.

If your account is enabled for Open Sender ID, you may see a text box instead of drop down and you can use any dynamic numeric or alpha numeric sender ID.

Max recommended length of alpha numeric sender ID is 11 characters and 15 digits for numeric sender ID.

1.2.1.3.Contacts #

 

As soon as you click on Contacts text box, a corresponding upload method will appear on the right navigation.

This navigation tab has option for choosing contact stored in your Groups or you can upload local Files having contacts.

Supported file formats are .xls,.csv,.txt. A link with sample of such files is available under From File tab. Similar menu/link (Import Contact) is also available under Contacts text box for easy navigation. Recommended max contacts upload including group and/or file are 100K.

You can also enter contact manually one by one or perform a copy paste operation in Contacts text box. You can enter comma separated mobile numbers.

Numbers can also be entered in row using enter button. A copy and paste operation from excel column is also supported. The moment changes the focus from the field, all such numbers are automatically formatted as coma separate. Recommended max numbers in textbox is 10K. Any higher value may hang your browser making it nonresponsive.

It may be noted that every number should start with a country code without (+). This is an industry standard, however there are cases, where your operator may ask you to submit messages without country code. In order to meet such requirement, we have kept adding country code as optional. However we have provisioned an option to auto add country code by checking Auto Add country code check box. If your contacts are already prefixed with country code then make sure that this box is un-checked. Default value of this box is unchecked, however if you find it cumbersome to check this box every time you send SMS, you can go to Profile section and override the default setting to checked. (Image required from profile)

An additional checkbox is also available to remove duplicates. The default value is unchecked. It may be noted that checking this box may increase the overall processing time of your campaign.

1.2.1.4.Select Draft #

 

As soon as you click on the “Enter Message” text box, a navigation menu consisting of last 5 messages will appear on the right navigation. This feature is very useful for frequent messaging where content is either similar or needs only few modifications. A counter at the bottom of the screen will show you the length of the message and message count. Following table will give an idea on SMS count based on characters count and encoding:

Number of SMSGSM 7 bit EncodingUnicode (Language SMS)
1Upto 160Upto 70
2Upto 306Upto 134
3Upto 459Upto 201
4Upto 612Upto 268
5Upto 765Upto 335
NUpto 153 * NUpto 67 * N

Must Read:- Such counters are just an indicative tool. Due to browser compatibility, encoding/code page issues, some time exact length of the message may not be accurate. If you have a very tight content nearing borderline of 159 or 160 characters, a slight mismatch in count may cost you extra money. You are always recommended to test your content on few numbers before triggering a large campaign. Cost of sending SMS can be checked from cost column in the report section (Image required). There are cases where you may be using feature of content replacement e.g TY is replace with Thank you for enquiry. Exact count/cost of such messages may vary in final submission to gateway.

You can select the content of your campaigns from existing saved draft or templates. Draft content can be edited before sending, however in case of templates only placeholders can be modified.

Note: There may be cases where you can’t enter message text using textbox. Only way to create your campaign in such cases are to use Templates. By default it is not restricted, however, in specific cases, where there is a strict regulatory compliance, your service provider may not allow open template in order to regulate the content.

Default value of Flash check box is un-checked. If you want to deliver any message directly on the screen, you can check this option. Flash messages are not saved in mobile equipment, however in most modern handsets, handset manufacturers, provide an option to save even flash messages.

You can optionally save any message as draft or even schedule your campaign to be executed on a future date. By default system will take the date time as per the time zone configured in your profile.(Image required).

Scheduled messages, which are not already executed, can be modified from Report- My Schedule menu. (Image required).

Step 1
Step 2
Step 3

 

For Unicode message you can check the Unicode check box. Though the system is capable of auto detecting Unicode message, but an extra care is recommend.

Finally clicking on send SMS will show you a preview with its cost. In case you find any route is undefined for any particular destination, you can contact your account manager for same. (Image required)

1.2.1.5.Select Template #

 

To select template click on the template icon (as shown in below image). once you clicked on template icon popup will appear then you can select an approved template by admin from the following list.

1.2.2.Manage Sender ID #

 

Manage Sender ID menu will list out all the sender Ids of you system with its Approval status. In case your account is enabled for Open Sender ID, you can skip out this configuration.

In order to create a new sender ID, click on Add Sender ID link and box will popup as show in figure below (Image required).

 

Enter the required sender id, its purpose and optionally you can check it to make default. The only advantage of making a sender ID as default is that it will appear on the top of the drop down list. This makes it easier in frequent messaging, using a particular sender id. Upon submission, the status of the sender id will be Pending and subsequently change to Approved once it is approved by the system. You can also see the approval date for al approved sender Ids. A search box helps you find a particular sender id. Helpful if you have a long list.

You can easily delete a sender id from Delete option listed under action menu. Edit option available under action menu helps you edit your sender id.

Important:- Editing an already approved sender id will change its status to Pending and will has to go through approval process as described above.

1.2.3.Manage Template #

 

Manage Template menu will list out all the Templates of you system with its Approval status. In case your account is enabled for Open Template, you can skip out this configuration.

In order to create a new Template, click on Add Template link and box will popup as show in figure below (Image required).

Enter the required Template, its purpose and optionally you can check it to make default. The only advantage of making a Template as default is that it will appear on the top of the drop down list. This makes it easier in frequent messaging, using a particular Template. Upon submission, the status of the Template will be Pending and subsequently change to Approved once it is approved by the system. You can also see the approval date for al approved Templates. A search box helps you find a particular Template. Helpful if you have a long list.

You can easily delete a Template from Delete option listed under action menu. Edit option available under action menu helps you edit your Template.

Important:- Editing an already approved Template will change its status to Pending and will has to go through approval process as described above.

1.2.3.1.Add New Template #

 

Enter a friendly name in Template Name text box.

Enter your text message in Template String Rich text box.

You can insert a place holder by clicking on “Insert Placeholder” button. Place holder has a specific format and the area is enclosed between two double hashes (##). Anything other than the place holder will be fixed text and cannot be edited while sending message.

It is recommended having 70% of fixed text and 30% of place holders for speedy approval of templates. You can replace the keyword Field between placeholder with your own Keyword for better clarity. Example: “Dear ##Field##, you password is ##Field##.” and “Dear ##Username##, you password is ##pin##.” both are same and valid.

 

Once your template is approved, you can only edit place holder portion of the template. In case you are using API, you need be very cautious. Even and extra space, coma or missing full stop may return into invalid template.

1.2.4.Contact #

 

In This Section you can find following option:

  • Manage Group
  • Import Group
  • Export group

1.2.4.1.Manage Group #

 


1.2.4.2.Import Contacts #

 

Import contact navigation menu, allows you to import contacts in a particular group. It is a three-step process.

Step 1
Step 2
Step 3

In first step, you select the group from the drop where you want to import your contacts. In second step you can choose from three different options, defining source of contacts or methods.

You can bulk import contacts from a file (xls/csv/txt) from your local drive or copy and paste contacts from excel etc. A third option of importing contacts one by one is also available. Third step will show you relevant option depending upon your selection in step 2.

1.2.4.3.Export Contacts #

 

You can export contacts easily from Export Contacts navigation menu from the left navigation bar. Contacts can be exported in xls/csv/txt file formats giving you enough options. You click on the check box of the corresponding group for which you want to export contacts.

1.2.5.Reports #

 

Report Navigation menu consists of various reports for your MT message. This navigation menu has sub-menus as Campaign report, My Schedule, Message Count, and Download Report.

1.2.5.1.Campaign Reports #

 

Campaign Report: Campaign report has two tabs showing Campaign View and List view.

Campaign view gives you consolidated list of a the campaigns consisting the list of all contacts grouped. List view will show you all the MT traffic irrespective of campaign.

Both the features has its own significant.

Campaign view is preferred by bulk senders, whereas list view is the preferred choice of API users. In short Campaign, view is the consolidated grouped traffic of list view. Both the view offers you to set preferred range. Selection preferred range button is highlighted upon selection. You can also select a custom range. It may be noted that setting a higher range in custom selection may take some time. We always recommend downloading such reports from Download Report section rather than viewing online.

  • Campaign Status: Selecting- campaign status button will pop up a window showing current status of the campaign. It will show total count and remaining count of the campaign. You can pause and resume a campaign from Action column till the status of Campaign is not completed (image required for both conditions).

  • Remaining count shows unpublished message. A zero counts means all the messages are published in queue. Once the messages are published in queue, it cannot be paused or cancelled. You can click on refresh button in remaining count column to see the live status of any particular campaign

Action :

First item under action column, lists out message count summary. Details of status is explained below:

  • Submitted: Message is submitted to Gateway/Provider and awaiting Delivery report
  • Delivered: MT message successfully delivered to handset
  • Undelivered: MT message con not be delivered to handset due to multiple reasons, check for error code in detail report to find the exact reason of non-delivery
  • Rejection: MT message rejected by Gateway/Provider due to multiple reason, check for error code in detail report to find the exact reason of non-delivery
  • Other: Any message status other than above mentioned status is considered in other category. This may include status such as Expired, Deleted, Unknown or any SMSC specific status.

Second Button in action menu show the option to download reports. You can specify various status filters while downloading.

Third button is for Resending the campaign. You can specify various status filters while resending the campaign.

Note: You can resend campaigns where are already executed in past. Any campaign which is still in pipeline or in queue will not be available for resend.

1.2.5.2.My Schedule #

 

All scheduled messages are available in My Schedule sub-menu. Entries with Pending status and be edited from Action menu.

My Schedule

Very Important: A campaign may failed to execute if sufficient balance is not available at the scheduled time (Need to check with development team)

1.2.5.3.Message Count #

 

Sent message count shows Delivered, Undelivered, Rejected , Others count and total usage count

For a selected date range. This consolidated view is useful to measure performance goal of your campaign.

1.2.5.4.Download Report #

 

All the reports where are requested for download are available under this sub-menu. You can also request for new report from Request Report menu.

A Pending status indicates that report is not yet ready. You can try visiting this page after some time. Actual time take depends on amount of data requested and current load on the system. In case it take longer than desired, you can contact your account manager.

1.3.Application Bar #

 

My transaction list out date wise transaction details.

1.3.1.My Rate Plan #

 

All the available networks for your account along with its price is listed in rate plan menu. You can send messages to destinations which are listed in your rate plan. Any message other than assigned network will not be considered for submission and automatically rejected by system and you won’t be charged for same. A value of (*) is considered as ALL/Any. For example (*) in MCC/MNC column means all the networks in that specific country are covered and a flat price is available. All active routes will be marked as Active in IsActive column.

1.3.2.My Transaction #

 

My transaction list out date wise transaction details.

1.4.Settings #

 

In this section you can find the following option:

  • My Profile
  • Change Password

1.4.1.My Profile #

 

Enable auto check “Auto Add country code” in the campaign: Checking this value will automatically checked in Compose SMS page. It may be noted that this feature will not automatically add country code in other mode of messages submission such as API or ESME interface. This option just helps in checking a checkbox automatically. Actual value will be taken as the final state of the check box in compose sms page during your campaign.

 

First Name: Enter your name

Country Code: Specify country code

Mobile number: Enter right phone number

Email: Enter Email address

Country: Select country

State: Select state

Time Zone: Select TIME Zone

1.4.2.Change Password #

 

To change your password click on change password which you can find under setting tab.

Type your old password and then enter your new password two times as shown in the image and click change password button.

For better understanging, you can click on (i) icon which is located right side of password input.

Get a Call