1 / 4

OTP_API_Specifications

This document describes the parameters and responses used to send and verify one-time-password (OTP) messages.<br>

theroutemob
Download Presentation

OTP_API_Specifications

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. OTP API Specifications Version: 2.0 Date: November, 2019 Route Mobile Limited © 2019 Route Mobile Limited © 2019. All rights reserved . All rights reserved 1 1

  2. Document Information and Version History Document Information Document Information Document Name Document Name OTP API Specifications This document describes the parameters and responses used to send and verify one-time-password (OTP) messages. December 07, 2016 1.0.0 Jyotsna Document Document Description Description Creation Date Creation Date Initial Version Initial Version Author Author Document Change Log Document Change Log Modification Modification Date Date January 12, 2018 November 26, 2019 Version Version Number Number Change Change Summary Summary Author Author Hrudeep Goregaonkar Hrudeep Goregaonkar 1.0.1 Reformatted and reviewed document for language. 2.0 Reviewed – No changes Document Approval Log Document Approval Log Approval Date Approval Date February 13, 2018 November 26, 2019 Approver Approver Sachin Kanojia Ramesh Helaiya Designation Designation Head – Support AVP - Technology Route Route Mobile Limited © 2019 Mobile Limited © 2019. All rights reserved . All rights reserved 2 2

  3. 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 Request Parameters Sr. Sr. No No. . Parameter Parameter Description Description 1 1 username username Name of the user. 2 2 password password Password of the user. 3 3 4 4 msisdn msisdn exptime exptime Mobile number to which OTP has to be sent. OTP validity time in seconds. Message template with %m escape character which will be replaced by generated OTP. Message has to be URL encoded. Sender assigned for user. Length of the OTP. Identifier name for given batch (optional). 5 5 msg msg 6 6 7 7 8 8 source source otplen otplen tagname tagname Response Response Sr. No Sr. No. . Error Code Error Code Description Description 1 1 1701|MSISDN:MessageID 1701|MSISDN:MessageID Message sent successfully. 2 2 1702 1702 One of the parameter is missing or OTP is not numeric. 3 3 1703 1703 Authentication failed. 4 4 1706 1706 Invalid destination. 5 5 1705 1705 Message does not contain %m. 6 6 1707 1707 Invalid source. 7 7 1710 1710 Some error occurred. 8 8 1715 1715 Response time out. 9 9 1025 1025 Insufficient user credit. 10 10 1032 1032 DND destination. 11 11 1033 1033 Source template mismatch. 12 12 1035 1035 User opt out. 1 13 3 104 1042 2 Explicit DND reject. Route Route Mobile Limited © 2019 Mobile Limited © 2019. All rights reserved . All rights reserved 3 3

  4. 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 Request Parameters Sr. No. Sr. No. Parameter Parameter Description Description 1 1 username username Name of the user. 2 2 password password Password of the user. 3 3 msisdn msisdn Mobile number to which the OTP was sent. 4 4 otp otp Received OTP which needs to be verified. Response Response Sr. No Sr. No. . Error Code Error Code Description Description 1 1 101 101 OTP validated successfully. 2 2 102 102 OTP has expired. 3 3 103 103 Entry for OTP not found. 4 4 104 104 MSISDN not found. 5 5 1702 1702 One of the parameter missing or OTP is not numeric. 6 6 1703 1703 Authentication failed. 7 7 1706 1706 Given destination is invalid. Route Route Mobile Limited © 2019 Mobile Limited © 2019. All rights reserved . All rights reserved 4 4

More Related