API 呼び出し説明
DingTalk ビデオ会議でクラウド録画(閃記)をオンにすると、クラウド録画期間中にメンバーが発言した内容が自動的にテキストへ変換されレコードが生成されます。 例えば、会議の主催者が 会議録画-クラウド録画 機能をオンにすると、会議終了後に主催者へ会議録画のプッシュチャットが届きます。記録された音声からテキストへの変換コンテンツは下図のとおりです。 本 API を呼び出すことで、クラウド録画中に記録されたテキスト情報(テキストコンテンツ、テキストレコードの開始時刻、テキストレコードの終了時刻など)を取得できます。 主催者が会議録画をオンにする際は、まず クラウド録画(閃記) を選択する必要があります。さらに録画期間中にメンバーが発言している場合に限り、本 API を呼び出して会議録画のテキスト情報を取得できます。リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/cloudRecords/getTexts |
| HTTP Method | GET |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要権限 | permission-VideoConference.Conference.Read-ビデオ会議情報の読み取り権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 本 API を呼び出すためのアクセス認証情報。以下の方法で取得します: - 社内アプリの場合、社内アプリの accessToken を取得 API を呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリで権限付与された企業の accessToken を取得 API を呼び出して取得します。 |
パスパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| conferenceId | String | いいえ | 会議 ID。ビデオ会議を作成 API を呼び出して conferenceId パラメータの値を取得できます。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| unionId | String | いいえ | ユーザーの unionId。ユーザー詳細を取得 API を呼び出して unionid パラメータの値を取得できます。 |
| startTime | Long | いいえ | 開始時刻のミリ秒(1/1000 秒)、単位はミリ秒。 例えば、本パラメータの値を 2000 にすると、録画開始から 2 秒目以降を取得対象とします。 |
| direction | String | いいえ | 取得方法: - 0: 時刻昇順で取得します(デフォルト)。 - 1: 時刻降順で取得します。 |
| maxResults | Long | いいえ | 一度に取得する件数。最大 2000 件。 |
| nextToken | Long | いいえ | ページネーションカーソル。 - 初回取得時は本パラメータを指定しなくて構いません。 - 初回以外の場合は、前回本 API 呼び出し時にレスポンスで返された nextToken を指定します。 |
リクエスト例
HTTPGET /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
// 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 {
/**
* トークンを使用してアカウント Client を初期化
* @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)) {
// err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
} 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 には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
}
}
# -*- 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:
"""
トークンを使用してアカウント Client を初期化
@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):
# err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
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):
# err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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 {
/**
* トークンを使用してアカウント Client を初期化
* @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)) {
// err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// 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"
)
/**
* トークンを使用してアカウント Client を初期化
* @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)) {
// err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 {
/**
* トークンを使用してアカウント Client を初期化
* @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)) {
// err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
}
}
Client.main(process.argv.slice(2));
// 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
{
/**
* トークンを使用してアカウント Client を初期化
* @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))
{
// err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
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 には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
}
}
}
// 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)) {
// err には code と message プロパティが含まれ、開発者が問題を特定するのに役立ちます
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| hasMore | Boolean | さらにデータがあるかどうか。 - true: あり - false: なし |
| paragraphList | Array | 段落リスト。 |
| nextTtoken | Long | 次回リクエストのページネーションカーソル。 |
| status | Long | ステータス。 本フィールドは現時点では使用シナリオがありません。 |
| unionId | String | 発言者の unionId。 |
| nickName | String | 発言者の名前。 |
| recordId | Long | 録画 ID。 |
| startTime | Long | 段落レコードが生成された時点における、会議録画期間中の相対時間(ミリ秒、1/1000 秒単位)。 例えば本パラメータの値が 2000 の場合、会議録画開始から 2 秒目に本音声からテキストへの変換記録が開始されたことを示します。 |
| endTime | Long | 段落レコードが終了した時点における、会議録画期間中の相対時間(ミリ秒、1/1000 秒単位)。 例えば本パラメータの値が 8000 の場合、会議録画開始から 8 秒目に本音声からテキストへの変換記録が終了したことを示します。 |
| paragraph | String | 段落コンテンツ。 |
| sentenceList | Array | 文リスト。 |
| unionId | String | ユーザーの unionId。 |
| sentence | String | 文。 |
| startTime | Long | 文レコードが生成された時点における、会議録画期間中の相対時間(ミリ秒、1/1000 秒単位)。 例えば本パラメータの値が 2000 の場合、会議録画開始から 2 秒目に本音声からテキストへの変換記録が開始されたことを示します。 |
| endTime | Long | 文レコードが終了した時点における、会議録画期間中の相対時間(ミリ秒、1/1000 秒単位)。 例えば本パラメータの値が 2000 の場合、会議録画開始から 2 秒目に本音声からテキストへの変換記録が終了したことを示します。 |
| wordList | Array | 単語リスト。 |
| word | String | 単語。 |
| startTime | Long | 単語レコードが生成された時点における、会議録画期間中の相対時間(ミリ秒、1/1000 秒単位)。 例えば本パラメータの値が 2000 の場合、会議録画開始から 2 秒目に本音声からテキストへの変換記録が開始されたことを示します。 |
| endTime | Long | 単語レコードが終了した時点における、会議録画期間中の相対時間(ミリ秒、1/1000 秒単位)。 例えば本パラメータの値が 2000 の場合、会議録画開始から 2 秒目に本音声からテキストへの変換記録が終了したことを示します。 |
| wordId | String | 単語 ID。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"hasMore" : true,
"paragraphList" : [ {
"nextTtoken" : 1631172045153000,
"status" : 1,
"unionId" : "WFBkgJvxxx",
"nickName" : "シャオディン",
"recordId" : 44444,
"startTime" : 7940,
"endTime" : 7940,
"paragraph" : "やあ!こんにちは、こちらはシャオディンです",
"sentenceList" : [ {
"unionId" : "WFBkgJvtxxx",
"sentence" : "こちらはシャオディンです",
"startTime" : 7940,
"endTime" : 7940,
"wordList" : [ {
"word" : "こちら",
"startTime" : 7940,
"endTime" : 7940,
"wordId" : "1631172050535000#0"
} ]
} ]
} ]
}
エラーコード
本 API の呼び出しでエラーが発生した場合、エラーメッセージをもとに グローバルエラーコード ドキュメントから解決策を検索できます。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | orgAccessForbidden | orgAccessForbidden | 組織へのアクセスが制限されています |
| 400 | unknownUserError | unknownUserError | ユーザーを識別できません |
| 400 | paramsError | error:%s | パラメータエラー |
| 400 | resourceClose | The meeting has ended | 当該会議は終了しています |
| 400 | cloudRecordNotFound | cloudRecordNotFound | クラウド録画レコードが見つからない/クラウド録画がオンになっていません |
| 404 | permissionError | permissionError:%s | グループ権限の制限 |
| 500 | systemError | systemError:%s | システムエラー |