Skip to main content
Call this API to query the speech-to-text content of a Video Meeting recording, including the text content, the start time of the text record, and the end time of the text record.

API call description

If cloud recording (Flash Minutes) is enabled for a DingTalk Video Meeting, the speech of Members during the cloud recording period is automatically converted into text and saved as records. For example, the Host of a Meeting enables the Meeting Recording — Cloud Recording feature. After the Meeting ends, the Host receives a push message about the Meeting Recording. The speech-to-text content of the Record is shown in the following figure. Call this API to retrieve the text content generated during cloud recording, including the text content, the start time of the text record, and the end time of the text record. When the Host enables Meeting Recording, Cloud Recording (Flash Minutes) must be selected first. In addition, Members must have spoken during the recording period before this API can be called to query the text content of the Meeting Recording.

request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/cloudRecords/getTexts
HTTP MethodGET
Supported App typesappType-Internal app appType-Third-party enterprise app
Permissions requiredpermission-VideoConference.Conference.Read-Read permission for Video Meeting information

request header

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

path parameter

NameTypeRequiredDescription
conferenceIdStringNoThe Meeting ID. Call the Create a Video Meeting API to obtain the value of the conferenceId parameter.

query parameter

NameTypeRequiredDescription
unionIdStringNoThe unionId of the User. Call the Query user details API to obtain the value of the unionid parameter.
startTimeLongNoThe start time in milliseconds (one-thousandth of a second). For example, if this parameter is set to 2000, the query starts from the second second of the recording.
directionStringNoThe query method: - 0: The query is performed in ascending order of time. This is the default method. - 1: The query is performed in descending order of time.
maxResultsLongNoThe number of items per query. The maximum value is 2000.
nextTokenLongNoThe pagination cursor. - For the first query, this parameter can be omitted. - For subsequent queries, set this parameter to the nextToken returned by the previous call to this API.

Request example

HTTP
GET /v1.0/conference/videoConferences/6139b4xxx/cloudRecords/getTexts?unionId=WFBkgJxxx&startTime=6080&direction=1&maxResults=200&nextToken=0 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:ecd72axxx
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();
        QueryCloudRecordTextHeaders queryCloudRecordTextHeaders = new QueryCloudRecordTextHeaders();
        queryCloudRecordTextHeaders.xAcsDingtalkAccessToken = "<your access token>";
        QueryCloudRecordTextRequest queryCloudRecordTextRequest = new QueryCloudRecordTextRequest()
                .setUnionId("WFBkgJxxx")
                .setStartTime(6080L)
                .setDirection("1")
                .setMaxResults(200L)
                .setNextToken(0L);
        try {
            client.queryCloudRecordTextWithOptions("6139b4xxx", queryCloudRecordTextRequest, queryCloudRecordTextHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err object contains code and message attributes that help you 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)) {
                // The err object contains code and message attributes that help you 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_text_headers = dingtalkconference__1__0_models.QueryCloudRecordTextHeaders()
        query_cloud_record_text_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_cloud_record_text_request = dingtalkconference__1__0_models.QueryCloudRecordTextRequest(
            union_id='WFBkgJxxx',
            start_time=6080,
            direction='1',
            max_results=200,
            next_token=0
        )
        try:
            client.query_cloud_record_text_with_options('6139b4xxx', query_cloud_record_text_request, query_cloud_record_text_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message attributes that help you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_cloud_record_text_headers = dingtalkconference__1__0_models.QueryCloudRecordTextHeaders()
        query_cloud_record_text_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_cloud_record_text_request = dingtalkconference__1__0_models.QueryCloudRecordTextRequest(
            union_id='WFBkgJxxx',
            start_time=6080,
            direction='1',
            max_results=200,
            next_token=0
        )
        try:
            await client.query_cloud_record_text_with_options_async('6139b4xxx', query_cloud_record_text_request, query_cloud_record_text_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message attributes that help you 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\QueryCloudRecordTextHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryCloudRecordTextRequest;
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();
        $queryCloudRecordTextHeaders = new QueryCloudRecordTextHeaders([]);
        $queryCloudRecordTextHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryCloudRecordTextRequest = new QueryCloudRecordTextRequest([
            "unionId" => "WFBkgJxxx",
            "startTime" => 6080,
            "direction" => "1",
            "maxResults" => 200,
            "nextToken" => 0
        ]);
        try {
            $client->queryCloudRecordTextWithOptions("6139b4xxx", $queryCloudRecordTextRequest, $queryCloudRecordTextHeaders, 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)) {
                // The err object contains code and message attributes that help you 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
  }

  queryCloudRecordTextHeaders := &dingtalkconference_1_0.QueryCloudRecordTextHeaders{}
  queryCloudRecordTextHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryCloudRecordTextRequest := &dingtalkconference_1_0.QueryCloudRecordTextRequest{
    UnionId: tea.String("WFBkgJxxx"),
    StartTime: tea.Int64(6080),
    Direction: tea.String("1"),
    MaxResults: tea.Int64(200),
    NextToken: tea.Int64(0),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryCloudRecordTextWithOptions(tea.String("6139b4xxx"), queryCloudRecordTextRequest, queryCloudRecordTextHeaders, &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)) {
      // The err object contains code and message attributes that help you 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 queryCloudRecordTextHeaders = new $dingtalkconference_1_0.QueryCloudRecordTextHeaders({ });
    queryCloudRecordTextHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryCloudRecordTextRequest = new $dingtalkconference_1_0.QueryCloudRecordTextRequest({
      unionId: "WFBkgJxxx",
      startTime: 6080,
      direction: "1",
      maxResults: 200,
      nextToken: 0,
    });
    try {
      await client.queryCloudRecordTextWithOptions("6139b4xxx", queryCloudRecordTextRequest, queryCloudRecordTextHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err object contains code and message attributes that help you 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.QueryCloudRecordTextHeaders queryCloudRecordTextHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordTextHeaders();
            queryCloudRecordTextHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordTextRequest queryCloudRecordTextRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryCloudRecordTextRequest
            {
                UnionId = "WFBkgJxxx",
                StartTime = 6080,
                Direction = "1",
                MaxResults = 200,
                NextToken = 0,
            };
            try
            {
                client.QueryCloudRecordTextWithOptions("6139b4xxx", queryCloudRecordTextRequest, queryCloudRecordTextHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains code and message attributes that help you 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))
                {
                    // The err object contains code and message attributes that help you 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::QueryCloudRecordTextHeaders> queryCloudRecordTextHeaders = make_shared<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordTextHeaders>();
  queryCloudRecordTextHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordTextRequest> queryCloudRecordTextRequest = make_shared<Alibabacloud_Dingtalkconference_1_0::QueryCloudRecordTextRequest>(map<string, boost::any>({
    {"unionId", boost::any(string("WFBkgJxxx"))},
    {"startTime", boost::any(6080)},
    {"direction", boost::any(string("1"))},
    {"maxResults", boost::any(200)},
    {"nextToken", boost::any(0)}
  }));
  try {
    client->queryCloudRecordTextWithOptions(make_shared<string>("6139b4xxx"), queryCloudRecordTextRequest, queryCloudRecordTextHeaders, 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)) {
      // The err object contains code and message attributes that help you locate the issue
    }
  }
}

response

response body

NameTypeDescription
hasMoreBooleanWhether more Data exists. - true: Yes - false: No
paragraphListArrayThe Paragraph List.
nextTtokenLongThe pagination cursor for the next request.
statusLongThe status. This Field is currently not used.
unionIdStringThe unionId of the speaker.
nickNameStringThe Name of the speaker.
recordIdLongThe Record ID.
startTimeLongThe start time of the Paragraph Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record started at the second second of the Meeting Recording.
endTimeLongThe end time of the Paragraph Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 8000, the speech-to-text record ended at the eighth second of the Meeting Recording.
paragraphStringThe Paragraph Content.
sentenceListArrayThe sentence list.
unionIdStringThe unionId of the User.
sentenceStringThe sentence.
startTimeLongThe start time of the sentence Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record started at the second second of the Meeting Recording.
endTimeLongThe end time of the sentence Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record ended at the second second of the Meeting Recording.
wordListArrayThe word list.
wordStringThe word.
startTimeLongThe start time of the word Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record started at the second second of the Meeting Recording.
endTimeLongThe end time of the word Record, expressed in milliseconds (one-thousandth of a second) relative to the start of the Meeting Recording. For example, if this parameter is 2000, the speech-to-text record ended at the second second of the Meeting Recording.
wordIdStringThe word ID.

response body example

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

{
  "hasMore" : true,
  "paragraphList" : [ {
    "nextTtoken" : 1631172045153000,
    "status" : 1,
    "unionId" : "WFBkgJvxxx",
    "nickName" : "Xiao Ding",
    "recordId" : 44444,
    "startTime" : 7940,
    "endTime" : 7940,
    "paragraph" : "Hi! Hello, this is Xiao Ding",
    "sentenceList" : [ {
      "unionId" : "WFBkgJvtxxx",
      "sentence" : "This is Xiao Ding",
      "startTime" : 7940,
      "endTime" : 7940,
      "wordList" : [ {
        "word" : "This",
        "startTime" : 7940,
        "endTime" : 7940,
        "wordId" : "1631172050535000#0"
      } ]
    } ]
  } ]
}

error code

If an Error occurs when calling this API, find 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
404permissionErrorpermissionError:%sGroup Permissions restriction
500systemErrorsystemError:%ssystem error