ビデオ会議情報の照会

本インターフェースを呼び出すと、会議名、会議時間、会議開始時間、会議終了時間、累計参加人数などの会議の基本情報を取得できます。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}`
HTTP Method	GET
サポートされるアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
権限要件	permission-VideoConference.Conference.Read-ビデオ会議情報の読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	当該インターフェース呼び出し用のアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合は、社内アプリの access_token を取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリで権限付与された企業の access_token を取得インターフェースを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
conferenceId	String	はい	会議の conferenceId。ビデオ会議を作成インターフェースを呼び出して conferenceId を取得できます。

リクエスト例

HTTP

GET /v1.0/conference/videoConferences/6323d7xxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkconference_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.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();
        com.aliyun.dingtalkconference_1_0.models.QueryConferenceInfoHeaders queryConferenceInfoHeaders = new com.aliyun.dingtalkconference_1_0.models.QueryConferenceInfoHeaders();
        queryConferenceInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
        try {
            client.queryConferenceInfoWithOptions("6323d7xxxxx", queryConferenceInfoHeaders, new com.aliyun.teautil.models.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 プロパティが含まれ、問題の特定に役立ちます
            }

        }        
    }
}

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:
        """
        トークンを使用してアカウント 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_conference_info_headers = dingtalkconference__1__0_models.QueryConferenceInfoHeaders()
        query_conference_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            client.query_conference_info_with_options('6323d7xxxxx', query_conference_info_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_conference_info_headers = dingtalkconference__1__0_models.QueryConferenceInfoHeaders()
        query_conference_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            await client.query_conference_info_with_options_async('6323d7xxxxx', query_conference_info_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

<?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\QueryConferenceInfoHeaders;
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();
        $queryConferenceInfoHeaders = new QueryConferenceInfoHeaders([]);
        $queryConferenceInfoHeaders->xAcsDingtalkAccessToken = "<your access token>";
        try {
            $client->queryConferenceInfoWithOptions("6323d7xxxxx", $queryConferenceInfoHeaders, 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/v2/service"
  dingtalkconference_1_0  "github.com/alibabacloud-go/dingtalk/conference_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/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
  }

  queryConferenceInfoHeaders := &dingtalkconference_1_0.QueryConferenceInfoHeaders{}
  queryConferenceInfoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryConferenceInfoWithOptions(tea.String("6323d7xxxxx"), queryConferenceInfoHeaders, &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)
  }
}

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 {

  /**
   * トークンを使用してアカウント 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 queryConferenceInfoHeaders = new $dingtalkconference_1_0.QueryConferenceInfoHeaders({ });
    queryConferenceInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
    try {
      await client.queryConferenceInfoWithOptions("6323d7xxxxx", queryConferenceInfoHeaders, 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.QueryConferenceInfoHeaders queryConferenceInfoHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoHeaders();
            queryConferenceInfoHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.QueryConferenceInfoWithOptions("6323d7xxxxx", queryConferenceInfoHeaders, 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 プロパティが含まれ、問題の特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
confInfo	Object	会議情報。
activeNum	Integer	現在の参加人数。
attendNum	Integer	累計参加人数。
confDuration	Long	会議時間（単位：ミリ秒）。会議終了後に当該フィールドが返されます。
conferenceId	String	会議 ID。
creatorId	String	会議作成者の unionId。
creatorNick	String	会議作成者の名前。
externalLinkUrl	String	会議への参加リンク。
invitedNum	Integer	招待人数。
startTime	Long	会議開始タイムスタンプ（単位：ミリ秒）。
status	Integer	会議ステータス。 - 0：初期化 - 1：会議終了 - 2：会議開始
title	String	タイトル。
roomCode	String	会議コード。
endTime	Long	会議終了タイムスタンプ（単位：ミリ秒）。会議終了後に当該フィールドが返されます。
scheduleConferenceId	String	予約会議 ID。
bizType	String	会議業務タイプ： - 0：即時ビデオ会議 - 3：予約会議 - audio_conf：ビデオ会議
cloudRecordStatus	Integer	会議クラウド録画ステータス： - 0：未録画 - 1：録画中 - 2：録画一時停止 - 3：録画終了
cloudRecordOwnerUnionId	String	クラウド録画所有者の unionId。
minutesStatus	Integer	会議閃記ステータス： - 0：未オン - 1：録画中 - 2：一時停止 - 3：終了会議中の閃記機能は移行されたため、当該フィールドは返されなくなります。
minutesOwnerUnionId	String	閃記所有者の unionId。会議中の閃記機能は移行されたため、当該フィールドは返されなくなります。
extensionAppSettings	Array	会議単位の拡張アプリカスタム情報リスト。
appId	String	会議クールアプリが所属するマイクロアプリの AgentId。
appCode	String	クールアプリの appCode。
autoOpenMode	Integer	自動オープンモード： - 0：自動オープンしない - 1：主催者／共同主催者のみ自動オープン - 2：全員自動オープン
extensionAppBizData	String	会議単位の拡張アプリカスタム情報。

レスポンスボディ例

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

{
  "confInfo" : {
    "activeNum" : 10,
    "attendNum" : 15,
    "confDuration" : 1000000,
    "conferenceId" : "6323dxxxxx",
    "creatorId" : "2iPOLxxxxx",
    "creatorNick" : "山田太郎",
    "externalLinkUrl" : "https://meeting.dingtalk.io/app?roomCode=42726xxx&token=1_7ac9xxx",
    "invitedNum" : 20,
    "startTime" : 1664175001000,
    "status" : 1,
    "title" : "見出し",
    "roomCode" : "4272xxxxx",
    "endTime" : 1663294270000,
    "scheduleConferenceId" : "4331d******",
    "bizType" : "0",
    "cloudRecordStatus" : 0,
    "cloudRecordOwnerUnionId" : "A***EiE",
    "minutesStatus" : 0,
    "minutesOwnerUnionId" : "A***EiE",
    "extensionAppSettings" : [ {
      "appId" : "29****",
      "appCode" : "Coo*****",
      "autoOpenMode" : 0,
      "extensionAppBizData" : "****"
    } ]
  }
}

エラーコード

当該インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	missingRoomId	MISSING ROOM ID	会議 ID パラメータが不足しています
400	paramError	PARAM ERROR	パラメータエラー
403	noPermission	NO PERMISSION	会議を照会する権限がありません
404	roomNotFound	ROOM NOT FOUND	当該会議が見つかりません
500	systemError	SYSTEM ERROR	システム内部エラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード