Query historical information of a booked meeting

Query the historical meeting information of a booked meeting that has been started. The latest meeting information is returned.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/conference/videoConferences/scheduleConferences/{scheduleConferenceId}`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Permissions	permission-VideoConference.Conference.Read-Read permission for Video Meeting information

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API: - For an internal app, call the Get the access token of an internal app API to obtain it. - For a third-party enterprise app, call the Get the access token of an authorized organization for a third-party app API to obtain it.

Path parameters

Name	Type	Required	Description
scheduleConferenceId	String	Yes	The booked meeting ID. You can obtain it from the `scheduleConferenceId` field returned by the Create a booked meeting API.

Query parameters

Name	Type	Required	Description
nextToken	String	No	The position from which to start reading. Leave it empty to start from the beginning.
maxResults	Integer	No	The maximum number of data records to read in this request.

Request example

HTTP

GET /v1.0/conference/videoConferences/scheduleConferences/6bd63df9-a2df-47ff-8436-179c6520fbc8?nextToken=0&maxResults=20 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxx
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 using the 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.QueryScheduleConferenceInfoHeaders queryScheduleConferenceInfoHeaders = new com.aliyun.dingtalkconference_1_0.models.QueryScheduleConferenceInfoHeaders();
        queryScheduleConferenceInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.QueryScheduleConferenceInfoRequest queryScheduleConferenceInfoRequest = new com.aliyun.dingtalkconference_1_0.models.QueryScheduleConferenceInfoRequest()
                .setNextToken("0")
                .setMaxResults(20);
        try {
            client.queryScheduleConferenceInfoWithOptions("6bd63df9-a2df-47ff-8436-179c6520fbc8", queryScheduleConferenceInfoRequest, queryScheduleConferenceInfoHeaders, 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 os
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 using the 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_schedule_conference_info_headers = dingtalkconference__1__0_models.QueryScheduleConferenceInfoHeaders()
        query_schedule_conference_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_schedule_conference_info_request = dingtalkconference__1__0_models.QueryScheduleConferenceInfoRequest(
            next_token='0',
            max_results=20
        )
        try:
            client.query_schedule_conference_info_with_options('6bd63df9-a2df-47ff-8436-179c6520fbc8', query_schedule_conference_info_request, query_schedule_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_schedule_conference_info_headers = dingtalkconference__1__0_models.QueryScheduleConferenceInfoHeaders()
        query_schedule_conference_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_schedule_conference_info_request = dingtalkconference__1__0_models.QueryScheduleConferenceInfoRequest(
            next_token='0',
            max_results=20
        )
        try:
            await client.query_schedule_conference_info_with_options_async('6bd63df9-a2df-47ff-8436-179c6520fbc8', query_schedule_conference_info_request, query_schedule_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\QueryScheduleConferenceInfoHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryScheduleConferenceInfoRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client using the 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();
        $queryScheduleConferenceInfoHeaders = new QueryScheduleConferenceInfoHeaders([]);
        $queryScheduleConferenceInfoHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryScheduleConferenceInfoRequest = new QueryScheduleConferenceInfoRequest([
            "nextToken" => "0",
            "maxResults" => 20
        ]);
        try {
            $client->queryScheduleConferenceInfoWithOptions("6bd63df9-a2df-47ff-8436-179c6520fbc8", $queryScheduleConferenceInfoRequest, $queryScheduleConferenceInfoHeaders, 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));

// 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 using the 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
  }

  queryScheduleConferenceInfoHeaders := &dingtalkconference_1_0.QueryScheduleConferenceInfoHeaders{}
  queryScheduleConferenceInfoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryScheduleConferenceInfoRequest := &dingtalkconference_1_0.QueryScheduleConferenceInfoRequest{
    NextToken: tea.String("0"),
    MaxResults: tea.Int32(20),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryScheduleConferenceInfoWithOptions(tea.String("6bd63df9-a2df-47ff-8436-179c6520fbc8"), queryScheduleConferenceInfoRequest, queryScheduleConferenceInfoHeaders, &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 using the 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 queryScheduleConferenceInfoHeaders = new $dingtalkconference_1_0.QueryScheduleConferenceInfoHeaders({ });
    queryScheduleConferenceInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryScheduleConferenceInfoRequest = new $dingtalkconference_1_0.QueryScheduleConferenceInfoRequest({
      nextToken: "0",
      maxResults: 20,
    });
    try {
      await client.queryScheduleConferenceInfoWithOptions("6bd63df9-a2df-47ff-8436-179c6520fbc8", queryScheduleConferenceInfoRequest, queryScheduleConferenceInfoHeaders, 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));

// 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 using the 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.QueryScheduleConferenceInfoHeaders queryScheduleConferenceInfoHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryScheduleConferenceInfoHeaders();
            queryScheduleConferenceInfoHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryScheduleConferenceInfoRequest queryScheduleConferenceInfoRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryScheduleConferenceInfoRequest
            {
                NextToken = "0",
                MaxResults = 20,
            };
            try
            {
                client.QueryScheduleConferenceInfoWithOptions("6bd63df9-a2df-47ff-8436-179c6520fbc8", queryScheduleConferenceInfoRequest, queryScheduleConferenceInfoHeaders, 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

Name	Type	Description
totalCount	Integer	The total number of data records that match the request conditions. This parameter is optional and may not be returned by default.
nextToken	String	The position read by this call. An empty value indicates that all data has been read.
conferenceList	Array	The list of meetings.
conferenceId	String	The meeting ID.
title	String	The meeting title.
roomCode	String	The meeting number.
status	Integer	The meeting status: - 0: Not started - 1: Ended - 2: In progress
startTime	Long	The meeting start time, as a UTC timestamp in milliseconds.
endTime	Long	The meeting end time, as a UTC timestamp in milliseconds.

Response body example

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

{
  "totalCount" : 20,
  "nextToken" : "19",
  "conferenceList" : [ {
    "conferenceId" : "636cf59f2b032f014ae32902",
    "title" : "Video Meeting initiated by xxx",
    "roomCode" : "123456789",
    "status" : 2,
    "startTime" : 1668087731000,
    "endTime" : 1668087732000
  } ]
}

Error codes

If an error is returned when you call this API, find the solution in the Global error codes documentation based on the error message.

HttpCode	Error code	Error message	Description
400	invalidScheduleConferenceId	invalidScheduleConferenceId	The booked meeting ID is invalid.
400	paramsError	error:%s	Parameter error. Check the input parameters.
500	systemError	systemError:%s	System error.

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes