Yondu API Documentation-AppPlus v2.0

MCSPhilippinesAppPlus|YonduAPIDocumentationv.2.
YONDU
YonduAPIDocumentation
(MCSPhilippinesAppPlus)
Ver.2.00|05September2016|YonduAPIDocumentationAppPlus
Confidential
Page1of15
MCSPhilippinesAppPlus|YonduAPIDocumentationv.2.0
YONDU
TableofContents
Overview
SubscriptionviaSMSandUSSDprocessflow
SMS/USSDFlowDiagram
SubscriptionviaWeb/WAPprocessflow
WEB/WAPFlowDiagram
MessageRequestwithSample
ChargingKeywords
YonduMTAPI
YonduAPIStatus/Response
ChargedStatusCode
ConnectionRequirements
Confidential
Page2of15
YONDU
Overview
ThisdocumentationservesasaguideincreatingAppPlusandYonduAPI.Diagramflows,APIand
examplesarefromAppPlusservice.IPsandURLshouldbechangeinordertoapplythisforAppPlus
service.
Confidential
Page3of15
YONDU
SubscriptionviaSMSandUSSDprocessflow
Discussedbelowisthemessageflowforsuccessfullychargedsubscriber.Thisflowappliesvia
bothSMSandUSSDmessage.AllAPIcallanditsparametersarealsothesameforbothSMS.Thisflow
depictsthefollowingscenarios.
SMS/USSDFlowDiagram
Confidential
Page4of15
YONDU
1. AllMOmessagesreceivedbyTelcofromsubscribersareforwardedtoYondu.TheseMO
messagescanbeoptin(neworrecurringsubscription),optout(stop,stopall).
2. YondusendstheMOmessagetoAppPlusthroughAppPlusMOAPI.
3. APIAppPlusMOURL=http://yondu.aludms.com/Msg/phil/mo?
APIAppPlusUSSDURL=http:// yondu.aludms.com/Msg/phil/ussd?
RequiredParameters:
Parameters
mo_origin
msisdn
telco
sms
session_id
doubleOptinRequired
Optionalparameter
shortcode
Description/possiblevalues
Originoftherequest
PossibleValues:(SMS/USSD)
subscribermsisdn
service_providername
E.g.Globe
MOText(Keyword)
e.g.A
pp1ON
AuniqueidentifiertoidentifytheMOrequest
e.g.34dfth6756
ABooleanvaluewhichspecifyifdoubleOptinrequiredornot.
PossibleValues:(yes/no)
Parameter isoptional,ifparametervalueisyesthendoubleOptin
flowwillbe executed. If theparametervalueisnoordoesntexist
thensingleoptInflowwillbeexecuted.
Sampleresponse:
HTTP/1.1200OK
ContentLength:2
Confidential
Page5of15
YONDU
4.
5.
6.
7.
ContentType:text/html
OK
AppPluswillsendtheappropriateMTmessagethroughYonduMTAPIinresponsetotheMO
messagereceivedfromYondu.PleasenotethattheMTmessagealsocontainsthecharging
keyword.
YonduMTURL=http://192.237.235.75/dmp/process/api/appplus.php?
Parameters:
transid=(Transid)
account=appplus
key=P@SsApp@Plus@2016!
c_msisdn=(mobilenumber)
content=(chargingkeyword+MTmessage)
WhenYondureceivedtheMTmessagefromAppPlus,itwilltrytochargethemobilenumber
withthechargingAPIsendstoTelco.
Telcowilltrytochargethemobilenumberandifitissuccessfullycharged,sendsthestatus
OKtoYondu.
WhenYondureceivesthechargingOKstatusfromTelco,itwillsendaDNmessagetoAppPlus
tonotifyAppPlusthatchargingthemobilenumberwassuccessful.DNmessagewillbesent
throughDNAPI.
TakenotethatDeliveryNotificationIdvalueisthesamewiththetransidreceivedbyYondu
whenAppPlussentanMTmessagerequest.Thisistotrackthesuccessfullybilled
transactionsfromotherunsuccessfultransactions.
8. AftersendingtheDNnotificationmessagetoAppPlus,YonduwillsendtheMTmessageto
Telco.
AppPlusDNURL=http://yondu.aludms.com/Msg/phil/dn?
Parameters
msisdn
subscribersmsisdne.g.628121973082
Confidential
Page6of15
YONDU
session_id
status
status_telco
telco
the uniqueidentifiertoidentify theDNfortheMTrequestsentto

Yondu
e.g.1sms0986325264
StatusoftheMTmessagesent
Possiblevalues:DELIVERED/REJECTED
StatusoftheCharging
Possiblevalues:
0success
1Failure
2Failurewithinsufficientbalance
service_providerid
E.g.Globe
Sampleresponse:
HTTP/1.1200OK
ContentLength:2
OK
SubscriptionviaWeb/WAPprocessflow
Discussedbelowisthemessageflowforsuccessfullychargedsubscriber.Thisflowappliesvia
Web/Wapmessage.
Confidential
Page7of15
YONDU
Web/WAPFlowDiagram
1. AdagencieswillusethebelowURLforSubscriptionpurchaseviaweb.
Confidential
Page8of15
YONDU
AppPlusWebURL:
http://yondu.aludms.com/SubAxis/subscriptionstart?
Parameters
serviceCode
subscriptionOffer
spname
msisdn
auth
Advertisementvendoride.g.Eskimi
subscriptionofferorderingCode
(specifytherequestforagivesubscriptionoffer)
ServiceProvidername
subscribersmsisdn
<true/false>
(Required for the Authentication if not
provided provided the default value will be
taken
redirectToPortal
<true/false>
(Required to specify ifsubscriberneeds
to be redirected toportal or not if not
provided the default value will be
taken).
SampleRequest:
http://yondu.aludms.com/SubAxis/subscriptionstart?serviceCode=Eskimi&subscriptionOffer=
z2045&spname=Globe&msisdn=628121973082&auth=true&redirectToPortal=true
Sampleresponse:
HTTP/1.1200OK
ContentLength:2
OK
Confidential
Page9of15
YONDU
2. AppPluswillsendtheappropriateMTmessagethroughYonduMTAPIinresponsetotheMO
messagereceivedfromYondu.PleasenotethattheMTmessagealsocontainsthecharging
keyword.
YonduMTURL=http://192.237.235.75/dmp/process/api/appplus.php?
Parameters:
transid=(Transid)
account=appplus
3. WhenYondureceivedtheMTmessagefromAppPlus,itwilltrytochargethemobilenumber
withthechargingAPIsendstoTelco.
4. Telcowilltrytochargethemobilenumberandifitissuccessfullycharged,sendsthestatus
OKtoYondu.
5. WhenYondureceivesthechargingOKstatusfromTelco,itwillsendaDNmessagetoAppPlus
tonotifyAppPlusthatchargingthemobilenumberwassuccessful.DNmessagewillbesent
throughDNAPI.
AppPlusDNURL=http://yondu.aludms.com/Msg/phil/dn?
Parameters
msisdn
subscribersmsisdne.g.628121973082
session_id
the uniqueidentifiertoidentify theDNfortheMTrequestsentto
Yondu
e.g.1sms0986325264
status
StatusoftheMTmessagesent
Possiblevalues:DELIVERED/REJECTED
status_telco
StatusoftheCharging
Possiblevalues:0success
1failure
2failurewithinsufficientbalance
Confidential
Page10of15
YONDU
telco
service_providerid
E.g.Globe
Sampleresponse:
HTTP/1.1200OK
ContentLength:2
OK
TakenotethatDeliveryNotificationIdvalueisthesamewiththetransidreceivedbyYondu
whenAppPlussentanMTmessagerequest.Thisistotrackthesuccessfullybilled
transactionsfromotherunsuccessfultransactions.
6. AftersendingtheDNnotificationmessagetoAppPlus,YonduwillsendtheMTmessageto
Telco.
MessageRequestwithSample
ChargingKeywords
Table1
ChargingKeyword
Primary&
Secondary
Charging
Keywords
Price
Type
Descriptions
app_help
APPHELP
0.00
SMS
FreeForhelpmessagereply
Confidential
Page11of15
YONDU
app1_500
App1On
5.00
SMS
Forfirsttimeuserand1day
subscriptionscenario
app1_renewal
5.00
SMS
Useforrenewalfor1daysubscription
app7_3000
APP7On
30.00
SMS
Forfirsttimeuserand7days
subscriptionscenario
app7_renewal
30.00
SMS
Useforrenewalfor7dayssubscription
app_off
APPOFF,
APP1OFF,
APP7OFF
0.00
SMS
ForUseroptsout
app_error
2.50
SMS
RepeatOptins,RepeatOptout
app_manual_unsubscribe
0.00
SMS
Manualcleanupforthesubscribersnot
bill/chargewithin90days.
app_free
0.00
SMS
FreenotificationWelcomemessage,
Promo/Campaignmessage
app_micro_250
2.50
SMS
Microchargingworth2.50
app_micro_500
5.00
SMS
app_micro_1000
10.00
SMS
app_micro_1500
15.00
SMS
Confidential
Page12of15
YONDU
YonduMTAPI
Definition:
URL=http://192.237.235.75/dmp/process/api/appplus.php?
Parameters:
transid=(Transid)
account=appplus
ExampleRequest:
http://192.237.235.75/dmp/process/api/appplus.php?transid=14041693&account=appplus&key=
P@SsApp@Plus@2016!&c_msisdn=9174208550&content=chargingkeyword+MTmessage
YonduAPIStatus/Response
ThisistheresponsedbyYonduAPI.
Table2
StatusResult
Description
0:ProcessedSuccessfully
Successfullyreceivedthemessage.Readytoprocess.
92:NoMobileIDDefined
Nomobilevalueinparameter
97:InvalidAccount/Key
Invalidaccountorkeyinparameter
98:NoKeyDefined
Nokeyvalueinparameter
99:NoAccountDefined
Noaccountvalueinparameter
Confidential
Page13of15
YONDU
GlobeChargedStatusCode
Thisresponsewillbereturnedonstatusreceivedfromtelco/network/carrier.UseforDelivery
Notification(DN).
Table3
StatusCode
StatusMessage
Description
200
Successful/OK
Successfullycharged
401
Subscribernotfound.
Subscribermobilenumbernotactive
404
Unhandledstatuscode
StatuscodeisnotdefinedtoTelco.
410
FailuretoconnecttotheCCB
systemtocheckaccount
status.
FailedchargetoPostpaidsubscriberbecauseTelco
cannotconnecttoCCBsystem.
411
GHPSubscriberhas
insufficientbalance.
InsufficientbalancetoallPrepaid/GHPsubscriber
412
EricssonInsuffBal
InsufficientbalancetoallTouchmobilesubscriber
Confidential
Page14of15
YONDU
414
Postpaidsubscriberis
inactive.
Postpaidsubscriberisinactive
500
Serviceisdown.
Serviceisdown/inactive.
503
CSPError.
TelcoproblemtoconnectinCSPplatform
503
Appisnotprovisionedfor
chargingorthisrate
Chargingamountisnotprovision
503
InvalidreferenceCode
InvalidreferencecodepassedtoTelcoupon
charging,causedbybulktransactionprocessatsame
time.
1001
NoResponse
YonducannotaccesstheAPIofTelcoafter3times
attempt.
1002
ConnectionRefused
YonducannotaccesstheAPIofTelco
ConnectionRequirements
1.
2.
3.
4.
AppPlusIP
AppPlusMOAPIandDNAPI
Connectivitytesting(ping,traceroute,telnet)
Testphonemobilenumbers(fortesting)
Confidential
Page15of15

Yondu API Documentation-AppPlus v2.0

Uploaded by

Yondu API Documentation-AppPlus v2.0

Uploaded by

MCSPhilippinesAppPlus|YonduAPIDocumentationv.2.

the uniqueidentifiertoidentify theDNfortheMTrequestsentto

You might also like