List live videos

URL

GET https://api.complycube.com/v1/liveVideos?clientId=:id

This endpoint allows you to list all existing live videos for a given client. The live videos are returned sorted by creation date, with the most recent live videos appearing first.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Query parameters

Name	Type	Description
clientId*	string	The ID of the client.
<pagination>	string	The number of items to return and the number of pages to offset.
<filtering>	string	Filter the results.

You can use pagination for this endpoint.

Example request

cURL

curl -X GET https://api.complycube.com/v1/liveVideos?clientId={:clientId} \
     -H 'Authorization: <YOUR_API_KEY>'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const liveVideos = await complycube.liveVideo.list("CLIENT_ID");

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

livevideos = ccapi.livevideos.list('CLIENT_ID')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$videos = $ccapi->livevideos()->list('CLIENT_ID');

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var videoApi = new liveVideoApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var videos = liveVideoApi.ListAsync("CLIENT_ID").Result;

Example responses

Success (200)

{
    "page": 1,
    "pageSize": 100,
    "totalItems": 1,
    "pages": 1,
    "items": [
        {
          "id": "5eb1b5f231778a0008d1c3f6",
          "clientId": "5eb1276d96be4a0008713af5",
          "language": "en-GB",
          "challenges": [
            {
              "type": "voice",
              "value": [
                "7",
                "9",
                "1",
                "7"
              ]
            },
            {
              "type": "actions",
              "value": [
                "turnHeadLeft"
              ]
            }
          ],
          "createdAt": "2020-01-01T14:06:44.756Z",
          "updatedAt": "2020-01-01T14:06:44.756Z"
      }
    ]
}

Invalid Request (400)

{
    "type": "invalid_request",
    "message": "The query parameter 'clientId' is required"
}