Docs

MyLINK SMS API – Product Guide

The MyLINK SMS API is a robust, secure, and scalable messaging product that enables developers to send and manage SMS communications directly through LINK Mobility’s infrastructure. This guide will walk you through how to configure and monitor your SMS API usage from the MyLINK Portal. For information regarding the API configuration, refer to API Reference.

Overview

The SMS API is ideal for businesses requiring:

  • Reliable delivery of one-way or two-way SMS messages.

  • Centralized control of credentials and usage quotas.

  • Insightful dashboards for traffic monitoring and log analysis.

  • Secure access management through the MyLINK Portal.

All actions can be performed within the MyLINK Portal, without the need to contact support, unless otherwise noted.

Create and Manage API Credentials

Before sending messages via the SMS API, you must create API credentials tied to a specific account.

How to create credentials:

  1. Navigate to SMS API Product in the MyLINK Portal.

  2. Click Create Credentials.

  3. Add the name of the credentials.

  4. A client ID and client secret will be generated — store them securely.

Additional credential management features:

  • Regenerate client secrets

  • Deactivate credentials

Dashboard Overview

The MyLINK SMS Dashboard provides a comprehensive, real-time view of your messaging activity. It is designed to help you track delivery success, identify performance trends, and monitor key statistics related to your SMS traffic.

Whether you're managing large campaigns or day-to-day transactional messaging, the dashboard offers full visibility into both outbound (MT) and inbound (MO) SMS flows.

Metrics available:

  • Total messages sent

  • Total messages received

  • Delivery status breakdown (Delivery success, Delivery Failure, In Process)

  • Delivery failure breakdown (error status displayed)

  • Country-level traffic distribution

Use the built-in date range filter to analyze trends over time — up to 90 days.

Overview of Dashboard Components

1. Top-Level Summary Widgets

At the top of the dashboard, you’ll find summary boxes displaying the most important KPIs at a glance:

  • Messages Sent – Total SMS messages submitted.

  • Messages Delivered – Number of messages successfully delivered to recipients.

  • Messages Failed – Count of failed deliveries (e.g., unreachable numbers).

  • Messages Rejected – Messages blocked or rejected before submission due to format or validation errors.

2. Traffic Breakdown Charts

These visual elements help you understand delivery trends and campaign impact over time.

  • Volume Over Time
    A time-series chart that shows how your traffic evolved. Useful for identifying spikes or delivery issues.

  • Status Distribution
    Visualize the ratio of Delivered vs Failed vs In Progress messages.

  • Delivery over time
    Visualizes the volume of successfully delivered messages over a selected time range.

  • Failures over time
    Displays failed message attempts across time.

  • Top Countries
    Discover which countries receive the most messages from your account.

3. Inbound (MO) Widgets

If MO (Mobile-Originated) messaging is enabled in your account, you will see additional widgets:

  • MO Volume – Number of messages received from mobile devices.

  • Top MO Senders – Most active originating numbers.

  • MO Traffic Over Time – Helps visualize when users respond or interact with your SMS flows.

🖼 [Insert screenshot of MO widget layout]

4. Filtering & Customization

To help you drill down into specific data, a full set of filters is available across the dashboard:

  • Date Range
    Select from predefined ranges or custom periods.

  • Traffic Type
    Choose between MT, MO, or both.

  • Sender Name
    Filter results by specific alphanumeric sender or shortcode.

  • Country
    View traffic going to or coming from a specific destination.

  • Subaccount
    Focus on traffic by a specific customer/subaccount.

  • Status
    Filter messages by delivery status (Delivered, Failed, Rejected, etc.).

Export Options

You can export all dashboard metrics and charts as a CSV file using the Export button at the top right. This enables further offline analysis or reporting.

Message Logs Overview

The Logs section provides real-time visibility into every message sent or received through the MyLINK SMS API. This tool is designed for operational transparency, delivery validation, and issue resolution.

It offers full message-level traceability, showing exactly what was sent, when, to whom, and with what result.

Key Features of the Logs Interface

1. Search and Filtering

Easily narrow results using a range of filters:

  • Date and time range

  • Sender ID or recipient number

  • Message direction (MO / MT)

  • Message status (Delivered, Failed, Queued, etc.)

  • Channel (SMS / WhatsApp, etc.)

  • Country

  • User or credential used

You can combine filters to isolate specific incidents or audit message batches.

2. Table View

Each row in the Logs table displays key details of an individual message:

  • Timestamp (local or UTC)

  • Sender and recipient numbers

  • Status and delivery time

  • Direction (MO or MT)

  • Message content (for eligible channels)

  • Metadata like message ID, user, and channel

Clicking a row reveals Message Details, including raw payload (if enabled), delivery events, and full status history.

3. Export to CSV

Use the Export button to download your filtered logs in .csv format.

What’s included:

  • All visible log columns

  • Only the messages that match your current filters

  • CSV format, compatible with Excel or Google Sheets

Notes:

  • Export size may be capped for performance reasons.

  • Exported data includes metadata but not media attachments.

  • Bulk exports beyond UI limits may be available via API or support request.

Delivery Reports (DLRs)

The DLRs View provides a focused list of all delivery report events sent to your configured callbacks, helping you confirm delivery status at scale.

DLRs are essential for confirming whether a message was delivered, buffered, failed, or expired.

Features

  • View per-message delivery events

  • Filter by:

    • Date/time

    • Delivery status

    • Recipient number

    • Credential or project

  • Check callback status codes (e.g., 200 OK, 400 error)

  • See retry attempts and failures

This helps technical teams debug delivery or endpoint issues quickly.

Mobile Originated (MO) Numbers

You can configure and manage MO Numbers to receive inbound SMS from users. These are useful for 2-way campaigns, user input flows, opt-ins, and more.

1. Long Numbers

Long numbers are standard mobile numbers that users can text directly.

Key Features

  • Assign one or more long numbers to your account

  • Country-specific availability

  • Choose whether they are shared or dedicated

  • Link long numbers to:

    • Specific keywords

    • Auto-responses

    • Callbacks for real-time delivery

Use Cases

  • Customer service replies

  • Surveys

  • Campaign opt-ins

  • Keyword-based responses

2. Sub-numbers

Sub-numbers allow for number segmentation under a main shared number (e.g., 12345-001, 12345-002). Users send SMS to the main number, and sub-routing is handled internally.

Key Features

  • Add or remove sub-numbers from your projects

  • Define sub-number ownership

  • Set up keyword behavior per sub-number

  • Integrate with MO callbacks or inboxes

Use Cases

  • Shared campaigns across departments

  • Tracking multiple services under one shortcode

  • Lower cost than fully dedicated numbers

Short Codes

Short codes are special shortened phone numbers (e.g., 12345) used primarily for high-volume and marketing-grade SMS communication. They are ideal for campaigns, alerts, or promotional interactions where memorability and throughput are key.

Features

  • Available Per Market
    Easily view which short codes are assigned to your account based on region or product configuration.

  • Shared vs. Dedicated

    • Shared short codes: You can use assigned keywords to segment and route traffic.

    • Dedicated short codes: Fully owned by you, offering maximum control and brand consistency.

  • Management Panel
    From the product UI, you can:

    • View assigned short codes

    • Check configuration (linked keywords, projects, and callback behavior)

    • Manage routing and permissions

    • See carrier support or limitations per region

Use Cases

  • National campaigns

  • Two-way flows (e.g., “Reply YES to confirm”)

  • Time-sensitive promotions

  • Event or brand activation

Keywords

Keywords are terms (e.g., “JOIN”, “INFO”, “STOP”) that users text to your short codes, long numbers, or sub-numbers to trigger specific flows or actions.

They’re essential for 2-way SMS automation, user opt-ins, segmentation, and onboarding.

Features

  • Keyword Configuration

    • Create new keywords tied to specific short codes or numbers

    • Define routing logic: link to inboxes, callbacks, or autoresponders

    • Assign to projects or departments

    • Define response behavior (automated reply or system action)

  • Keyword Management

    • View keyword usage, assignment, and status

    • Deactivate or reassign easily

    • Filter by number or short code

  • Conflict Handling

The system prevents keyword conflicts across shared numbers and prompts for resolution.

Use Cases

  • Customer onboarding (e.g., “Text START to 12345”)

  • Promotions (e.g., “Text WIN to enter”)

  • Segmentation (e.g., different keywords = different products)

  • Support routing (“HELP”, “INFO”)

Quota Management

The Quota section in the portal provides a clear, structured view of your SMS traffic limits per country. It is divided into three distinct groups:

1. Unlimited Countries


These are countries where your account has no volume restrictions. You can send SMS freely without worrying about daily or monthly limits. The list displays each country and its status as unlimited.

2. Limited Countries


This section shows countries where message volume is capped. For each country listed, you can see:

  • Daily limit (number of messages allowed per day)

  • Monthly limit

  • Used messages for both daily and monthly quotas

  • A visual bar indicator showing percentage of usage

  • Warnings when thresholds are nearing or exceeded

This allows real-time tracking of usage to avoid delivery issues in regulated or cost-sensitive destinations.

Blocked Countries


Countries in this list are restricted for your account — no SMS can be sent to these destinations. The system enforces this block automatically to ensure compliance or contractual restrictions.

Filters and sorting are available across all sections, allowing you to:

  • Search by country

  • Group by region

  • Sort by usage or limit values

Scheduled SMS Sendings

This section of the portal displays a list of all SMS messages scheduled for future delivery via the SMS API. Users can access it by selecting "SMS API" from the main navigation and navigating to the "Scheduled SMS sendings" tab.

The view is presented as a table that lists each scheduled sending with the following columns:

Tag


A user-defined label used to group scheduled messages. This tag helps organize and categorize different scheduled batches. When hovering over the info icon next to the tag, a tooltip appears with additional guidance on its purpose.

Scheduled date and time

Indicates the exact moment the message is planned for delivery, based on what was registered through the API.

Number of recipients

Shows how many recipients are targeted in the scheduled message batch.

Registered

Displays the date and time when the message was registered in the system via the API.

To help users locate specific sendings, the table includes a search function based on the Tag. If there are more than 10 scheduled items, pagination is automatically added to ensure a clean and navigable experience.