OTP API

Send Message

Send general verification code

Request API URL

 POST     https://api.innopaas.com/api/otp/v3/msg/send/verify

Request Parameters

Field	Data Type	Required	Description
type	String	Yes	send type 1 - whatsapp,2 - voice,3 - sms,4 email,5 telegram Currently only supports 1 - WhatsApp and 3 - SMS
language	String	Yes	template language, see Appendix 1: language codes
to	String	Yes	recipient phone number
code	String	Yes	verification code
sender	String	No	WhatsApp Sender (optional; if not provided system uses default; to configure contact admin to bind)

API endpoint

POST       https://api.innopaas.com/api/otp/v3/msg/send

Request Parameters

Field	Data Type	Required	Description
templateId	String	Yes	OTP template (policy) ID
language	String	Yes	template language, see Appendix 1: language codes
to	String	Yes	recipient phone number
code	String	Yes	verification code
sender	String	No	WhatsApp Sender (display number, unbound numbers will fail)

request example

{
    "templateId":"110129512080522",
    "language":"en",
    "to": "8618912123457",
    "code": "123213",
    "sender": "8618912123456"
}

Response Example

{
    "code": "000000",
    "message": "Success",
    "data":"2342623234234234234"  //messageId of the message
}

account management

query account balance

API endpoint

GET   https://api.innopaas.com/api/otp/v3/account/getBalance

response parameters

Field	Data Type	Required	Description
payType	Integer	Yes	1: prepaid account, 2: postpaid account
preBalance	Double	Yes	prepaid balance, check when payType=1
postBalance	Double	Yes	postpaid credit balance, check when payType=2; if isCreditUnlimit=1, credit limit is unlimited
isCreditUnlimit	Integer	Yes	whether postpaid credit is limited, 0: limited, 1: not limited

Response Example

{
    "code": "000000",
    "message": "Success",
    "data": {
        "payType": "",
        "preBalance": "innopaas street1.",
        "postBalance": "my test2",
        "isCreditUnlimit": "[e-mail]",
        }
}