📬
MobiPay API Documentation
Mobivate
📬
MobiPay API Documentation
  • 👋Welcome to MobiPay
  • Send SMS via HTTP (MT)
  • Receive SMS via HTTP (MO)
  • Use Cases
    • Send SMS via HTTP (MT) Example
    • Receive SMS via HTTP (MO) Example
    • Gateway Responses
    • Send Silent OBS Billing Message Example
    • Unsubscribe VIA MT Unsubscribe Notification
    • Receive Delivery Receipt via HTTP (DR)
    • Acknowledging MO's and DR's
    • Send A Premium SMS via HTTP (MT) Example
    • Vodafone/Airtel Ghana Billing
  • API Message Paramaters
    • API Message Parameters
    • Send BINARY SMS (MT) parameters
    • Receive SMS (MO) parameters
    • Subscription API (RESTFul)
      • Initiate Subscription (API)
      • Validate PIN (API)
      • Unsubscribing Users (API)
      • Checking Subscription Status (API)
      • Sending Messages To Subscribers (API)
      • Sending Content To Subscribers (API)
    • Content API (RESTFul)
      • Content Types (API)
      • Content Categories (API)
      • Search Content (API)
      • Latest Content Items (API)
      • Content Items (API)
  • Network Double Opt-In
    • Network Double Opt-in (NDOI)
    • Network Double Opt-in (NDOI) Unsubscribe
    • NDOI Keyword Patterns per country
  • MNO Web Opt-in
    • MNO Web Opt-in Introduction
    • MNO Web Opt-In South Africa
    • MNO Web Opt-In Kenya
      • Configuring your campaign
      • Subscribing users to your service
        • Subscribing users via Upstream
        • Subscribing users via Scienlabs
      • Unsubscribing users from your service
      • Receiving callback notifications
    • MNO Web Opt-In Nigeria
      • Subscribing the User to the Service
      • Unsubscribing user from the Service
      • Delivery Notifications
  • UK Direct Carrier Billing
    • UK DCB/Charge to Bill
      • UK Network Flows
Powered by GitBook
On this page

Was this helpful?

  1. API Message Paramaters

Subscription API (RESTFul)

This document will detail how to use our subscription API on our Gateway.

Subscription requests can be sent to our gateway via a HTTP POST API request to our endpoint:

https://subscription-api.mobivate.com/subscriptions/<version>/<campaign_id>/
<method>

Your unique subscription API can be be found under your campaign configuration screen under the API URL section.

Request Parameters

Parameter
Description

version

The version of the subscription api. Currently can only be v1.

campaign_id

Your unique Mobivate campaign id, for example: 0000d000a000d000c000e0f000b00.

method

Which method you would like to call can be one of the following:

initiate, validate_pin, unsubscribe,status or content.

JSON Parameters

When making this API request, you will need to also provide the following raw JSON parameters.

Copy

{
    "msisdn":"xxxxxxxxxxx",
    "keyword":"xxxxxxxx",
    "signature":"xxxxxxxxxxxxxxxxxx"
}
Parameter
Description

msisdn

The unqiue msisdn for this request, must be in international format.

keyword

Name of the traffic source/unqiue Mobivate keyword. Required except for in the status method.

signature

Unique parameter consisting of three values: campaign_id, msisdn and account_id. For example: 1af289e14aa593c843da7cd869a8e2f7.

Please note: The Signature parameter uses standard MD5 hashing algorithm. You must convert this before making the request. An example of the MD5 hashing can be found below.

Signature Conversion

The Signature field needs to be converted using a standard MD5 hashing algorithm in order for your request to work. For example:

account_id: 43e36f54eef111e270639871000000f1

campaign_id: c71e2c2ee68b410a82d6c5f910c2d428

msisdn: 254700000000

When run through a standard MD5 hashing algorithm would become:

MD5 hash: 1af289e14aa593c843da7cd869a8e2f7.

PreviousReceive SMS (MO) parametersNextInitiate Subscription (API)

Last updated 1 year ago

Was this helpful?