Liveness Session Operations - Get Liveness Sessions

服務:

Azure AI Services

API 版本:

v1.2-preview.1

列出 /detectLiveness/SingleModal 的會話。
列出上一個 sessionId 大於 'start' 的會話。

結果應該依 sessionId 以遞增順序排序。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
start	query		string	列出大於「開始」的資源。 它包含不超過 64 個字元。 預設值為空的。
top	query		integer int32	要列出的項目數目，範圍介於 [1， 1000] 內。 預設值為 1000。

回應

名稱	類型	Description
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
Flow: accessCode
授權 URL: https://api.example.com/oauth2/authorize
權杖 URL: https://api.example.com/oauth2/token

範圍

名稱	Description
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
  }
]

定義

名稱	Description
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
LivenessSessionItem	針對列舉傳回的會話數據。

FaceError

error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
message	string	錯誤的人類可讀取表示法。

FaceErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	FaceError	error 物件。

LivenessSessionItem

針對列舉傳回的會話數據。

名稱	類型	預設值	Description
authTokenTimeToLiveInSeconds	integer	600	會話應該持續到的秒數。 範圍是 60 到 86400 秒。 預設值為 600。
createdDateTime	string		建立此工作階段時的 DateTime。
deviceCorrelationId	string		每個終端用戶裝置的唯一 Guid。 這是提供速率限制和反錘擊。 如果此要求中的 'deviceCorrelationIdSetInClient' 為 true，此 'deviceCorrelationId' 必須為 Null。
id	string		參考此工作階段的唯一標識碼。
sessionExpired	boolean		會話是否過期。
sessionStartDateTime	string		用戶端啟動此會話時的 DateTime。