Liveness Session Operations - Get Liveness Sessions

  • Referens
Tjänst:
Azure AI Services
API-version:
v1.2-preview.1

Visar sessioner för /detectLiveness/SingleModal.
Lista sessioner från det senaste sessionId som är större än "start".

Resultatet ska ordnas efter sessionId i stigande ordning.

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions
Med valfria parametrar: 
GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions?start={start}&top={top}

URI-parametrar

Name I Obligatorisk Typ Description
apiVersion
 path True

string

API-version
endpoint
 path True

string

uri

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
start
 query

string

Visa en lista över resurser som är större än "start". Den innehåller högst 64 tecken. Standardvärdet är tomt.
top
 query

integer

int32

Antalet objekt som ska listas, i [1, 1 000]. Standardvärdet är 1 000.

Svar

Name Typ Description
200 OK

LivenessSessionItem[]

Begäran har slutförts.
Other Status Codes

FaceErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

Name Description
https://cognitiveservices.azure.com/.default

Exempel

Get LivenessSessions

Exempelbegäran

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

Exempelsvar

Statuskod:
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
  }
]

Definitioner

Name Description
FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Ett svar som innehåller felinformation.
LivenessSessionItem

Sessionsdata som returneras för uppräkning.

FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
message

string

En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name Typ Description
error

FaceError

Felobjektet.

LivenessSessionItem

Sessionsdata som returneras för uppräkning.

Name Typ Standardvärde Description
authTokenTimeToLiveInSeconds

integer

600

Sekunder som sessionen ska pågå i. Intervallet är 60 till 8 6400 sekunder. Standardvärdet är 600.
createdDateTime

string

DateTime när den här sessionen skapades.
deviceCorrelationId

string

Unikt Guid per varje slutanvändarenhet. Detta är för att ge hastighetsbegränsning och anti-hamring. Om "deviceCorrelationIdSetInClient" är sant i den här begäran måste detta "deviceCorrelationId" vara null.
id

string

Det unika ID som ska referera till den här sessionen.
sessionExpired

boolean

Om sessionen har upphört att gälla eller inte.
sessionStartDateTime

string

DateTime när den här sessionen startades av klienten.