Skip to main content
Call this API to query the details of a meeting recording, including the recorder, recording start time, and recording duration.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/cloudRecords/getVideos
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-VideoConference.Conference.Read-Video Meeting information read permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of the authorized enterprise API.

Path parameters

NameTypeRequiredDescription
conferenceIdStringYesThe meeting ID. Call the Create a video conference API to obtain the value of the conferenceId parameter.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the user. Call the Query user details API to obtain the value of the unionid parameter.

Request example

HTTP
GET /v1.0/conference/videoConferences/6139b4xxx/cloudRecords/getVideos?unionId=WFBkxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:ecd72a8b0ff63d2a85bdb2c3e3c352bc
Content-Type:application/json
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkconference_1_0.*;
import com.aliyun.dingtalkconference_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkconference_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkconference_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkconference_1_0.Client client = Sample.createClient();
        QueryCloudRecordVideoHeaders queryCloudRecordVideoHeaders = new QueryCloudRecordVideoHeaders();
        queryCloudRecordVideoHeaders.xAcsDingtalkAccessToken = "<your access token>";
        QueryCloudRecordVideoRequest queryCloudRecordVideoRequest = new QueryCloudRecordVideoRequest()
                .setUnionId("WFBkxxx");
        try {
            client.queryCloudRecordVideoWithOptions("6139b4xxx", queryCloudRecordVideoRequest, queryCloudRecordVideoHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties, which help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties, which help locate the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.conference_1_0.client import Client as dingtalkconference_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.conference_1_0 import models as dingtalkconference__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkconference_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkconference_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_cloud_record_video_headers = dingtalkconference__1__0_models.QueryCloudRecordVideoHeaders()
        query_cloud_record_video_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_cloud_record_video_request = dingtalkconference__1__0_models.QueryCloudRecordVideoRequest(
            union_id='WFBkxxx'
        )
        try:
            client.query_cloud_record_video_with_options('6139b4xxx', query_cloud_record_video_request, query_cloud_record_video_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_cloud_record_video_headers = dingtalkconference__1__0_models.QueryCloudRecordVideoHeaders()
        query_cloud_record_video_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_cloud_record_video_request = dingtalkconference__1__0_models.QueryCloudRecordVideoRequest(
            union_id='WFBkxxx'
        )
        try:
            await client.query_cloud_record_video_with_options_async('6139b4xxx', query_cloud_record_video_request, query_cloud_record_video_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties, which help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryCloudRecordVideoHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryCloudRecordVideoRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $queryCloudRecordVideoHeaders = new QueryCloudRecordVideoHeaders([]);
        $queryCloudRecordVideoHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryCloudRecordVideoRequest = new QueryCloudRecordVideoRequest([
            "unionId" => "WFBkxxx"
        ]);
        try {
            $client->queryCloudRecordVideoWithOptions("6139b4xxx", $queryCloudRecordVideoRequest, $queryCloudRecordVideoHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message properties, which help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/service"
  dingtalkconference_1_0  "github.com/alibabacloud-go/dingtalk/conference_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client with a Token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkconference_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkconference_1_0.Client{}
  _result, _err = dingtalkconference_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  queryCloudRecordVideoHeaders := &dingtalkconference_1_0.QueryCloudRecordVideoHeaders{}
  queryCloudRecordVideoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryCloudRecordVideoRequest := &dingtalkconference_1_0.QueryCloudRecordVideoRequest{
    UnionId: tea.String("WFBkxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryCloudRecordVideoWithOptions(tea.String("6139b4xxx"), queryCloudRecordVideoRequest, queryCloudRecordVideoHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message properties, which help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkconference_1_0, * as $dingtalkconference_1_0 from '@alicloud/dingtalk/conference_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkconference_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkconference_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let queryCloudRecordVideoHeaders = new $dingtalkconference_1_0.QueryCloudRecordVideoHeaders({ });
    queryCloudRecordVideoHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryCloudRecordVideoRequest = new $dingtalkconference_1_0.QueryCloudRecordVideoRequest({
      unionId: "WFBkxxx",
    });
    try {
      await client.queryCloudRecordVideoWithOptions("6139b4xxx", queryCloudRecordVideoRequest, queryCloudRecordVideoHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties, which help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkconference_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkconference_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkconference_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordVideoHeaders queryCloudRecordVideoHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordVideoHeaders();
            queryCloudRecordVideoHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordVideoRequest queryCloudRecordVideoRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordVideoRequest
            {
                UnionId = "WFBkxxx",
            };
            try
            {
                client.QueryCloudRecordVideoWithOptions("6139b4xxx", queryCloudRecordVideoRequest, queryCloudRecordVideoHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties, which help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties, which help locate the issue
                }
            }
        }

    }
}
C
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkconference__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkconference_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkconference_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::Client> client = make_shared<Alibabacloud_Dingtalkconference_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordVideoHeaders> queryCloudRecordVideoHeaders = make_shared<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordVideoHeaders>();
  queryCloudRecordVideoHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordVideoRequest> queryCloudRecordVideoRequest = make_shared<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordVideoRequest>(map<string, boost::any>({
    {"unionId", boost::any(string("WFBkxxx"))}
  }));
  try {
    client->queryCloudRecordVideoWithOptions(make_shared<string>("6139b4xxx"), queryCloudRecordVideoRequest, queryCloudRecordVideoHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err contains code and message properties, which help locate the issue
    }
  }
}

Response

Response body

NameTypeDescription
videoListArrayThe list of meeting recording videos.
recordIdStringThe recording ID. For the same video conference, if multiple recordings are made, the resulting recording videos share the same recordId.
unionIdStringThe unionId of the recorder.
startTimeLongThe recording start timestamp, in milliseconds.
recordTypeLongThe record type. Valid values: - 0: standard recording - 1: composed file
durationLongThe recording duration multiplied by 1000. For example, a value of 20000 indicates that the meeting recording lasts 20 seconds.
fileSizeLongThe file size, in bytes.
endTimeLongThe recording end timestamp, in milliseconds.
mediaIdStringThe unique media file ID.
regionIdStringThe region ID where the media file is located.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "videoList" : [ {
    "recordId" : "290882268xxx1172033231",
    "unionId" : "WFBkgJvtxxxxtSaA1jK4sgiEiE",
    "startTime" : 1631172094000,
    "recordType" : 1,
    "duration" : 59886,
    "fileSize" : 1127942,
    "endTime" : 1631172094000,
    "mediaId" : "faa1566c5bc24f21821ae2394f82db2e",
    "regionId" : "cn-shenzhen"
  } ]
}

Error codes

If an error is returned when calling this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400orgAccessForbiddenorgAccessForbiddenOrganization access is restricted
400unknownUserErrorunknownUserErrorUnrecognized user
400paramsErrorerror:%sParameter error
400resourceCloseThe meeting has endedThe meeting has been closed
400cloudRecordNotFoundcloudRecordNotFoundCloud recording record not found / cloud recording not enabled
404waterLimitErrorwaterLimitError:%sParticipant count rate limit
404permissionErrorpermissionError:%sGroup permission restriction
500systemErrorsystemError:%sSystem error