Skip to main content
Call this API to retrieve basic information about a meeting, including the meeting name, duration, start time, end time, and the total number of attendees.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}
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 organization that authorizes a third-party app API.

Path parameter

NameTypeRequiredDescription
conferenceIdStringYesThe conferenceId of the meeting. Call the Create a video meeting API to obtain the conferenceId.

Request example

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 {

    /**
     * Initialize the account client with a token
     * @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 contains code and message attributes that 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 attributes that 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_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 contains code and message attributes that help locate the issue
                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 contains code and message attributes that 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\QueryConferenceInfoHeaders;
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();
        $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 contains code and message attributes that 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/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"
)

/**
 * 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
  }

  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 contains code and message attributes that 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 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 contains code and message attributes that 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.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 contains code and message attributes that 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 attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
confInfoObjectThe meeting information.
activeNumIntegerThe number of participants currently in the meeting.
attendNumIntegerThe total number of participants who joined the meeting.
confDurationLongThe meeting duration, in milliseconds. This field is returned after the meeting ends.
conferenceIdStringThe meeting ID.
creatorIdStringThe unionId of the user who created the meeting.
creatorNickStringThe name of the user who created the meeting.
externalLinkUrlStringThe link to join the meeting.
invitedNumIntegerThe number of invitees.
startTimeLongThe meeting start timestamp, in milliseconds.
statusIntegerThe meeting status. - 0: Initialized - 1: Meeting ended - 2: Meeting started
titleStringThe meeting title.
roomCodeStringThe meeting code.
endTimeLongThe meeting end timestamp, in milliseconds. This field is returned after the meeting ends.
scheduleConferenceIdStringThe booked meeting ID.
bizTypeStringThe meeting business type: - 0: Instant video meeting - 3: Booked meeting - audio_conf: Audio meeting
cloudRecordStatusIntegerThe cloud recording status of the meeting: - 0: Not recording - 1: Recording - 2: Recording paused - 3: Recording ended
cloudRecordOwnerUnionIdStringThe unionId of the cloud recording owner.
minutesStatusIntegerThe meeting Minutes status: - 0: Not started - 1: Recording - 2: Paused - 3: Ended The in-meeting Minutes capability has been migrated, and this field is no longer returned.
minutesOwnerUnionIdStringThe unionId of the Minutes owner. The in-meeting Minutes capability has been migrated, and this field is no longer returned.
extensionAppSettingsArrayThe list of custom information for meeting-level extension apps.
appIdStringThe Agent ID of the micro app to which the meeting cool app belongs.
appCodeStringThe appCode of the cool app.
autoOpenModeIntegerThe auto-open mode: - 0: Do not open automatically - 1: Open automatically only for the host and co-hosts - 2: Open automatically for all participants
extensionAppBizDataStringThe custom information for the meeting-level extension app.

Response body example

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

{
  "confInfo" : {
    "activeNum" : 10,
    "attendNum" : 15,
    "confDuration" : 1000000,
    "conferenceId" : "6323dxxxxx",
    "creatorId" : "2iPOLxxxxx",
    "creatorNick" : "Xiao Ding",
    "externalLinkUrl" : "https://meeting.dingtalk.io/app?roomCode=42726xxx&token=1_7ac9xxx",
    "invitedNum" : 20,
    "startTime" : 1664175001000,
    "status" : 1,
    "title" : "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" : "****"
    } ]
  }
}

Error codes

If an error occurs when calling this API, refer to the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400missingRoomIdMISSING ROOM IDThe meeting ID parameter is missing.
400paramErrorPARAM ERRORParameter error.
403noPermissionNO PERMISSIONNo permission to query the meeting.
404roomNotFoundROOM NOT FOUNDThe meeting cannot be found.
500systemErrorSYSTEM ERRORInternal system error.