Introduction Last updated: 17-02-2023

This document is intended to provide a guide for third parties who want to use the Orchard platform for various transactional services.

Overview

This document is intended to provide a guide for appsNmobile clients who want to use the shortcode app for various services. ie shortcode

Prerequisite

Any external service provider who needs access to the appsNmobile Solutions Limited Platform must first of all complete all necessary merchant registration procedures required by the company. Upon successful registration as a Merchant, the following are provided to the third party:

  1. SLA between appsNmobile Solutions Limited and third party must be signed
  2. External service provider must be provisioned on the appsNmobile agent platform
  3. A URL from the client is needed to push the short code data to him

Connection Procedure

"URL": "client_url"
"Method": POST
"Data format": JSON
"Content Type": application/json

Short Code Details

During the initial dial, JSON data is transmitted to the URL provided by the client as part of the integration process. This JSON data includes parameters such as session_id, msisdn, msg_type, ussd_body, nw_code, and service_code. Subsequently, the client responds with essential feedback and necessary requirements to either continue the session or conclude it.

Fields Description Example O/M Datatype
session_id USSD Server generates this for session_id. In an active session, session_id remains constant in subsequent requests 675873844932 M String
msisdn Phone number of the user dialing the short code 233595999352 M String
msg_type status of the session 0 - New Session
1 - Continue Session
2 - End Session
 M String
ussd_body Response the user is going to see or the response the user has sent M String
nw_code Telco code from user's incoming request for mobile network provider identification 01 - MTN
02 - VODAFONE
03 - TIGO
04 - AIRTEL
M String
service_code short code user dialed M String

How it Works:
  • Request is initiated from appsNmoible with msg_type, 0, to the client URL as provided by client
  • Response to be displayed to the user is returned from client platform with msg_type, 1, if the client is expecting the session to continue or with msg_type, 2, if the session must end.