Documentation

1.Lark Router Overview #

The Lark Router MMS Gateway allows organizations to manage all the MMS messaging routes (binds).

Documentation

 

2.MMS Overview #

Multimedia Messaging Service (MMS), is intended to provide a rich set of content to subscribers (pictures, audio, games, etc). It supports both sending and receiving of rich content to mobile devices. MMS is a non-real-time delivery service, much like SMS or email. The service utilizes a store-and-forward usage model between providers.

MMS is designed to be transported largely over IP rather than traditional GSM (SS7) networks. It is also designed to interoperate with other IP services such as email and WAP. In fact, MMS messages are typically transported over WAP, and are encoded using WAP MIME formats.

Multimedia messages can be originated by or terminate to end-user client devices (i.e. MMS-enabled phones) or third-party applications (typically called value added service providers). In the MMS architecture, the MMSC acts as the message-switching system within the core network, while the Lark Router acts as the message dispatch and content management system on the VAS (third party) side. The overall architecture is shown below.

The elements involved can be summarized as follows:

  • MMS Client: A device through which the user receives or sends multimedia messages. This might be a phone or a PC-based MMS client. The Client sends messages to and receives messages from the MMSC using WAP/HTTP as transport.
  • MMS Gateway: Switches messages between different MMS clients and between MMS and Email. The Gateway may also interface with other gateways to exchange messages destined for foreign networks. This is also more properly known as the MMSC.
  • MMS Server: This component provides persistent storage of messages on the network. Typically users can access stored messages via a web interface.
  • Other MMS Systems: Other systems, such as Third Party MMS systems (e.g. MMS VAS providers) can interface to the MMSC to receive and send MMS content. The Interface used is termed MM7.
  • SMSC: The MMSC utilizes WAP Push to send notifications to MMS Clients. These are typically sent using SMS as the bearer service, hence the need for a link to a Short Message Service Centre.

Typically, the message cycle begins with a user sending a multimedia message (MM) from the MMS client. The client must be configured for MMS, which includes bearer settings (i.e. GPRS or GSM/CSD settings), WAP gateway address and MMS Gateway address (a URL). On receipt of the message, the MMSC decides how to deliver the message (e.g. to another MMS client or to a VASP), and proceeds to dispatch the message. A VASP may also originate a message to the MMSC, for onward delivery.

An MM is typically a multi-part message with pictures, sound, text and other media. Each part of the message is identified by media (MIME) type, name and/or Content ID. Usually the message is of a multipart/related MIME type, with the start element being a SMIL (Synchronized Multimedia Integration Language) part that controls how the message should be displayed.

When submitting a message, the MMS client indicates the intended recipient list, but usually not the sender address, which the MMSC retrieves from the WAP gateway. Like Email, a single MMS can specify multiple recipients (MSISDNs and Email addresses), and it is up to the MMSC to ensure correct delivery to each of the recipients.

When the MMSC receives a message destined for an email address, it typically re-codes the message as standard MIME and passes it on to an SMTP server for delivery. Email messages received are similarly re-coded as MMS and forwarded to the relevant MMS Client.

When the MMSC receives a message destined to MMS Clients in the area served by the MMSC, the message is stored and an MMS notification sent to the recipient via WAP Push. On receipt of the notification, the client typically fetches the message via a URL provided in the notification.

When a recipient requests an incoming MM from the server, it indicates to the server its capabilities for a User Agent Profile URL. The profile data includes such things as supported media types, screen size, supported character sets, etc. Typically, the MMSC will re-code the MM to suit the client’s capabilities before returning the message. Messages destined to email may also be re-coded to make them more suitable for email readers.

The MMSC may also interface with a subscriber database, which controls message delivery and billing. The subscriber database will provide such information as which subscribers are provisioned for MMS, tariffs, etc.

On the VASP side of things, typically the content provider receives a request MM from a subscriber and must respond with an MM. The content to be sent back depends on the contents of the request.

3.Gateway Status #

Documentation

Provides a dashboard for the Lark Router, including:

  • Current Software Version
  • License Information
  • MMS Gateway Status
  • SMS Gateway Version and SMS Gateway Status
  • Server Network Ports display which ports the Lar Router is currently configured to need.
  • Plot graphs show message throughput by Connections and the SMS Gateway

4.Configuration #

4.1.Core #

Host Name and License Key

Documentation
  • DNS Name Used with MM4 Messaging.
  • License-Obtain from Skycore.

Logging location and details

Documentation

 

  • Where to Log– File location to store system logs.
  • What to log – Detail should only be used when debugging as it will increase file storage and may impact performance.

SSL Certificates and Keys

Documentation

 

  • Upload SSL Certificate information for Lark Router

HTTP Request Timeout Settings

Documentation

 

  • HTTP Client request timeout-How long should the Lark Router wait to timeout.
  • HTTP Server Timeout– Lark Router will close the ports if no response in set time.
  • HTTP Proxy Host– If network requires an HTTP Proxy to access external URL’s.

4.2.Queues, CDR and Caching #

Contains queue information such as: Storage Location, Process Frequency, Retry timer, Delivery Attempts, Default Message Validity, Maximum Validity, Priority Factor.

Queue Management

Documentation

 

  • MMS Binary Storage Location-Where Lark Router binary files are stored.
  • Process Queue Every– How frequently to process the queue.
  • On Message Delivery Failure retry after– How long to wait before retrying.
  • Maximum Deliver Attempts-How many attempts to retry.
  • Default Message Validity– Validity length of message if none is set in the message itself.
  • Maximum Validity Period– System Wide maximum validity length, prevents message values from setting the validity length higher
  • Priority Factor= Optional.  Priority Factor= Default 10. This is used to control message priority for incoming VASP messages: The mmsc component maintains statistics on the number of outgoing messages to each (carrier) bind, grouped by VAS ID. When a VASP injects a new message, the stats are consulted to determine the priority to assign the new message: If the queue length for the current VAS ID is less than factor X the (carrier) bind throughput, then the system checks if there is at least on VAS ID on the carrier that has a larger outgoing queue than the current VAS ID. If there is at least one, then the injected message can be given a slightly higher priority. This priority is calculated as follows: A count is made of all VAS ID queues on the same bind whose outgoing queue length is greater than the queue size for this VAS ID. The new message is given a priority of 4 + the count. This ensures that all VAS who are not performing large message submissions are prioritized over the heavy users, with the slower-pushing VAS getting higher priority.
    • So the higher the priority on a bind, the more we allow slow senders to lag behind the high throughput senders.

Billing and CDR Processing

Documentation

 

  • How Long to Store CDR– Number of days to keep the CDR’s on the Lark Router
  • External CDR API URL– Offload CDR’s to another location (Refer to CDR Logging Webhook API Section for more details)
  • External Billing API URL– Call third party billing API to charge for messages, (Refer to Billing Webhook API Section for more details)
Documentation

 

  • Cached Content Storage Directory– Static cache location
  • Max Time to Live– How many seconds a message can stay in cache
  • Automatically Purge Contract that has been in cache for more than– How long to wait to purge old messages

REDIS.io Cache Server

Documentation

 

  • REDIS Server Host & Port – Location of the database server
  • Limit Number of Connection to-Maximum number of connections to the database

4.3.Protocols and Ports #

Carrier Ports & Services, Configure port numbers for carriers

Documentation

 

  • VASP Ports & Services, configure port numbers used for VASP Connections
  • HTTP Based Server Administration. Configure Admin Port number, IP Address restrictions and Admin password.
Documentation

 

  • MM1-Speccific Settings, Configure MM1 settings such as host name, SMS URL, and Queue management.

4.4.Advanced #

Documentation

 

Set error call back URL– When an error occurs (e.g. bind endpoint unreachable), the error details can be sent to an external URL in real time. By default, the error is written to the log file.
Custom Notification Headers Prefix: When Lark passes a DLR to a VASP, it can add extra HTTP headers to the call which contain additional information such as received timestamp. This is the header prefix.

5.Kannel Configuration #

Kannel is the SMPP (Short Message Peer to Peer) gateway that delivers SMS text messages to the carriers.

5.1.Core #

Documentation

 

  • Loggings:
    • Where to log the events.
    • What level of detail should be logged.
      • Note: Debug Logging can be resource intensive and should only be used for troubleshooting.
  • Ports:
    • Mobile Terminating SMS Port
    • What ports to access the gateway on.

5.2.Optional SMPP Parameters #

Documentation

 

  • If there are customer parameters that need to be passed though to the SMPP Connection such as Carrier ID, Program ID etc.

6.MMS Routing Configuration #

Configuration parameters for MMS Routing.

6.1.MSISDN Normalization #

Lark Router supports matching prefix numbers and  stripping and replacing them to provide a consistent numbering plan. Such as removing 001 and replacing it with +1

Documentation

 

 

6.2.MT Routing #

The Lark Router supports simple static routing or complex dynamic routing via a routing Webhook for Mobile Terminating Messages allowing third party systems to determine the best route.

Documentation

 

Note: to configure routing please see Routing Webbook Section.

6.3.MO Routing #

The Lark Router supports simple static routing or complex dynamic routing via a routing Webhook for Mobile Originating message allowing third party systems to determine the best route.

Documentation

 

Note: to configure routing please see Routing Webbook document.

7.VASP Binds #

Overview

The Lark Router can send messages between routes configured in the system. The routes are made via binds.  The Lark Router supports:

  • VASP (Value Added Solution Provider) Binds. Third part connections to provide content.
  • MMSC (Multi-Media Service Center) Binds. Carrier message centers from delivering messages to mobile devices.
  • SMSC (Short Message Service Center) Binds. Carrier text message centers for deliver alerts.

How to configure a Lark VASP Bind

To configure this, go to

VASP Binds

Enter the Bind Name, the Bind ID. choose MM7, MM4 or HTTP and click Create

Documentation

 

You may now enter the details received from the Provider.

Documentation

 

 

 

VASP URL URL Location given by the provider
VASP Logon Credentials Username and Password provided.
MT MMS and DLR Settings
VASP Authentication to us Username and Password required to receive messages
Default MT Message Validity (Seconds) How long is a message valid before expiring
Maximum MT Message Priority Limit the priority of the messages sent to the VASP 1-3
MT Network Traffic Limits
Limit VASP MT Throughput to: Throttle the messages to this VASP Messages per second
Limit per-second connections to VASP to: Limit the number of connections to the VASP to this value Connections per second

 

 

ADVANCED

Documentation

 

MM7-Specific Settings
MM7/SOAP Version for this Bind If different than default Optional
MM7 XML Name Space Enter XML Namespace string Optional
Use strict XML Namespace Prefixes on SOAP Tags If VASP Requires it for all tags
Require VASP to process all SOAP Elements Set to On to reject any message where any element is not understood
Carrier ID HTTP Header Name in MT Request Carrier Indicator HTTP header Optional/td>
Receiving Device Identifier in DLR Sent As DO Not send Identifier,Send Profile URL, or User Agent Default is Do Not Send<
Send Custom MO/DLR Information to VASP “On” system will use eXtension HTTP headers
What to Log Default,Everything (Debug), Information, Warnings Errors, Crash Reports Increased logging will impact system performance
Allow VASP to Specify Carrier Bind in MT requests If set to true, VASP can include the carrier bind to deliver the message to
Send Intermediate DLR to VASP Yes to send intermediate DLRs, default will send only delivery messages
Allow VASP to set Carrier Bind Authentication Parameters using extension HTTP Custom User Name will override carrier authentication for User Name Customer Password will over the Carrier Authentication for password
Discard all MO Messages Enabled will not deliver any MO Messages, used for testing

8.MMSC Binds #

Overview

The Lark Router can send messages between routes configured in the system. The routes are made via binds.  The Lark Router supports:

  • VASP (Value Added Solution Provider) Binds. Third part connections to provide content.
  • MMSC (Multi-Media Service Center) Binds. Carrier message centers from delivering messages to mobile devices.
  • SMSC (Short Message Service Center) Binds. Carrier text message centers to deliver alert notifications.

How to configure a Lark MMSC Bind

To configure this, go to

MMSC Binds

Enter the Bind Name, the Bind ID. choose MM7, MM4, MM1* or HTTP and click Create

Documentation

*MM1 Bind requires an additional license, Binds types that are unlicensed will not accept traffic or process their queues for delivery. If MM1 is required please contact support.

You can then configure the parameters provided by the MMSC Provider

Track Notification DLR’sSet the router to track notifications for Delivered to phone, Not delivered to phone, delivered to SMSC, Not delivered to SMSC
Use Local Kannel SMS Gateway for MM1 PushEither use the Local Kannel SMS Gateway or connection information for the SMS Gateway to use.
Send SMS SMSC ParameterOptional Bind specific parameters that may be needed based on your provider.

Fields Description Notes
Bind Name Name of the Bind Required
Group ID Lark Router can group multiple binds to a single route, allowing the system to load share as necessary.
Bind Type MM1. MM4, MM7 or HTTP Required
SMTP Host (including Port) If the Bind type is MM4 you need to enter the location for SMTP connection Required
MMSC URL The Full MMSC URL from the Provider Required
MMSC Logon Credentials Username and Password for Provider.
MO MMS and DLR Settings
MMSC Authenticates to us as Lark Router Username for the Connection
Limit MMSC Connections by IP Blocking or limiting connections based on IP Optional
Only accept MT MMS to these short codes or long codes Limit MT MMS to these numbers, separated by a comma Optional
Reject MT MMS to these Short Codes and Long Codes Reject MMS to these specific short codes, separated by a comma Optional
Default MT Message Validity (seconds) How long should an MMS message be valid for Optional
Maximum MO Packet Size Limit the packet size of messages received, for MM4 it will be the limit to the email size. Optional
MSISDN Normalization Rules Special rules for normalizing phone numbers i.e. (Adding country codes etc.) Optional
MT MMS Settings
Limit MT Throughput to Limited messages based on allowed by the provider
Maximum MT Packet size Restrict message size based on limits from the provider
Limit # of concurrent connections to carrier to: Limit concurrent connections based on provider limits
Limit per second connections to: Number of connection limits to the provider
Optional Network Timeout Settings Reset the connections if they become to slow,
Maximum MT Message Validity (Seconds) Maximum time a message will wait to be delivered
MM7 Specific Settings (Required for MM7)
VASP ID Name of the Bind Used to identify the bind.
Reuse HTTP Connection Used to Keep the HTTP connection up. If the operator allows for Multiple MT messages per http session.
MM1 Specific Settings (Required for MM1)
Use HTTPS-based Notification URL When enabled MT MMS download URL will be HTTPS
Perform Content Adaption When enabled you can set Minimum Video and Audio bit rates
Send Delivery Report When MMS is Downloaded Router when send the report once the message is retrieved, as opposed to waiting for the device to send it,

 

 

9.SMSC Binds #

Overview

The Lark Router can send messages between routes configured in the system. The routes are made via binds.  The Lark Router supports:

  • VASP (Value Added Solution Provider) Binds. Third part connections to provide content.
  • MMSC (Multi-Media Service Center) Binds. Carrier message centers from delivering messages to mobile devices.
  • SMSC (Short Message Service Center) Binds. Carrier text message centers for deliver alerts.

How to configure a Lark SMSC Bind

To configure this, go to

SMSC Binds

Enter the Bind ID. choose SMPP Version and click Create.

Documentation

 

Once created you can select the ID and update the following configurations as needed

Fields Description Notes
SMPP Version 3.3, 3.4 or 5.0
SMSC Host URL
SMSC Port Port Number
SMSC MO & DLR port If MO or deliver_sm packets should be routed to a different port.
SMSC Credentials Username and Password for connection
Number Format
Automatic Sender Number Type Detection Should the router determine the sender type based on formatting
Sender Number Type SMS Provider will tell you what this needs to be,
Sender Number Plan SMS Provider will tell you what this needs to be,
Destination Number Type SMS Provider will tell you what this needs to be,
Destination Number Plan SMS Provider will tell you what this needs to be,
Permitted Destination Number Prefixes Restrict messages to only these prefixes
Disallowed Destination Numbers Block messages to these prefixes
Miscellaneous Settings
SMPP System Type Parameter System type such as VMA, OTA
SMPP Service Type Such as WAP
MO SMS Default Character Set GSM, Unicode etc.
SMSC ID Message format Modify the Message ID for the DLR message
Link Keep alive Interval Send link messages to the keep the link active
Max Throughput (MT) Maximum messages per second to send through the link.

 

10.Live View #

Lark Router supports live view monitoring of the messages flowing between the different binds.

10.1.Carriers #

View message throughput to Carrier Binds

Documentation

 

10.2.VASPS #

View message throughput to VASP Binds

Documentation

 

10.3.SMSC’s #

View message throughput to SMSC (SMPP-Short Message Peer to Peer) Binds

Documentation

 

11.Queues #

View Messages waiting to be delivered

11.1.MMS Queue #

Documentation

 

Messages waiting to be delivered through the Current binds.

11.2.MMS MM1 Queue #

Documentation

 

Messages waiting to be delivered via MM1 link for messages being delivered to the Mobil Station

12.CDR Stats #

Review Message counts by bind, by carrier, by short code and by date range. Full CDR information is also available.

12.1.Carrier Stats #

You are able to see the message count for your carrier binds. Choose a date and select show stats to see the message count for all of your carrier binds on that day.

Documentation

or you may choose a bind,  and then you are able to enter a date range where you will see the message counts by short code.

Documentation

12.2.VASP Stats #

To view a message summary for all of your VASP connections, choose a date and click Show Stats.

Documentation

Or you may select a VASP Bind and enter a date range. You will see a message count per short/long code. You may also filter a particular short/long code.

 

Documentation

12.3.Full CDR #

Review currently stored CDR’s. Choose your date range and click filter.

Documentation

You may also filter based on Sender, Receiver, Source Bind, Destination Bind, Status and or Queue ID.

13.Administration #

Administration Section

13.1.Admin Users #

Create, Edit and Update Administrative Users.

Documentation

 

13.2.Import/Export Configuration #

Lark Router allows you to export your current configuration and restore it later if there is a need.

Documentation

 

Caution-Importing will overwrite all existing configurations.

14.Log Viewer #

View current system logs for the Lark Router, Kannel SMPP Gateway and HTTP Gateway.

Documentation

 

 

15.Test MT MMS #

Lark Router provides the ability to test your carrier connections. This is useful during configuration as well if any integration testing is needed.

Documentation

MMS Content: Choose an image, video or text file to be sent during the test.

From: Long or Short code to send the message from.

To: Specific number to send the test message to, if you chose Multiple recipients you can load a CSV file with up to 100 numbers to send the test message to.

Send From (VASP): Which VASP bind the message should be sent from. This will use all of the settings associated with that bind and be logged to the stats of that bind.

Send via (Carrier): Which Carrier bind to use to deliver the message. This will use all of the settings associated with that bind and be logged to the stats of that bind.

Optional Parameters

VAS ID: If a specific VAS ID is needed for the test

Service Code: If a specific Service code is needed for the test

 

MT Test Results

A Summary of the recent tests, Clearing the records removes the results from the system

Documentation

16.Logout #

Logout of the Lark Router Portal.

17.Webhooks #

The Lark Router supports advanced webhooks or API’s to expand functionality.  The third party system will need to be configured to support those API’s. A description provided for each one.

17.1.Mobile Terminating Message Routing #

How to configure Static MT Routing.

Configuration → MMS Routing → MT Routing

Select Yes for Static Routing

Enter the Destination prefix (As many of the digits you would like to match on. And the carrier bind you want those messages to go to. Then click Add.

Documentation

 

How to enable the MT Dynamic Routing

The Lark Router will use a JSON HTTP POST to pass the message information to determine where it should be routed.

Configuration→ MMS Routing → MT Routing

Uncheck the Static Routing

Enter the URL where the JSON HTTP POST should be directed to.

Documentation

Fields

Field Description Values Required
phone-number Originating Number Required
shortcode Destination Short code Required
Message-subject Subject of the message Required
bind_id ID of the bind that message was received on Required
direction Mobile Originated or Mobile Terminated MO/MT Required
message-id Unique Message Identification number Numerical Required
The response to the POST should be in plain text with yes and the mmsc_id of the bind to route the message to “yes,mmsc-id” .

Values separated by a Comma.

No response or time out will result in the message being rejected.

Note: mmsc-id is the destination MMSC configured in the Lark Router

Example

{"phone-number": "165123456",
"shortcode": "555", "message-subject": "xyz123", "bind-id": "carrier1",
"direction": "MO",
"message-id": "00001", }

 

Test Routing

The Lark Router supports a test function, Enter the originating Number and the Designation number and it will determine the route based on the configured rules.

Configuration –> MMS Routing –> MO Routing (or MT Routing) –> Test Routing Settings

Documentation

 

 

17.2.Mobile Originating Routing #

The Lark Router can route based on Short codes (Default) or Dynamically based on the Results returned from the JSON HTTP POST.

Route based on Short code:

Configuration → MMS Routing –MO Routing

Make sure Route MO Based on Short/Long Codes is set to Yes;

Enter Short Code and the VASP Bind it should use, click add.

Documentation

 

How to configure Dynamic Mobile Originating Routing

Configuration → MMS Routing →MO Routing

Set Route MO Based on Short/Long Code to No

Set the URL that the Lark Router should direct the JSON HTTP POST to.

Documentation

 

Fields

Field Description Values Notes
phone-number Originating Number Required
shortcode Destination Short code Required
message-subject Subject of the message Required
bind_id ID of the bind that message was received on Required
direction Mobile Originated or Mobile Terminated MO/MT Required
message-id Unique Message Identification number Numerical Required

The response to the POST should be in plain text with yes and the vasp_id of the bind to route the message to “yes,vasp-id”

No response or time out will result in the message being rejected.

Example

{"phone-number": "165123456",
"shortcode": "555", "message-subject": "xyz123", "bind-id": "carrier1",
"direction": "MO",
"message-id": "00001", }

 

Test Routing

The Lark Router supports a test function, Enter the originating Number and the Designation number and it will determine the route based on the configured rules.

Configuration –> MMS Routing –> MO Routing (or MT Routing) –> Test Routing Settings

Documentation

 

 

 

17.3.CDR Webhook #

Overview

The Lark router supports a CDR Webhook to allow Providers to collect, maintain, report and store events based on their corporate policies. An HTTP POST using JSON is available. This webhook is called when an MT message is delivered, expired or rejected. For MO it is called when the message is forwarded to the VASP.

To configure this, go to

Configuration ->Lark -> Queues, CDR & Caching

Documentation

 

Set External CDR API URL to the URL that the Lark router will post the billing event to.

You may also change how long the Lark Router will store the CDR’s in the server. The default is 365 days.

Once the message is received (The webhook receives and HTTP 200) the next event will be posted synchronously.

CDR Parameters

Field Description Values Notes
message-date Date/Time in UTC message is sent “YYYY-MM-DDTHH:MM:SSZ” Required
cdr-date Date/Time in UTC CDR is sent “YYYY-MM-DDTHH:MM:SSZ” Required
source-bind Incoming message route Required
destination-bind Outgoing message route Required
from Originator Required
to Destination Required
size Message size Bytes Required
message-type Send/receive/ content m-send-request; m-send-recv Required
message-priority Message sent with High Priority or Low priority High/Low Default =Low Optional
carrier-message-id Provided by the carrier on MM7 link, default value for MM1 Optional
delivery status Delivery Status (Carrier messages only) Retrieved/Failed Optional
dlr-status Delivery Status (Carrier messages only) Expired, Failed, Unreachable, Retrieved, etc. Optional

Message Parameters

transaction id Unique identifier Sequential number Required
mms-version Version of MMS encoding 1.00 Default
content-types Text, pictures, audio List of content types in message Required
delivery-report Was a delivery report provided Yes/No Required
message-type Send/receive/ content m-send-request; m-send-recv Required

Envelope Parameters

priority Priority Indicator 0 or 1 Default 0
direction Mobile Terminated or Mobile Delivered MO or MT Required
message-id ID number given to the message by the carrier Available Only with DLR Optional
attempts Attempts made to deliver the message Available only with DLR Optional

Example:

{
"cdr-params":{
"message-date":"2019-02-13T10:47:03Z",
"cdr-date":"2019-02-13T10:49:03Z",
"source-bind":"newscorp2",
"destination-bind":"local",
"from":"111",
"to":"222",
"size":4494,
"message-type":"MMS",
"message-priority":"low",
"carrier-message-id":"201902131046411550044001",
"transaction-id":"e55670WZNo",
"delivery-status":"Sent"
},
"message-params":{
"mms-version":"1.0",
"delivery-report":"Yes",
"content-types":[
"application/octet-stream"
]
},
"envelope-params":{
"direction":"MT",
"priority":"0",
"attempts":"2"
}
}

 

 


17.4.Billing Webhook #

Overview

The Lark router supports a Billing Webhook to assist Providers in billing their clients for message traffic. An HTTP POST using JSON is available.

To configure this, go to

Configuration→Lark → Queues, CDR & Caching

Documentation

 

Set External Billing to the URL that the Lark router will post the billing event to.
and
Choose when the billing event should be posted.

  • On MMS Submission to the Gateway.

This is the default behavior as all messages counted in licensing totals and will be invoiced to the provider,

  • On MMS Submission to the Destination bind.

This would be used when only forwarded messages are to be billed to your customer.

  • On MMS Delivery to Destination Phone or VASP (DLR is received)
    Billed upon delivery (Success).

Once the event is received (HTTP 200) the next event will be posted this is a synchronous process.

Field Descriptions

Billing Parameters

Field Description Values Notes
message-date Date/Time in (Zulu) UTC “YYYY-MM-DDTHH:MM:SSZ” Required
source-bind Incoming message route Required
destination-bind Outgoing message route Required
from Originator Required
to Destination Required
size Message size Bytes Required
message-priority Message sent with High Priority or Low priority High/Low Default =Low Optional
dlr-status Delivery Status (Carrier messages only) Available only when DLR is received Optional

Message Parameters

transaction id Unique identifier Optional
mms-version Version of MMS encoding 1.00 Default
content-types Text, pictures, audio List of content types in message Required
message-type Send/receive/ content m-send-request; m-send-recv Required

Envelope Parameters

priority Priority Indicator 0 or 1 Default 0
direction Mobile Terminated or Mobile Delivered MO or MT Required
message-id ID number given to the message by the carrier Available Only with DLR Optional
attempts Attempts made to deliver the message Available only with DLR Optional
Notes:
– carrier-message-id: The message ID on the carrier side. This will only
appear for messages to a carrier
– dlr-status: The delivery status (for a DLR only)
– delivery-status: For messages to a carrier this will indicated if the
message was accepted for delivery or rejected.

 

Example:

{
"cdr-params":{
"message-date":"2018-11-16T10:27:34Z",
"source-bind":"mm1_test",
"destination-bind":"testcorp",
"from":"111",
"to":"222",
"size":56,
"message-type":"DLR",
"message-priority":"low"
},
"message-params":{
"status":"Forwarded",
"mms-version":"1.0",
"content-types":["application/octet-stream"]
},
"envelope-params":{
"direction":"MO",
"message-id":"e12c38iyKl",
"priority":"0",
"attempts":"1"
}
}

 

18.SMS to MMS Conversion #

Overview

Lark Router is a lightweight message protocol router that can be installed on-premise or hosted in the cloud.  The Lark Router software gives marketers the ability to send Multi-Media Messages (MMS) messages to any SMS/MMS aggregator through Message Campaign the same way they send regular SMS messages. MMS messaging enables marketers to send pictures, videos and over 10,000 characters of text in a single message.

Configuration

Lark Router is configured to receive MMS messages from your Message Campaign via SMPP (Native to most Campaign Managers) and converts those SMPP messages to MM7 or MM4 protocol. Your aggregator MMS connection is setup in the Lark Router as a standard MM7 or MM4 bind. Once the SMPP request is received, it is converted into MM7 or MM4 message, and instantly routed to the aggregator who delivers it to the handset. If you know how to setup and send an SMS message in Message Campaign, you can send MMS messages the same way simply by adding the path to an image in the message.

Diagram

Documentation

Example Photo

Adding a URL to a Graphic allows the lark router to convert and deliver a Multi-Media message to your customer.  You can even add a clickable URL. Supported formats are JPG/JPEG, GIF, and PNG.

Example:

Documentation

What is delivered:

DocumentationDocumentation

Example Video

Adding a URL to a Video  allows the lark router to convert and deliver a Multi-Media message to your customer.  Mp4 format is supported and video files should be under 1 meg, or other limits set by your provider.

Example:

Documentation

What is delivered:

DocumentationDocumentation

Technical Notes

If installed on Premise, the Lark Router will connect to register.larkrouter.com on port 443 to verify the license key / registration credentials and provide message counts each hour for billing purposes. No message or other connectivity data is transferred to the lark registration server. 

Suggest Edit