验证结果上报
通过 EngageLab 下发验证码后，如果您在自有系统中完成了验证码校验，可调用本接口上报验证成功结果，用于回填统计。
本接口免费，仅接收验证成功结果。
调用地址
POST https://otp.api.engagelab.cc/v1/backfill
调用验证
请参考 调用验证 了解如何进行 API 鉴权。
请使用下发该消息的应用所配置的 API Key，并确保该 API Key 具有验证码校验（verify）权限。
请求示例
请求头
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
此代码块在浮窗中显示
请求体
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
此代码块在浮窗中显示
请求参数
请求体使用 JSON 格式，请设置请求头 Content-Type: application/json。
| 参数 | 类型 | 选项 | 说明 |
|---|---|---|---|
| message_id | String | 必填 | 验证码对应的消息 ID，由下发接口返回 |
| verified_at | Integer | 必填 | 验证码校验成功的时间，Unix 时间戳，单位为秒 |
返回参数
成功返回
HTTP 状态码为 200，表示平台已记录本次验证成功结果。
| 字段 | 类型 | 选项 | 描述 |
|---|---|---|---|
| code | Integer | 必填 | 成功时为 0 |
| message | String | 必填 | 结果说明，成功时为 success |
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
此代码块在浮窗中显示
失败返回
HTTP 状态码为 4xx 或 5xx，响应体包含错误码和错误说明。例如，消息已验证成功时返回 HTTP 400：
| 字段 | 类型 | 选项 | 描述 |
|---|---|---|---|
| code | Integer | 必填 | 错误码，详见下方错误码说明 |
| message | String | 必填 | 错误说明 |
{
"code": 3012,
"message": "verify code has already validated"
}
{
"code": 3012,
"message": "verify code has already validated"
}
此代码块在浮窗中显示
错误码
| 错误码 | http code | 说明 |
|---|---|---|
| 1000 | 500 | 服务内部错误，请稍后重试 |
| 2001 | 401 | 认证信息缺失或无效 |
| 2002 | 401 | API Key 已过期或已被禁用 |
| 2002 | 403 | 当前应用不可用 |
| 2004 | 403 | API Key 没有调用本接口的权限 |
| 3001 | 400 | 请求 JSON 无效或参数类型不正确 |
| 3002 | 400 | 参数值无效、时间超出允许范围，或消息不支持回填 |
| 3012 | 400 | 消息已验证成功，无需再次上报 |
| 4001 | 400 | 消息不存在或不属于当前应用 |
请根据 code 处理错误，message 用于说明具体原因。
使用说明
- 仅支持成功发送的验证码消息。此前在平台校验失败或超时的消息，仍可上报您自行校验成功的结果。
- 首次上报须在原消息发送后不足 30 天内完成，以平台接收请求的时间为准。
- 验证成功时间不能早于原消息发送时间，也不能晚于平台接收本次请求的时间。
- 消息已通过本接口或 验证码校验 接口记录为验证成功后，再次上报或校验均返回
3012。
回填成功后，平台将按应用的 回调配置 推送相应消息状态。
