📬
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
  • User Detection & Subscription in Nigeria
  • Requesting the UserID

Was this helpful?

  1. MNO Web Opt-in

MNO Web Opt-In Nigeria

This document describes MNO Web Opt-In for NI.

PreviousReceiving callback notificationsNextSubscribing the User to the Service

Last updated 1 year ago

Was this helpful?

User Detection & Subscription in Nigeria

To subscribe a user in Nigeria, for Direct Carrier Billing, we must perform two separate steps.

  1. Redirect the user to the MSISDN Detection platform which will return to us ( if successful ) the Network and the User ID.

  2. Call the on the API providing the UserID and the ServiceID.

Requesting the UserID

To request the UserID, you should have the following information ready:

Parameter
Required?
Description

Return URL

Yes

Your FULL URL, including the http://... . User will be sent back to this url upon completion.

MTN Product ID

Yes

Required for detecting MTN customers.

Your Reference ID

No

Your own reference ID.

Flow: Redirect the user to the Lookup URL. Once the lookup is performed, user will be sent back to your Return URL.

Example

https://<hostname>/lookup/ng/?return=<RETURN_URL>&ad_id=<MTN_PRODUCT_ID>&ref_id=<YOUR_REFERENCE>

The user will return to the given Return URL with the following (GET) parameters appended.

Attribute
Example
Description

hostname

hostname.mobivate.com

Mobivate's content hostname.

status

success/failed

Describing the status of the lookup.

userid

abcd4321_-$

Returned only if status==success! An ASCII value unique to this subscriber, instead of the MSISDN.

network

mtnng / etisalatng

Returned only if status==success! Network name for the subscriber

message

failed to detect user!

Returned only if status==failed! Error description

Examples

On Successful detection user will return to your domain:

http://www.yourdomain.com/nigeria-user-detection?status=success&userid=$abcd1234$&network=etisalatngp

On failure, the user will return to your domain while also containing a message:

http://www.yourdomain.com/nigeria-user-detection?status=failed&message=Failed+to+detect+UserID.
Subscribe method