Hungary MO-Initiated Subscriptions

This document is designed to help you integrate MO-initiated subscriptions into your application. Before you begin, you will need to contact MessageCloud's support team via help@messagecloud.com to register your keyword.

Overview

The below diagram shows the expected flow of messages in the process.

The customer sends a MO with [KEYWORD], where [KEYWORD] is your keyword.
MessageCloud sends a confirmation MT to the customer, if the user does not opt out the subscription is started.
MessageCloud activates the subscription for the customer and forwards the original message containing the keyword to the merchant.
The merchant sends a free welcome message to the customer via MessageCloud, containing the price, length and interval of the subscription.
The merchant sends chargeable MT messages to the customer via MessageCloud at the subscription intervals defined in the welcome message.
MessageCloud notifies the merchant of charging success or failure with a delivery report.
The customer can opt out of the subscription by sending STOP.
A notification of opt-out is sent to the merchant
The merchant sends a free confirmation of opt-out message to the customer. If this is not sent within 30 seconds of receipt then MessageCloud will reply on your behalf.

Message Requirements

There are strict rules regarding the messages that will be sent to the customer during the subscription process.

Opt-in Confirmation Message

Please note that these messages are automatically sent out to the customer by MessageCloud.

Before the activation of the subscription, the customer will be sent a free notification with the following information:

Price per message and content delivery frequency.
How to unsubscribe from the service.
If the service is wap push, a warning that GPRS is charged separately for data transfer.
If the service is for adults only (18+).
A customer care phone number and your company name.

Integration Details

The following section details how you can achieve the MO-initiated subscription model using Gateway . Due to the nature of Hungary's message flow, there are some extra parameters you should send to the API in certain circumstances.

Firstly, when the customer opts into your subscription service, they will be sent a free message by MessageCloud asking them to confirm the opt-in. Only after the customer has confirmed this opt-in will the original message be forwarded to you as detailed in Receiving a Message. It is at this point you should send the customer a welcome message.

Sending a Content Message

Now that the welcome message is sent to the customer, you can send your subscription content messages according to your agreed subscription interval.

Variable	Type	Contents
`reply`	Integer	`0`
`id`	String	The format of the `id` string should be `[message_id]\|[your_callback_id]`, where `[message_id]` is the value of `message_id` you received in the opt-in MO and `[your_callback_id]` is the ID of the message in your platform. If you do not wish to use `[your_callback_id]`, you should set this to a random string.
`value`	Float	The value of your subscription content message.
`currency`	String	`HUF`

Sending a Goodbye Message

When the customer opts out of your subscription service, you will be sent an MO containing the word STOP according to the information provided on Stop Requests.

From the time you receive the MO, you will have 30 seconds in which to reply with your goodbye message otherwise MessageCloud will automatically send one on your behalf.

The following parameters should be sent to Gateway, in addition to the required parameters detailed on Sending a Message:

Variable	Type	Contents
`reply`	Integer	`0`
`id`	String	The format of the `id` string should be `[message_id]\|[your_callback_id]`, where `[message_id]` is the value of `message_id` you received in the opt-in MO and `[your_callback_id]` is the ID of the message in your platform. If you do not wish to use `[your_callback_id]`, you should set this to a random string.
`value`	Float	`0.00`
`currency`	String	`HUF`
`command`	String	`G` (where `G` stands for Goodbye message)

You will receive a SUCCESS in the body of the HTTP response if the request was successful.