OTP-API

业务流程图

推送消息模式流程

拉取消息模式流程

接口

公共请求头

接口用户认证采用请求头sign认证，具体可参考 OTP接口文档-V1.0 2.1 公共请求头。

获取上行验证跳转链接

接口地址: /flash/opt/verify
请求方式:POST
请求数据类型:application/json
请求示例:

{"ftId":"2"}

请求参数:

参数名称	数据类型	是否必填	描述
ftId	String	必填	FOTP 模版 ID（Flash OTP Template 页面 FOTP ID）
code	String	非必填	验证码 4-6位默认使用创蓝生成的4位验证码
validityPeriod	String	非必填	验证码有效期最长10分钟默认5分钟，过期后跳转链接将不可用

响应状态:

状态码	说明	schema
000000	OK

响应参数:

参数名称	数据类型	描述
code	String
message	String
data
url	String	跳转链接
messageId	String	消息ID
ftToken	String	FOTP令牌
code	String	验证码

响应示例:

{
    "code": "000000",
    "success": true,
    "message": "请求成功",
    "data": {
        "messageId": "393801984179642368",
        "url": "http://otpdev.cm253.com/otp-api/flash/opt/redirect/200e96b6a8bf8ed8c3de194cf14b342f",
        "ftToken": "200e96b6a8bf8ed8c3de194cf14b342f",
        "code": "3872"
    }
}

Callingback Address 回调地址（推送消息）

Flash OTP Template 页面配置的 Callingback Address 地址
请求参数:

参数名称	数据类型	是否必填	描述
mobile	String	必填	手机号
sender	String	必填	发送号码
sendTime	String	必填	发送时间
code	String	必填	验证码
content	String	非必填	上行内容
deliverTime	String	非必填	上行时间
err	String	非必填	异常原因

请求示例

{
    "sendTime": "2025-05-15 11:23:34",
    "code": "5776",
    "sender": "1008611",
    "mobile": "8615711666132",
    "content": "🔐 Exclusive Access Unlocked!\nYour VIP Key: ##FG5x-5776##\n🚀 How to Redeem:\n1️⃣ Copy this entire message\n2️⃣ Open [App Name] and paste it\n3️⃣ Unlock premium content/features instantly!",
    "deliverTime": "2025-05-15 11:24:24"
}

响应参数

参数名称	类型	参数说明
code	String	0 成功其他均为失败

响应示例:

{
    "code": "0"
}

查询上行结果（拉取消息）

接口地址: /flash/opt/query
请求方式:POST
请求数据类型:application/json
请求示例:

{"ftToken": "44cadc6071214b968b3b3bb1cb5a6c24"}

参数名称	数据类型	是否必填	描述
ftToken	String	必填	FOTP令牌

响应示例:

{
    "code": "000000",
    "success": true,
    "message": "请求成功",
    "data": {
        "status": "2",
        "mobile": "6285273203675",
        "sender": "6285215410016",
        "sendTime": "2025-04-29 17:47:00",
        "code": "5777",
        "deliverTime": "2025-04-29 17:48:23"
    }
}

参数名称	类型	参数说明
status	String	状态 0 处理中 1 失败 2 成功
mobile	String	手机号
sender	String	发送号码
sendTime	String	发送时间
deliverTime	String	上行时间
code	String	验证码

OTP-API

业务流程图

推送消息 模式流程

拉取消息 模式流程

接口

公共请求头

获取上行验证跳转链接

Callingback Address 回调地址（推送消息）

查询上行结果（拉取消息）

推送消息模式流程

拉取消息模式流程