Query OTP Task
Function Description
Query the OTP sending task status.
Query OTP Task API
Request URL
/otp/otpDetail
Request Method
- GET
Request Parameters
The request parameters are as follows:
Header
Request Body
Parameters | Required | Type | Default Value | Description |
---|---|---|---|---|
mobile | Y | number | - | Send verification phone number, length limit 13 characters |
sessionid | Y | string | - | OTP sending voucher,fixed length of 32 characters |
Response Parameters
The response parameters are as following:
- Response Body
TIP
The message gateway synchronizes the message channel sending status once every minute.
Parameters | Type | Description |
---|---|---|
mobile | string | Send mobile phone number |
sessionid | string | OTP sending credentials |
status | string | Message gateway sending status: unknown : Unknown create : Task created pending : Waiting to be pushed to the channel sending : Pushing the channel success : Pushing the channel successfully fail : Pushing the channel failed |
reportstatus | string | Message channel sending status: unknown : Unknown pending : Message sending success : Message sending successfully fail : Message sending failed |
created_at | number | Creation time |
Response parameter Example
json
{
"code": 200,
"message": "Request succeeded.",
"data": {
"mobile": "966580310251",
"sessionid": "800558b1fb8327742f17d63a3202093e",
"status": "fail",
"reportstatus": "unknown",
"created_at": 1717560142
},
"sensitiveFields": {},
"requestId": "62C10FE5F4C06032E9D3ACF70E75B27B"
}