Skip to content

查询 OTP 发送任务

功能简述

查询 OTP 发送任务状态。

查询 OTP 发送任务 API

请求 URL

  • /otp/otpDetail

请求方式

  • GET

请求参数

请求参数如下:

参数必填类型默认值描述
mobilenumber-发送验证的手机号码,长度限制 13 字符
sessionidstring-OTP 发送凭证,长度固定 32 字符

响应参数

响应参数如下:

  • Response Body

提示

消息网关每分钟同步一次消息渠道发送状态。

参数名类型描述
mobilestring发送手机号码
sessionidstringOTP 发送凭证
statusstring消息网关发送状态:
unknown:未知
create:任务已创建
pending:等待推送到渠道
sending:推送渠道中
success:推送渠道成功
fail:推送渠道失败
reportstatusstring消息渠道发送状态:
unknown:未知
pending:消息发送中
success:消息发送成功
fail:消息发送失败
created_atnumber创建时间

响应参数示例

json
{
    "code": 200,
    "message": "Request succeeded.",
    "data": {
        "mobile": "966580310251",
        "sessionid": "800558b1fb8327742f17d63a3202093e",
        "status": "fail",
        "reportstatus": "unknown",
        "created_at": 1717560142
    },
    "sensitiveFields": {},
    "requestId": "62C10FE5F4C06032E9D3ACF70E75B27B"
}