Vai al contenuto

v1

General conference management endpoints (Version 1)

DEPRECATION NOTICE:

For security reasons, the v1 API endpoints has been deprecated and will be shut down in the upcoming months, starting from TEST environment.
  • 15/10/2026 - TEST environment
  • 15/01/2027 - PRODUCTION environment
Please migrate to the v2 API endpoints as soon as possible. See the migration guide for details.

conferenceData
obsoleto

Richiesta

Retrieve LiveID+ video identification calls data

Notice: for details about module structure provided in "data" parameter see this ConferenceData response: module structure

This API has been deprecated and will be shut down soon (see the deprecation roadmap).
Please use the v2 version. See the migration guide for details.
Sicurezza
ConferenceToken
Corpoapplication/json
modulestring

Id of the module to retrieve. If not provided, all the data of the call will be returned.

Enum:"photo""formfilling"
tokenstring, (JWT)obsoleto

Token provided on call closing or generated with genAPIToken (if not provided as header)

curl -i -X GET \
  https://liveid.test.namirialtsp.com/api/v1/conferenceData \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "module": "photo",
    "token": "string"
  }'

Risposte

Success

Corpo
servicestring

Service endpoint

successboolean

Success result

Predefinito:true
call_answer_datestring, (datetime)

date when the call was answered by an operator

call_end_datestring, (datetime)

date when the call was closed

call_last_activitystring, (datetime)

date of the last activity on the call

end_patternstring(EndPattern)

Status of the call

  • N Closed succesfully
  • A Aborted by operator
  • K System KO
  • S Suspended
  • ACTIVE Still running
  • EXPIRED Expired (no one answered)
  • CANCELLED Cancelled by user
Enum:"N""A""K""S""ACTIVE""EXPIRED""CANCELLED"
operatorobject
dataobject

json of the requested data

Risposta
{ "service": "string", "success": true, "call_answer_date": "string", "call_end_date": "string", "call_last_activity": "string", "end_pattern": "N", "operator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "external_id": "string" }, "data": {} }