OTP API
Specifications
Version: 2.0
Date: November, 2019
Route Mobile Limited © 2019. All rights reserved 1
Document Information and Version History
Document Information
Document Name OTP API Specifications
This document describes the parameters and responses used to
Document Description
send and verify one-time-password (OTP) messages.
Creation Date December 07, 2016
Initial Version 1.0.0
Author Jyotsna
Document Change Log
Modification Version
Change Summary Author
Date Number
January 12, Hrudeep
1.0.1 Reformatted and reviewed document for language.
2018 Goregaonkar
November Hrudeep
2.0 Reviewed – No changes
26, 2019 Goregaonkar
Document Approval Log
Approval Date Approver Designation
February 13, 2018 Sachin Kanojia Head – Support
November 26, 2019 Ramesh Helaiya AVP - Technology
Route Mobile Limited © 2019. All rights reserved 2
OTP API
The below URL shows the API used to send an OTP message.
http://<ipaddress>:<port>/OtpApi/otpgenerate?username=XXXX&password=XXXX&msisdn=XXXX
XXXXXXX&msg=XXXXX&source=XXXX&otplen=XX&tagname=XXX&exptime=XXX
Request Parameters
Sr. No. Parameter Description
1 username Name of the user.
2 password Password of the user.
3 msisdn Mobile number to which OTP has to be sent.
4 exptime OTP validity time in seconds.
Message template with %m escape character which will be
5 msg replaced by generated OTP. Message has to be URL
encoded.
6 source Sender assigned for user.
7 otplen Length of the OTP.
8 tagname Identifier name for given batch (optional).
Response
Sr. No. Error Code Description
1 1701|MSISDN:MessageID Message sent successfully.
2 1702 One of the parameter is missing or OTP is not numeric.
3 1703 Authentication failed.
4 1706 Invalid destination.
5 1705 Message does not contain %m.
6 1707 Invalid source.
7 1710 Some error occurred.
8 1715 Response time out.
9 1025 Insufficient user credit.
10 1032 DND destination.
11 1033 Source template mismatch.
12 1035 User opt out.
13 1042 Explicit DND reject.
Route Mobile Limited © 2019. All rights reserved 3
The below URL shows the API used to validate the received OTP.
http://<ipaddress>:<port>/OtpApi/checkotp?username=XXXXXX&password=XXXXXX&msisdn=XX
XXX&otp=XXXX
Request Parameters
Sr. No. Parameter Description
1 username Name of the user.
2 password Password of the user.
3 msisdn Mobile number to which the OTP was sent.
4 otp Received OTP which needs to be verified.
Response
Sr. No. Error Code Description
1 101 OTP validated successfully.
2 102 OTP has expired.
3 103 Entry for OTP not found.
4 104 MSISDN not found.
5 1702 One of the parameter missing or OTP is not numeric.
6 1703 Authentication failed.
7 1706 Given destination is invalid.
Route Mobile Limited © 2019. All rights reserved 4
