ASMSC V3 Guide Latest
ASMSC V3 Guide Latest
1
Document Type: User’s Guide
Date of Issue: 1/7/2022
Version: V3 Core
Through this document, we will guide you on how to operate aSMSC and the
integration process will be addressed in this guide as well.
2
Table of Contents
1 Terminology Section 6
2 Platform Overview 8
3 Dashboard 9
3.1 Monitoring
3.2 Statistics
4 Settings 14
4.1 System Settings
4.2 Gateway Settings
4.3 Entity Settings
4.4 Currency
4.5 Currency conversion
4.6 Country
4.7 Network Operator
4.8 DB Campaign
4.9 Error Code Mapper
4.10 MCC and MNC Finder
4.11 DB Maintenance
5 HLR 17
5.1 HLR Providers
5.2 HLR Dip Rules
6 LCR 18
6.1 LCR v2
6.2 LCR Exclusions
6.3 LCR Simulation
7 Load Distribution 21
8 Content Translation 22
3
8.1 Manage Retail and Wholesale
8.2 Block List Retail Wholesale
9 Voice Management 24
9.1 SIP Settings
9.2 Rate Plans
9.3 CDR
9.4 Job Management
9.5 Logs
9.6 Statistics
10 Administration 25
10.1 Manage Roles
10.2 Admin Users
10.3 Customer Notifications
10.4 Route/SIM Testing
10.5 Block Regex Testing
10.6 Message Simulation
10.7 System Logs
10.8 Vendor Account Logs
10.9 Incoming Account Logs
10.10 Customer Account Logs
10.11 Distribution Centre Logs
10.12 Re-Push DLR
11 Invoice 31
11.1 Create Invoice
11.2 Create Incoming Invoice
11.3 View Invoice
11.4 View Incoming Invoice
11.5 Invoice Report
12 Reports 34
12.1 Finance
12.2 Retail
12.3 Wholesale
12.4 Vendor
13 Blocked Destination 49
4
13.1 DND Manager
13.2 White List Retail
13.3 White List Wholesale
13.4 Black List Retail
13.5 Black List Wholesale
13.6 Countries Retail
13.7 Countries Wholesale
14 Email 52
14.1 SMTP Manager
14.2 Email Templates
15 Sender ID 54
15.1 Block list Retail
15.2 Block list Wholesale
15.3 Retail Routing
15.4 Wholesale Routing
15.5 Overwrite Retail
15.6 Overwrite Wholesale
16 Vendor Management 57
16.1 Outgoing SMPP
16.2 Incoming SMPP
16.3 Number Management
16.4 Content Translation
16.5 Text Append
17 Customer Management 61
17.1 Manage Customers
17.2 Customer Tree
18 Rate Plan Manager 63
19 Route Manager 64
20 Job Management 65
21 Sender ID Management 66
22 Template Management 66
23 Queue Management 67
24 DLR Overdrive 67
25 Pending Jobs 68
5
Terminology
Term Definition
DLR: Deliver receipt is the report about the delivery status of sent
messages.
6
EDR: Event Detail Record
DB: Database
7
Platform Overview
Following the steps mentioned in this guide will make it easy for you
to operate the system and you can refer to this whenever you are
faced with any operational issue.
8
3. Dashboard
Monitoring
Server CPU, RAM & Disk Usage
This Section shows you the Current Server CPU & RAM Usages,
this will help you in making certain decisions regarding up-gradation
of your server hardware as it may require, the usages can be higher
because of many reasons among them are:
Node Service1 (NS1) will take care of vendor service. But, if the
service status is offline, it will affect the connectivity.
SMPP Server Node (SSN1) This service takes care of SMPP client
connectivity and if its offline all clients will get disconnected until the
service is online again.
9
The incoming Live Traffic Stream chart will inform you about
the traffic flow of SMPP, API, and WEB as well.
The Online C.A, placed at the bottom of the monitoring section will
show the list of online SMPP clients which are currently connected.
On the other hand, Offline C.A, placed at the bottom right of the
monitoring section, will show the list of offline SMPP clients which
are currently disconnected.
10
This widget on the dashboard shows the connection Status of any
Client / Customer Connected over SMPP as shown under the
Connected Customer Accounts
If you click on the System ID name, you will be able to see the
binding settings with which your client is connected, Connections in
this section mean the number of sessions they are bound with.
3.2 Statistics
11
This useful widget on the dashboard will help you to easily look at
your global traffic stats, the information for the “Sent SMS “ in the
last 24 hours is shown in a Map view, in order to simplify looking at
the major traffic destinations the system shows three different dots:
The ROUTE STATS GRAPH Widget will show you the same data
in a graphical view along with the %age of delivery status.
12
You can filter Destinations or vendor accounts to have more
detailed information, this one is very useful if you want to quickly
figure out Delivery issues on various routes.
By default, the Data is shown for the current date or you can
choose a date range as well
● It shows you the details of the Delivery Rate (DLR %)
and Actual Submission rate (ASR %).
By default, the Widget shows the data for all the Destinations for
which there has been any traffic on the current date
The CUSTOMER STATS GRAPH Widget will show you the same
data in a graphical view along with the %age of delivery status You
can filter Destinations or Customer accounts to have more detailed
information, this one is very useful if you want to quickly figure out
Delivery issues on various routes.
13
4. Settings
4.1 System Settings (Currency, Testing Service & Currency
Conversion API) To go to the System Settings page, just search for
it in the quick search or go to Settings > System Settings
Switch Name: This is the brand name that will be shown on all the
panels and emails sent by the system, just like a logo.
Footer Text: This text is shown in the footer of all the panels.
14
account from them if you want to use this, we can also integrate any
testing service of your choice, contact us for the same.
4.4 Currency
Use this setting to set up and enable various currencies in your
system & also you can set the minimum recharge amount for a
particular currency.
4.6 Country
Use this option to set up Tax values, and assign a Payment
gateway to be used for the customers belonging to these countries.
15
already, however you can still use this to create and update any
MNO prefix list.
4.6 DB Campaign
If you are serving a promotional messaging service along with your
number database, you can prevent the theft and misuse of your
target list of numbers, instead of doing the campaigns on behalf of
the customers or sharing an excel file of numbers with the users,
you can simply create a DB for a target list and your customers can
use it do campaigns directly from their customer panels, The
numbers in your Campaign DB will be shown in a masked way like
XXXXX8976 when they look at the DLR reports.
4.9 DB Maintenance
16
hours. You can either do it table by table or for all tables by clicking
on Rebuild All Indexes.
5. HLR
Home Location Register commonly referred to as HLR is a
database in a wireless network containing MSISDN information,
including service entitlements and call routing information.
17
Lastly, you will be determining the HLR cost before clicking on
placed at the extreme right of the window.
6. LCR
Least Cost Routing abbreviated as LCR is the process of selecting
the path for outbound termination of traffic based on the lowest
available cost for a given route.
LCR is auto-created by the system based on the rates provided by
the suppliers. For e.g, if 5 vendors have given rates for the
destination USA system will create LCR for the USA and will check
the least rate provided by the supplier out of the 5 suppliers and will
route the traffic accordingly.
6.1 LCR v2
In this section, we can add routes as per our requirements. The
difference between LCR and LCR v2 is that LCR is auto-created
while LCRv2 is manually created as per the requirement based on
rates and route quality.
For you to add New LCR, you have to follow the below-mentioned
steps:
18
Firstly you will be choosing a country/MCC from a dropdown list of
countries.
19
The first step will be to add a country/MCC from a dropdown list of
countries.
The LCR works on basis of the termination rates set by any vendor
account for a certain destination for the specified product type, (
Direct / SIM/ Wholesale / Spam, etc ), each product type maintains
a list of the possible vendor accounts in increasing order of the
termination rate.
This list can be viewed under LCR simulation. LCR simulation in the
quick search option). For any customer with routing set as LCR, all
the messages to this destination will be routed to the 1st vendor
with the least cost.
For you to manage LCR Simulation, you have to select the LCR
type, Route Type, MCC, and MNC before clicking on the
option.
20
Following the submission, you will find your LCR Simulation
appearing in increasing order as shown below:
7. Load Distribution
In load distribution, you share the traffic among different vendors.
For instance, if you want to distribute the traffic of a client among
different vendors for any reason, then you can distribute traffic
among vendors based on percentage, the total sum of which should
be always100%
This is what will appear on your screen after adding new load
distribution
21
8. Content Translation
Content translation is used when you want to translate any part of
the content sent by the client to some other content. For e.g It often
happens that you are asked that a part of your message can be
delivered, leaving out the rest of the information. This extracting a
part of the message is done using the content translation. By using
content translation you can translate any content to the content of
your choice as per the requirement.
22
Firstly click on the option after which a pop-
up window will appear where you will enter:
Customer
Original Keyword Regex
Translation Keyword
Match type
Similarly, you can replace any word in the message following the
above-mentioned steps by choosing Replace in MatchType option
in the pop-up window.
The process to add New Content Translation is the same for Retail
and Wholesale
23
To perform this task, you will click on option and add
The process is the same for both Block List Retail & Block List
Wholesale.
9. Voice Management
In Voice Management you get to convert text messages into voice.
Sometimes a retail client seeks to convert SMS into Voice, this is
where that task can be performed.
9.3 CDR
The call delivery report is shown in this section.
24
9.5 Logs
Here in logs, you can check all the logs which are associated with
the voice/SIP.
9.6 Statistics
This section will show you the total number of voice SMS, Total
voice SMS Answered, and CDR% as well
10 Administration
25
If you want to edit the role, click on icon
For adding a new admin user, you can click on tab upon
which a pop-up window like the one given below will appear. This is
where all the details of a user have to be entered before creating
the user profile.
26
10.3 Customer Notifications
This is used to send notifications to the clients over web panel and
email to notify them about any offer, downtime, Greetings, or any
other notifications as per your requirement.
tab.
Route Test
27
you have live numbers to test over which you can verify the delivery
by checking if the message is received in Inbox.
Test SMS
This is a third-party service where you can do the route test on the
virtual numbers which are generated by the Test SMS API and
delivery is verified in the Test SMS if the Receipt status is positive.
TelQ Telecom
28
This is what will appear while doing the Block Regex Testing
29
Here you can view the account logs of a vendor after selecting
Node, Vendor Account, Log Date, and Message Type followed by
clicking on Tab
Please note that logs will be visible here only if the logs for vendor
binds are active. Its recommended to keep the logs off unless you
want to troubleshoot the vendor connectivity issues.
In Vendor Logs you can check SMPP Client Status, Critical Logs,
and SMPP Logs as well.
30
10.11 Distribution Center Logs
In this section, you will be able to view logs of DC service & also
IMAP mail logs will reflect here.
In the same manner, you can receive Re-Push DLR after filling all
11 Invoice
It is a document sent by the seller to the buyer with the intention of
collecting payment for the services provided.
31
After clicking on the tab, a window, similar to the one
given below will appear:
32
11.4 View Incoming Invoice
This is similar to viewing invoices. Here you can check the incoming
invoices which have been generated by the system for incoming
traffic/MO traffic of the client.
What you have to do for the detailed report is to select the customer
and choose the start and end date before clicking on the
tab.
This is what will appear on your screen
33
12 Reports
12.1 Finance
34
The customer balance, Credit, and Transactions will be viewed
here.
Customer Balance
Here you will be able to check the balance, overdraft, and currency
that has been used. You just have to enter the name of a client.
In case you want to send a low balance alert, click on tab next
to the currency row.
Credit
This is a report that contains information about the credit activity.
Here in this report, we can check the Credit limit which has been
given to the customer. In addition to the credit limit, we can also
check Balance,and last recharge amount,
35
This is what your Credit Report looks like
Transactional
All the transactional activities will be shown here. By entering the
name, you will get: Balance Added, Currency, Amount Charged
and Credited, Tax Amount along with Processing Fee.
A transactional Report
36
Traffic Overview
By selecting a start and end date, you can view message parts and
Traffic Summary
The summary of the traffic will be viewed here. What you have to do
is to select the date, country, customer type, customer, route type,
Bilateral Report
If you have a Bilateral connection with any company which is
working as a client and supplier with you then In this report, you can
view SMS Sent and SMS Received and can compare the business
or traffic you have exchanged with each other. What you will do is
select the vendor with the start and end date to view the report.
After selecting the vendor with the start and end date, this is what
will appear on your screen:
37
Margin Report Detailed
In the margin report, you will be able to check total expenses and
earnings for a specific date range.
To view this report just select the start and end date to view a
detailed margin report.
Margin Graph
You can have a graphical view of your margin report in the margin
graph section.
38
Account Statement
This shows you the invoices sent and the amount that has been
paid to you by a selected customer and entity. The option of viewing
the statement and downloading it is available in this section.
Account Summary
All the information related to sent and received invoices is shown
here. You will also get to see payments sent and received along
with the balance of a selected vendor.
39
filters. Just select the account manager along with the start and end
Here you will get to see Message parts, client cost, termination
cost, and margin base of a selected account manager.
This is what will appear on the screen :
Retail Comparison
In this report, you can compare the margin and business given by a
particular account manager in different time periods. This report will
show if the business given by the account manager is growing or
declining by comparing the different time periods which has been
selected in filters.
Here is the sample:
40
Wholesale Comparison
This comparison is similar to retail, but here you will compare the
wholesalers instead of retailers.
AM – Margin Report
To view the margin report of a specific account manager, we click
on the profile of a manager and select the time period. This will
show SMS parts, client cost, termination cost, margin, and
payments of the selected account.
Here is what you will be shown on the screen:
This is what will appear on your screen after selecting a profile and
choosing the period:
41
Last Submission Report
In this report, you can view the last submission report of the client’s
traffic. If the traffic has been submitted by the client, the date and
time will be displayed in the last submit date column. If no traffic has
been sent to date by the client, the column will show No
Submission instead of a date.
12.2 Retail
This section exclusively deals with retail. Here the focus is on end
customer.
42
DLR Report
The delivery report of all users including resellers and clients can be
checked here. The process is almost the same for all three.
To view the report, you will select the date range, country, vendor
The DLR report will show the status of the report along with client
rate and cost like the one shown below:
43
Repushed DLR Report
This is that type of delivery report where you can check the Delivery
report of Repushed (resent) SMS.
The process is simple. You have to select the date range, DLR
Status, Country, Vendor Account, and MCC MNC for the report to
44
Besides for all users, the report can be viewed for resellers and
direct clients separately.
Reseller Stats
In the statistical report, the reseller’s SMS status will be shown. You
will be shown delivered and failed SMS along with SMS count,
Parts count, Billed Amount, and the currency in this report.
For viewing this report, you have to choose the Reseller Account,
Customer Traffic
45
Here we can get information related to the customer’s traffic. This
report will show you messages sent, termination cost, termination
currency, and client cost of a specific customer.
To view this report, choose the customer account along with the
12.3 Wholesale
12.4 Vendor
Here in this section, you will find traffic, stats, and a business report
of the vendor.
Vendor Traffic
46
You will be shown messages sent, message parts, cost, and the
currency used for a specific period.
To view this report, choose the vendor account along with the start
Vendor Stats
The status of messages whether delivered or failed can be viewed
here. You can also view the total number of SMS Count, parts
count along with cost and currency.
To view this report, select the vendor account, the start, and end
date along with the country before clicking on the view report
option.
47
Country Stats
Here you will get the country-wise stats of message parts for a
specific time period.
To view the country stats, you just have to select the date range
48
Vendor Business Report
Here you can view the detailed business report of a specific vendor.
You will get information regarding MCC MNC, Message count,
customer revenue, vendor revenue, and the margin of a selected
vendor.
To view this report, you just have to choose the start and end date
13 Blocked Destination
49
13.1 DND Manager
Here you can manage the Do -Not -Disturb-List by uploading the
DND list of a specific country.
To perform this task, you just have to select the country and click on
To manage white list retail, select the customer account and enter
phone numbers you want to white list separated by commas before
50
In case you want to remove any whitelisted number, click on tab
available on left side of the number.
51
Black list number, you will click on option available
there.
tab.
14 Email
52
The method of exchanging messages between people using
electronic devices through a network. This section will deal with
SMTP Manager and Email templates.
General Settings
For the creation of new accounts, General settings are used. You
can also change your forgotten passwords and send low-balance
emails.
Here you will enter the SMTP Username, password, server, port,
Here you will enter the SMTP Username, password, server, port,
The process for these settings is simple like the preceding ones.
Here you will enter the SMTP Username, password, server, port,
53
IMAP Settings
Using IMAP email the system will import rate itself from the email
account which has been set here.
For the IMAP settings, enter username, password, server, and port
15 Sender ID
54
A Sender ID is an alphanumeric name that identifies the sender of
an SMS.
tab.
tab.
55
If you want to add a new sender routing, click on tab
Following the click on a tab, a pop-up window will appear on your
screen asking you to select the customer, country, operator, vendor
tab.
Your screen looks like this after adding a new sender routing.
56
For overwriting, click on tab. Following the
click on a tab, a pop-up window will appear on your screen asking
you to select the customer, country, operator, regular expression,
tab.
16 Vendor Management
Here you will be able to manage your vendors. All the vendor
management is done here.
57
16.1 Outgoing SMPP
In this section, you will get to Add/ Edit/view the vendor profile and
do all the related changes you want to. This may include editing and
deleting a vendor. Further, you can also manage vendor payments,
bilateral relations, and invoices. To perform all these tasks, click on
the specific icons visible on your screen.
Outgoing SMPP
58
perform all these tasks, click on the specific icons visible on your
screen.
clicking on option.
59
After submission of details, you will get to see the changes made,
appear along with the date of creation on your screen.
60
the country, operator, vendor, normal text, Unicode text, and select
In case you want to edit text append, click on icon. And if you
17 Customer Management
61
Here we manage both wholesale and retail customers. You can add
a new customer and view the list of your customers here as well.
Once you have created a customer profile, you will see the client in
the Customer list, Then click on the menu option and go to
Customer SMPP accounts there you need to create customer
SMPP binds by filling in all the necessary details.
62
To add a new Reseller, click on tab and select a retail
client in the customer type section in the pop-up window. After
selecting a reseller, a slightly changed window will be displayed.
Here you will enter the company name, reference number, email,
support email, billing email, rate email, phone, currency, overdraft
limit, default SMS price, country, time zone, and alert amount
In the manage plan icon, you can add new rate plan detail. You
will be asked to type country, operator, rate, and SMS type before
clicking on tab.
19 Route Manager
64
For managing routes and adding a new one, a route manager is
used. Here you can create the manual rate plan with the 3 different
vendors at 3 different priorities for a particular destination. If the
client is assigned the manual route plan, then the system will route
the traffic as per the priority set in the plan.
20 Job Management
65
Any campaign run by resellers, enterprises, and clients of resellers
can be viewed here.
To check campaigns of all users, select the start and end date
along with sender ID(optional) and job status before clicking on
tab.
21 Sender ID Management
66
The requests sent for SenderID by retail clients and resellers can
be viewed here. The list of pending, approved and disapproved
Sender IDs can be tracked here. If the sender ID is approved here it
will be auto-assigned to the client who has requested the Sender ID
approval.
22 Template Management
The requests sent for templates by retail clients and resellers can
be viewed here. The list of pending, approved and disapproved
templates can be tracked here.
Besides showing the status of the template request, you get to see
the creation date as well.
23 Queue Management
67
In queue management, we can resend messages if the requirement
arises. For e.g, if the client's SMS is failed and he requests you to
resend the SMS from our end that can be done here.
To resend, select the start and end date, DLR status, customer,
country, operator, error description, vendor account, MCC, MNC,
You can also search the status following the procedure given
above. However, instead of clicking on resend at the end, you will
click on tab.
24 DLR Override
In the DLR override, you get to change the DLR status of
submission. You can change the DLR status of both Retail and
Wholesale DLR.
For a change of DLR status, select from the dropdown list, enter the
25 Pending Jobs
68
All your scheduled campaigns can be viewed here. They may be
either of resellers or clients. In this section, the job name and SMS
type besides other things are shown here.
Pending Jobs
69
70
71