予約会議の設定を照会

予約会議 ID に基づき、予約会議の設定情報を照会します。

リクエスト

基本情報

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

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	この API を呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合は、社内アプリの accessToken を取得 API を呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリが認可された企業の accessToken を取得 API を呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
scheduleConferenceId	String	はい	予約会議 ID。予約会議を作成 API のレスポンスパラメータ `scheduleConferenceId` フィールドから取得できます。

リクエスト例

HTTP

GET /v1.0/conference/scheduleConferences/settings?scheduleConferenceId=dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:1ce64c62b52f370c9421422d1bb87dc1
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 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.QueryScheduleConfSettingsHeaders queryScheduleConfSettingsHeaders = new com.aliyun.dingtalkconference_1_0.models.QueryScheduleConfSettingsHeaders();
        queryScheduleConfSettingsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.QueryScheduleConfSettingsRequest queryScheduleConfSettingsRequest = new com.aliyun.dingtalkconference_1_0.models.QueryScheduleConfSettingsRequest()
                .setScheduleConferenceId("dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26");
        try {
            client.queryScheduleConfSettingsWithOptions(queryScheduleConfSettingsRequest, queryScheduleConfSettingsHeaders, 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 properties, which help to 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 properties, which help to 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 with 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_conf_settings_headers = dingtalkconference__1__0_models.QueryScheduleConfSettingsHeaders()
        query_schedule_conf_settings_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_schedule_conf_settings_request = dingtalkconference__1__0_models.QueryScheduleConfSettingsRequest(
            schedule_conference_id='dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26'
        )
        try:
            client.query_schedule_conf_settings_with_options(query_schedule_conf_settings_request, query_schedule_conf_settings_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 properties, which help to locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_schedule_conf_settings_headers = dingtalkconference__1__0_models.QueryScheduleConfSettingsHeaders()
        query_schedule_conf_settings_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_schedule_conf_settings_request = dingtalkconference__1__0_models.QueryScheduleConfSettingsRequest(
            schedule_conference_id='dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26'
        )
        try:
            await client.query_schedule_conf_settings_with_options_async(query_schedule_conf_settings_request, query_schedule_conf_settings_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 properties, which help to 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\QueryScheduleConfSettingsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryScheduleConfSettingsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $queryScheduleConfSettingsHeaders = new QueryScheduleConfSettingsHeaders([]);
        $queryScheduleConfSettingsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryScheduleConfSettingsRequest = new QueryScheduleConfSettingsRequest([
            "scheduleConferenceId" => "dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26"
        ]);
        try {
            $client->queryScheduleConfSettingsWithOptions($queryScheduleConfSettingsRequest, $queryScheduleConfSettingsHeaders, 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 properties, which help to 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 (
  "encoding/json"
  "strings"
  "fmt"
  "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"
)

// Description:
// 
// Initialize the account Client with 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
  }

  queryScheduleConfSettingsHeaders := &dingtalkconference_1_0.QueryScheduleConfSettingsHeaders{}
  queryScheduleConfSettingsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryScheduleConfSettingsRequest := &dingtalkconference_1_0.QueryScheduleConfSettingsRequest{
    ScheduleConferenceId: tea.String("dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryScheduleConfSettingsWithOptions(queryScheduleConfSettingsRequest, queryScheduleConfSettingsHeaders, &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 properties, which help to locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkconference_1_0 = require('@alicloud/dingtalk/conference_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client with the token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkconference_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let queryScheduleConfSettingsHeaders = new dingtalkconference_1_0.QueryScheduleConfSettingsHeaders({ });
    queryScheduleConfSettingsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let queryScheduleConfSettingsRequest = new dingtalkconference_1_0.QueryScheduleConfSettingsRequest({
      scheduleConferenceId: 'dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26',
    });
    try {
      await client.queryScheduleConfSettingsWithOptions(queryScheduleConfSettingsRequest, queryScheduleConfSettingsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message properties, which help to locate the issue
      }

    }    
  }

}

exports.Client = Client;
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 with 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.QueryScheduleConfSettingsHeaders queryScheduleConfSettingsHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryScheduleConfSettingsHeaders();
            queryScheduleConfSettingsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryScheduleConfSettingsRequest queryScheduleConfSettingsRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryScheduleConfSettingsRequest
            {
                ScheduleConferenceId = "dxxx0ad6-b769-418e-8a7e-7b5ef4fafa26",
            };
            try
            {
                client.QueryScheduleConfSettingsWithOptions(queryScheduleConfSettingsRequest, queryScheduleConfSettingsHeaders, 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 properties, which help to 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 properties, which help to locate the issue
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
scheduleConfSettingModel	Object	予約会議の設定。
hostUnionId	String	主催者の unionId。
cohostUnionIds	Array of String	共同主催者の unionId。
confAllowedCorpId	String	社内会議の組織 ID。
lockRoom	Integer	会議のロック： - 0：ロック解除 - 1：ロック
screenShareForbidden	Integer	共有の開始： - 0：共有を許可 - 1：共有を禁止
muteOnJoin	Integer	ユーザーが会議に参加時にミュート： - -1：オン - 0：オフ - 6：6 人を超えた場合に自動的にミュートをオン
moziConfVirtualExtraSetting	Object	予約会議の設定。
waitingRoom	Integer	待機室： - 0：オフ - 1：オン
joinBeforeHost	Integer	主催者の入室前に会議に参加： - 0：オフ - 1：オン
enableChat	Integer	チャットとインタラクション： - 0：オフ - 1：オン
lockNick	Integer	自身の名前変更： - 0：自身の名前変更を許可 - 1：自身の名前変更を禁止
lockMediaStatusMicMute	Integer	自身でミュート解除： - 0：自身でのミュート解除を許可 - 1：自身でのミュート解除を禁止
moziConfExtensionAppSettings	Array	会議の拡張アプリ設定リスト。
clientId	String	DingTalk オープンアプリの clientId。
coolAppCode	String	クールアプリ Code。開発者バックエンドのマイクロアプリでクールアプリ Code を確認できます。
autoOpenMode	String	自動オープンモード： - 0：自動で開かない - 1：主催者／共同主催者のみ自動で開く - 2：全員自動で開く
extensionAppBizData	String	会議ディメンションの拡張アプリのカスタム情報。
enableWebAnonymousJoin	Boolean	Web 端でのサイレントログインによる会議参加に対応するかどうか： - true：対応 - false：非対応

レスポンスボディ例

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

{
  "scheduleConfSettingModel" : {
    "hostUnionId" : "mE4lK7nFiPFhudV2Ch17AMwiEi",
    "cohostUnionIds" : [ "2iPOLbpUNMLzB5LuwggiiqiPwiEiE" ],
    "confAllowedCorpId" : "dingc02f685fa06381c44ac5d6980864d335",
    "lockRoom" : 1,
    "screenShareForbidden" : 1,
    "muteOnJoin" : 6,
    "moziConfVirtualExtraSetting" : {
      "waitingRoom" : 1,
      "joinBeforeHost" : 1,
      "enableChat" : 1,
      "lockNick" : 1,
      "lockMediaStatusMicMute" : 1,
      "moziConfExtensionAppSettings" : [ {
        "clientId" : "dingwklgz6xxx5yltcyr",
        "coolAppCode" : "COOLAPP-0-1026633886192127xxxB000W",
        "autoOpenMode" : "1",
        "extensionAppBizData" : "bizData"
      } ],
      "enableWebAnonymousJoin" : true
    }
  }
}

エラーコード

この API の呼び出し時にエラーが発生した場合は、エラーメッセージに基づきグローバルエラーコードドキュメントから解決方法を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	paramError	パラメータエラーです。入力パラメータを確認してください
400	scheduleConferenceIdError	scheduleConferenceIdError	予約会議 ID エラー
400	userNotInOrg	userNotInOrg	ユーザーが組織内に存在しません
403	noPermission	noPermission	操作権限がありません
500	systemError	systemError	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード