你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Liveness Session Operations - Get Liveness Sessions

服务:

Azure AI Services

API 版本:

v1.2-preview.1

列出 /detectLiveness/SingleModal 的会话。
列出上一个大于“start”的 sessionId 中的会话。

结果应按 sessionId 按升序排序。

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions

具有可选参数:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions?start={start}&top={top}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。
start	query		string	列出大于“start”的资源。 它包含不超过 64 个字符。 默认值为空。
top	query		integer int32	要列出的项目数，范围为 [1， 1000]。 默认值为 1000。

响应

名称	类型	说明
200 OK	LivenessSessionItem[]	请求已成功。
Other Status Codes	FaceErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 URL: https://api.example.com/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Get LivenessSessions

示例请求

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20

示例响应

状态代码:

200

[
  {
    "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "createdDateTime": "2024-03-05T11:07:28.540Z",
    "sessionStartDateTime": "2024-03-05T11:07:28.540Z",
    "sessionExpired": true,
    "deviceCorrelationId": "your_device_correlation_id",
    "authTokenTimeToLiveInSeconds": 60
  }
]

定义

名称	说明
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。
LivenessSessionItem	为枚举返回的会话数据。

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
message	string	错误的人工可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	FaceError	错误对象。

LivenessSessionItem

为枚举返回的会话数据。

名称	类型	默认值	说明
authTokenTimeToLiveInSeconds	integer	600	会话应持续到的秒数。 范围为 60 到 86400 秒。 默认值为 600。
createdDateTime	string		创建此会话时的 DateTime。
deviceCorrelationId	string		每个最终用户设备的唯一 Guid。 这是提供速率限制和反锤击。 如果此请求中为“deviceCorrelationIdSetInClient”，则此“deviceCorrelationId”必须为 null。
id	string		要引用此会话的唯一 ID。
sessionExpired	boolean		会话是否过期。
sessionStartDateTime	string		客户端启动此会话时的 DateTime。