跳到主要内容

查询真人认证会话

GET /api/volc-user/visual-validate-sessions/{sessionId}

查询当前用户发起的单个认证会话,两种创建模式均使用此接口。认证成功且素材组仍可见时,返回平台 groupId。

鉴权说明

用户控制台接口,使用登录会话 Cookie,或请求头 Authorization: <access_token>。访问令牌由 生成访问令牌 获取,与模型调用使用的 sk- 密钥不同。

请求参数​

参数名类型必选说明
sessionIdstring必选Path 参数;普通创建接口的 sessionId,或自定义回调创建接口的 platformSessionId

请求示例​

GET /api/volc-user/visual-validate-sessions/vvs-example
Authorization: <access_token>

响应字段(200)​

字段名类型说明
successboolean业务是否成功;HTTP 200 仍需检查此字段
messagestring提示信息,成功时为空字符串
dataobject成功时的响应数据
data.sessionIdstring平台认证会话 ID,用于查询认证结果
data.statusstringPending、Processing、Succeeded、Failed、Expired,见 接入流程
data.h5Linkstring仅在会话为 Pending 且未过期时返回;交给本人打开完成认证
data.expiresAtinteger认证链接过期时间,Unix 秒;当前会话有效期为创建后 120 秒
data.groupIdstring认证成功后生成的平台素材组 ID;无值时省略,查询时已删除的素材组也不再返回
data.resultCodestringH5 认证结果码,有值时返回;成功为 10000
data.errorCodestring错误码,有值时返回
data.errorMessagestring错误说明,有值时返回
data.createTimeinteger创建时间,Unix 秒
data.updateTimeinteger更新时间,Unix 秒

响应示例​

{
"success": true,
"message": "",
"data": {
"sessionId": "vvs-example",
"status": "Succeeded",
"expiresAt": 1792022520,
"createTime": 1792022400,
"updateTime": 1792022430,
"groupId": "group-example",
"resultCode": "10000"
}
}

会话超过有效期且仍为 Pending 时,查询会将其标记为 Expired。请新建会话重新认证。会话成功不代表组内已存在可用素材,仍需创建素材并查询至 Active。