Create a booked meeting

Create a booked meeting based on information such as the creator, booked meeting title, and start and end times.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/conference/scheduleConferences
HTTP Method	POST
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-VideoConference.Conference.Write-Video Meeting information management permission

Request header

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call the 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 organization authorized to a third-party app API to obtain it.

Request body

Name	Type	Required	Description
creatorUnionId	String	Yes	The unionId of the creator.
title	String	Yes	The Title of the booked meeting. The maximum length is 50 characters. Titles longer than 50 characters are truncated. Titles longer than 256 characters cause the API call to fail.
startTime	Long	Yes	The start time of the booked meeting, as a UTC timestamp in milliseconds.
endTime	Long	Yes	The end time of the booked meeting, as a UTC timestamp in milliseconds.
scheduleConfSettingModel	Object	No	Booked meeting Settings.
hostUnionId	String	No	The unionId of the Host.
confAllowedCorpId	String	No	The organization ID for an internal meeting.
lockRoom	Integer	No	Lock the meeting: - 0: Unlock - 1: Lock
screenShareForbidden	Integer	No	Start sharing: - 0: Allow sharing - 1: Forbid sharing
muteOnJoin	Integer	No	Mute users when they join the conference: - -1: On - 0: Off - 6: Automatically mute when more than 6 users join
moziConfVirtualExtraSetting	Object	No	Booked meeting Settings.
waitingRoom	Integer	No	Waiting room: - 1: On - 2: Off
joinBeforeHost	Integer	No	Allow users to join the conference before the Host: - 0: Off - 1: On
enableChat	Integer	No	Chat and Interaction: - 0: Off - 1: On
lockNick	Integer	No	Allow users to rename themselves: - 0: Allow users to rename themselves - 1: Forbid users from renaming themselves
lockMediaStatusMicMute	Integer	No	Allow users to unmute themselves: - 0: Allow users to unmute themselves - 1: Forbid users from unmuting themselves
moziConfExtensionAppSettings	Array	No	The List of Meeting extension App settings.
coolAppCode	String	No	The appCode of the cool app.
autoOpenMode	Integer	No	Whether to Open automatically: - 0: Do not Open automatically - 1: Only the Host and co-hosts Open automatically - 2: All users Open automatically
extensionAppBizData	String	No	Custom information for the meeting-level extension App.
enableWebAnonymousJoin	Boolean	No	Whether to support silent login to join the conference from the web: - true: Supported - false: Not supported
pushAllMeetingRecords	Boolean	No	Whether to push all Meeting Notes: - true: push all records - false: push only Meeting Notes whose actual time falls within the planned time range of the booked meeting. Outside the planned time range of the booked meeting is defined as: meeting start time > planned end time of the booked meeting, or meeting end time > planned start time of the booked meeting.
pushMinutesCard	Boolean	No	Whether to push the AI Minutes Card: - true: push - false: do not push Pushed by default.
pushCloudRecordCard	Boolean	No	Whether to push the cloud recording AI Minutes Card: - true: push - false: do not push Pushed by default.
minutesOwnerUnionId	String	No	The owner of AI Minutes. Defaults to the booked meeting organizer.
cloudRecordOwnerUnionId	String	No	The owner of the cloud recording. Defaults to the booked meeting organizer.
minutesSummaryTemplateType	String	No	The Template specified for the cloud recording summary: - 0: Official Template. - 1: Custom Template.
minutesSummaryTemplateId	String	No	- If `minutesSummaryTemplateType= 0`, pass the ID of the corresponding official Template. - If `minutesSummaryTemplateType = 1`, pass the ID of the corresponding Custom Template.
minutesSummaryDiyTemplateVersion	String	No	- If `minutesSummaryTemplateType = 0`, no value is required. - If `minutesSummaryTemplateType = 1`, pass the Version number of the corresponding Custom Template.
hiddenOwnerNick	Boolean	No	Whether to hide the Name of the cloud recording initiator: - true: hide the initiator Name - false (default): do not hide
cohostUnionIds	Array of String	No	The unionId of the co-Host.
moziConfOpenRecordSetting	Object	No	Automatic Record settings.
recordAutoStart	Integer	No	Whether to automatically start cloud recording: - 0: Do not start automatically - 1: Start automatically
recordAutoStartType	Integer	No	The type of automatic cloud recording start: - 0: Start automatically after I join as the Host - 1: Start after others join as co-Host - 2: Start after anyone joins in any role
mode	String	No	The Layout of the meeting recording: - grid: grid mode, defaults to 9-grid (3x3) - speech: speaker mode - full_screen: full-screen mode - auto_grid: automatic grid mode, defaults to a maximum 4x4 grid - screen_cast: screen Share mode, displays only the screen Share stream - p2p: two-person Call mode - full_screen_and_speaker: shared Content + speaker mode
isFollowHost	Boolean	No	Whether to follow the Host: - true: follow - false: do not follow
restrictShareMinutesSummaryOnly	Integer	No	Whether to restrict Share of AI Minutes to summary only: - 0: no restriction - 1: restrict
aiAgentSummarySetting	Object	No	Meeting AI Minutes settings.
value	String	No	Whether to enable AI Assistant summary: - disable: Off - enable: On
receiverType	Integer	No	The scope of AI Minutes push recipients after the meeting: - 0: all Members - 1: only the Created by
allowAllParticipantsStart	Integer	No	Whether to Allow all Members to start AI Minutes: - 0: Not allowed - 1: Allow
restrictShareMinutesSummaryOnly	Integer	No	Whether to restrict Share of AI Minutes to summary only: - 0: no restriction - 1: restrict
enableAiAgentStatus	Boolean	No	Whether to display the AI Minutes feature: - true: display - false: do not display (effective on Android DingTalk version 8.3.20 or later; effective on iOS, PC, and other platforms)

Request example

HTTP

POST /v1.0/conference/scheduleConferences HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:2d7fbxxxxaeb3d
Content-Type:application/json

{
  "creatorUnionId" : "qzR1ixxxx9iP7",
  "title" : "Booked meeting title",
  "startTime" : 1687924800000,
  "endTime" : 1687928400000,
  "scheduleConfSettingModel" : {
    "hostUnionId" : "2iPOxxxxwiEiE",
    "confAllowedCorpId" : "dingxxxx335",
    "lockRoom" : 0,
    "screenShareForbidden" : 0,
    "muteOnJoin" : -1,
    "moziConfVirtualExtraSetting" : {
      "waitingRoom" : 0,
      "joinBeforeHost" : 0,
      "enableChat" : 0,
      "lockNick" : 0,
      "lockMediaStatusMicMute" : 0,
      "moziConfExtensionAppSettings" : [ {
        "coolAppCode" : "COOxxxxB000W",
        "autoOpenMode" : 0,
        "extensionAppBizData" : "bizData"
      } ],
      "enableWebAnonymousJoin" : true,
      "pushAllMeetingRecords" : true,
      "pushMinutesCard" : true,
      "pushCloudRecordCard" : true,
      "minutesOwnerUnionId" : "2iPxxxxwiEiE",
      "cloudRecordOwnerUnionId" : "2iPxxxxwiEiE",
      "minutesSummaryTemplateType" : "0",
      "minutesSummaryTemplateId" : "default",
      "minutesSummaryDiyTemplateVersion" : "1",
      "hiddenOwnerNick" : true
    },
    "cohostUnionIds" : [ "mE4lKxxxxwiEi" ],
    "moziConfOpenRecordSetting" : {
      "recordAutoStart" : 0,
      "recordAutoStartType" : 0,
      "mode" : "grid",
      "isFollowHost" : true,
      "restrictShareMinutesSummaryOnly" : 0
    },
    "aiAgentSummarySetting" : {
      "value" : "disable",
      "receiverType" : 1,
      "allowAllParticipantsStart" : 0,
      "restrictShareMinutesSummaryOnly" : 0
    }
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using a Token</p>
     * @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 {
        
        com.aliyun.dingtalkconference_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceHeaders createScheduleConferenceHeaders = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceHeaders();
        createScheduleConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting scheduleConfSettingModelAiAgentSummarySetting = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting()
                .setValue("disable")
                .setReceiverType(1)
                .setAllowAllParticipantsStart(0)
                .setRestrictShareMinutesSummaryOnly(0);
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting scheduleConfSettingModelMoziConfOpenRecordSetting = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting()
                .setRecordAutoStart(0)
                .setRecordAutoStartType(0)
                .setMode("grid")
                .setIsFollowHost(true)
                .setRestrictShareMinutesSummaryOnly(0);
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0 = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings()
                .setCoolAppCode("COOxxxxB000W")
                .setAutoOpenMode(0)
                .setExtensionAppBizData("bizData");
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting scheduleConfSettingModelMoziConfVirtualExtraSetting = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting()
                .setWaitingRoom(0)
                .setJoinBeforeHost(0)
                .setEnableChat(0)
                .setLockNick(0)
                .setLockMediaStatusMicMute(0)
                .setMoziConfExtensionAppSettings(java.util.Arrays.asList(
                    scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0
                ))
                .setEnableWebAnonymousJoin(true)
                .setPushAllMeetingRecords(true)
                .setPushMinutesCard(true)
                .setPushCloudRecordCard(true)
                .setMinutesOwnerUnionId("2iPxxxxwiEiE")
                .setCloudRecordOwnerUnionId("2iPxxxxwiEiE")
                .setMinutesSummaryTemplateType("0")
                .setMinutesSummaryTemplateId("default")
                .setMinutesSummaryDiyTemplateVersion("1")
                .setHiddenOwnerNick(true);
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel scheduleConfSettingModel = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel()
                .setHostUnionId("2iPOxxxxwiEiE")
                .setConfAllowedCorpId("dingxxxx335")
                .setLockRoom(0)
                .setScreenShareForbidden(0)
                .setMuteOnJoin(-1)
                .setMoziConfVirtualExtraSetting(scheduleConfSettingModelMoziConfVirtualExtraSetting)
                .setCohostUnionIds(java.util.Arrays.asList(
                    "mE4lKxxxxwiEi"
                ))
                .setMoziConfOpenRecordSetting(scheduleConfSettingModelMoziConfOpenRecordSetting)
                .setAiAgentSummarySetting(scheduleConfSettingModelAiAgentSummarySetting);
        com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest createScheduleConferenceRequest = new com.aliyun.dingtalkconference_1_0.models.CreateScheduleConferenceRequest()
                .setCreatorUnionId("qzR1ixxxx9iP7")
                .setTitle("Booked meeting title")
                .setStartTime(1687924800000L)
                .setEndTime(1687928400000L)
                .setScheduleConfSettingModel(scheduleConfSettingModel);
        try {
            client.createScheduleConferenceWithOptions(createScheduleConferenceRequest, createScheduleConferenceHeaders, 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 the code and message attributes, which 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 the code and message attributes, which help locate the issue
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

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 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()
        create_schedule_conference_headers = dingtalkconference__1__0_models.CreateScheduleConferenceHeaders()
        create_schedule_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        schedule_conf_setting_model_ai_agent_summary_setting = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting(
            value='disable',
            receiver_type=1,
            allow_all_participants_start=0,
            restrict_share_minutes_summary_only=0
        )
        schedule_conf_setting_model_mozi_conf_open_record_setting = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting(
            record_auto_start=0,
            record_auto_start_type=0,
            mode='grid',
            is_follow_host=True,
            restrict_share_minutes_summary_only=0
        )
        schedule_conf_setting_model_mozi_conf_virtual_extra_setting_mozi_conf_extension_app_settings_0 = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings(
            cool_app_code='COOxxxxB000W',
            auto_open_mode=0,
            extension_app_biz_data='bizData'
        )
        schedule_conf_setting_model_mozi_conf_virtual_extra_setting = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting(
            waiting_room=0,
            join_before_host=0,
            enable_chat=0,
            lock_nick=0,
            lock_media_status_mic_mute=0,
            mozi_conf_extension_app_settings=[
                schedule_conf_setting_model_mozi_conf_virtual_extra_setting_mozi_conf_extension_app_settings_0
            ],
            enable_web_anonymous_join=True,
            push_all_meeting_records=True,
            push_minutes_card=True,
            push_cloud_record_card=True,
            minutes_owner_union_id='2iPxxxxwiEiE',
            cloud_record_owner_union_id='2iPxxxxwiEiE',
            minutes_summary_template_type='0',
            minutes_summary_template_id='default',
            minutes_summary_diy_template_version='1',
            hidden_owner_nick=True
        )
        schedule_conf_setting_model = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModel(
            host_union_id='2iPOxxxxwiEiE',
            conf_allowed_corp_id='dingxxxx335',
            lock_room=0,
            screen_share_forbidden=0,
            mute_on_join=-1,
            mozi_conf_virtual_extra_setting=schedule_conf_setting_model_mozi_conf_virtual_extra_setting,
            cohost_union_ids=[
                'mE4lKxxxxwiEi'
            ],
            mozi_conf_open_record_setting=schedule_conf_setting_model_mozi_conf_open_record_setting,
            ai_agent_summary_setting=schedule_conf_setting_model_ai_agent_summary_setting
        )
        create_schedule_conference_request = dingtalkconference__1__0_models.CreateScheduleConferenceRequest(
            creator_union_id='qzR1ixxxx9iP7',
            title='Booked meeting title',
            start_time=1687924800000,
            end_time=1687928400000,
            schedule_conf_setting_model=schedule_conf_setting_model
        )
        try:
            client.create_schedule_conference_with_options(create_schedule_conference_request, create_schedule_conference_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_schedule_conference_headers = dingtalkconference__1__0_models.CreateScheduleConferenceHeaders()
        create_schedule_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        schedule_conf_setting_model_ai_agent_summary_setting = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting(
            value='disable',
            receiver_type=1,
            allow_all_participants_start=0,
            restrict_share_minutes_summary_only=0
        )
        schedule_conf_setting_model_mozi_conf_open_record_setting = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting(
            record_auto_start=0,
            record_auto_start_type=0,
            mode='grid',
            is_follow_host=True,
            restrict_share_minutes_summary_only=0
        )
        schedule_conf_setting_model_mozi_conf_virtual_extra_setting_mozi_conf_extension_app_settings_0 = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings(
            cool_app_code='COOxxxxB000W',
            auto_open_mode=0,
            extension_app_biz_data='bizData'
        )
        schedule_conf_setting_model_mozi_conf_virtual_extra_setting = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting(
            waiting_room=0,
            join_before_host=0,
            enable_chat=0,
            lock_nick=0,
            lock_media_status_mic_mute=0,
            mozi_conf_extension_app_settings=[
                schedule_conf_setting_model_mozi_conf_virtual_extra_setting_mozi_conf_extension_app_settings_0
            ],
            enable_web_anonymous_join=True,
            push_all_meeting_records=True,
            push_minutes_card=True,
            push_cloud_record_card=True,
            minutes_owner_union_id='2iPxxxxwiEiE',
            cloud_record_owner_union_id='2iPxxxxwiEiE',
            minutes_summary_template_type='0',
            minutes_summary_template_id='default',
            minutes_summary_diy_template_version='1',
            hidden_owner_nick=True
        )
        schedule_conf_setting_model = dingtalkconference__1__0_models.CreateScheduleConferenceRequestScheduleConfSettingModel(
            host_union_id='2iPOxxxxwiEiE',
            conf_allowed_corp_id='dingxxxx335',
            lock_room=0,
            screen_share_forbidden=0,
            mute_on_join=-1,
            mozi_conf_virtual_extra_setting=schedule_conf_setting_model_mozi_conf_virtual_extra_setting,
            cohost_union_ids=[
                'mE4lKxxxxwiEi'
            ],
            mozi_conf_open_record_setting=schedule_conf_setting_model_mozi_conf_open_record_setting,
            ai_agent_summary_setting=schedule_conf_setting_model_ai_agent_summary_setting
        )
        create_schedule_conference_request = dingtalkconference__1__0_models.CreateScheduleConferenceRequest(
            creator_union_id='qzR1ixxxx9iP7',
            title='Booked meeting title',
            start_time=1687924800000,
            end_time=1687928400000,
            schedule_conf_setting_model=schedule_conf_setting_model
        )
        try:
            await client.create_schedule_conference_with_options_async(create_schedule_conference_request, create_schedule_conference_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which 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\CreateScheduleConferenceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateScheduleConferenceRequest\scheduleConfSettingModel\aiAgentSummarySetting;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateScheduleConferenceRequest\scheduleConfSettingModel\moziConfOpenRecordSetting;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateScheduleConferenceRequest\scheduleConfSettingModel\moziConfVirtualExtraSetting\moziConfExtensionAppSettings;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateScheduleConferenceRequest\scheduleConfSettingModel\moziConfVirtualExtraSetting;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateScheduleConferenceRequest\scheduleConfSettingModel;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\CreateScheduleConferenceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $createScheduleConferenceHeaders = new CreateScheduleConferenceHeaders([]);
        $createScheduleConferenceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $scheduleConfSettingModelAiAgentSummarySetting = new aiAgentSummarySetting([
            "value" => "disable",
            "receiverType" => 1,
            "allowAllParticipantsStart" => 0,
            "restrictShareMinutesSummaryOnly" => 0
        ]);
        $scheduleConfSettingModelMoziConfOpenRecordSetting = new moziConfOpenRecordSetting([
            "recordAutoStart" => 0,
            "recordAutoStartType" => 0,
            "mode" => "grid",
            "isFollowHost" => true,
            "restrictShareMinutesSummaryOnly" => 0
        ]);
        $scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0 = new moziConfExtensionAppSettings([
            "coolAppCode" => "COOxxxxB000W",
            "autoOpenMode" => 0,
            "extensionAppBizData" => "bizData"
        ]);
        $scheduleConfSettingModelMoziConfVirtualExtraSetting = new moziConfVirtualExtraSetting([
            "waitingRoom" => 0,
            "joinBeforeHost" => 0,
            "enableChat" => 0,
            "lockNick" => 0,
            "lockMediaStatusMicMute" => 0,
            "moziConfExtensionAppSettings" => [
                $scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0
            ],
            "enableWebAnonymousJoin" => true,
            "pushAllMeetingRecords" => true,
            "pushMinutesCard" => true,
            "pushCloudRecordCard" => true,
            "minutesOwnerUnionId" => "2iPxxxxwiEiE",
            "cloudRecordOwnerUnionId" => "2iPxxxxwiEiE",
            "minutesSummaryTemplateType" => "0",
            "minutesSummaryTemplateId" => "default",
            "minutesSummaryDiyTemplateVersion" => "1",
            "hiddenOwnerNick" => true
        ]);
        $scheduleConfSettingModel = new scheduleConfSettingModel([
            "hostUnionId" => "2iPOxxxxwiEiE",
            "confAllowedCorpId" => "dingxxxx335",
            "lockRoom" => 0,
            "screenShareForbidden" => 0,
            "muteOnJoin" => -1,
            "moziConfVirtualExtraSetting" => $scheduleConfSettingModelMoziConfVirtualExtraSetting,
            "cohostUnionIds" => [
                "mE4lKxxxxwiEi"
            ],
            "moziConfOpenRecordSetting" => $scheduleConfSettingModelMoziConfOpenRecordSetting,
            "aiAgentSummarySetting" => $scheduleConfSettingModelAiAgentSummarySetting
        ]);
        $createScheduleConferenceRequest = new CreateScheduleConferenceRequest([
            "creatorUnionId" => "qzR1ixxxx9iP7",
            "title" => "Booked meeting title",
            "startTime" => 1687924800000,
            "endTime" => 1687928400000,
            "scheduleConfSettingModel" => $scheduleConfSettingModel
        ]);
        try {
            $client->createScheduleConferenceWithOptions($createScheduleConferenceRequest, $createScheduleConferenceHeaders, 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 the code and message attributes, which 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));

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

  createScheduleConferenceHeaders := &dingtalkconference_1_0.CreateScheduleConferenceHeaders{}
  createScheduleConferenceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  scheduleConfSettingModelAiAgentSummarySetting := &dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting{
    Value: tea.String("disable"),
    ReceiverType: tea.Int32(1),
    AllowAllParticipantsStart: tea.Int32(0),
    RestrictShareMinutesSummaryOnly: tea.Int32(0),
  }
  scheduleConfSettingModelMoziConfOpenRecordSetting := &dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting{
    RecordAutoStart: tea.Int32(0),
    RecordAutoStartType: tea.Int32(0),
    Mode: tea.String("grid"),
    IsFollowHost: tea.Bool(true),
    RestrictShareMinutesSummaryOnly: tea.Int32(0),
  }
  scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0 := &dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings{
    CoolAppCode: tea.String("COOxxxxB000W"),
    AutoOpenMode: tea.Int32(0),
    ExtensionAppBizData: tea.String("bizData"),
  }
  scheduleConfSettingModelMoziConfVirtualExtraSetting := &dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting{
    WaitingRoom: tea.Int32(0),
    JoinBeforeHost: tea.Int32(0),
    EnableChat: tea.Int32(0),
    LockNick: tea.Int32(0),
    LockMediaStatusMicMute: tea.Int32(0),
    MoziConfExtensionAppSettings: []*dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings{scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0},
    EnableWebAnonymousJoin: tea.Bool(true),
    PushAllMeetingRecords: tea.Bool(true),
    PushMinutesCard: tea.Bool(true),
    PushCloudRecordCard: tea.Bool(true),
    MinutesOwnerUnionId: tea.String("2iPxxxxwiEiE"),
    CloudRecordOwnerUnionId: tea.String("2iPxxxxwiEiE"),
    MinutesSummaryTemplateType: tea.String("0"),
    MinutesSummaryTemplateId: tea.String("default"),
    MinutesSummaryDiyTemplateVersion: tea.String("1"),
    HiddenOwnerNick: tea.Bool(true),
  }
  scheduleConfSettingModel := &dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModel{
    HostUnionId: tea.String("2iPOxxxxwiEiE"),
    ConfAllowedCorpId: tea.String("dingxxxx335"),
    LockRoom: tea.Int32(0),
    ScreenShareForbidden: tea.Int32(0),
    MuteOnJoin: tea.Int32(-1),
    MoziConfVirtualExtraSetting: scheduleConfSettingModelMoziConfVirtualExtraSetting,
    CohostUnionIds: []*string{tea.String("mE4lKxxxxwiEi")},
    MoziConfOpenRecordSetting: scheduleConfSettingModelMoziConfOpenRecordSetting,
    AiAgentSummarySetting: scheduleConfSettingModelAiAgentSummarySetting,
  }
  createScheduleConferenceRequest := &dingtalkconference_1_0.CreateScheduleConferenceRequest{
    CreatorUnionId: tea.String("qzR1ixxxx9iP7"),
    Title: tea.String("Booked meeting title"),
    StartTime: tea.Int64(1687924800000),
    EndTime: tea.Int64(1687928400000),
    ScheduleConfSettingModel: scheduleConfSettingModel,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateScheduleConferenceWithOptions(createScheduleConferenceRequest, createScheduleConferenceHeaders, &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 the code and message attributes, which help 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 using a 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 createScheduleConferenceHeaders = new dingtalkconference_1_0.CreateScheduleConferenceHeaders({ });
    createScheduleConferenceHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let scheduleConfSettingModelAiAgentSummarySetting = new dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting({
      value: 'disable',
      receiverType: 1,
      allowAllParticipantsStart: 0,
      restrictShareMinutesSummaryOnly: 0,
    });
    let scheduleConfSettingModelMoziConfOpenRecordSetting = new dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting({
      recordAutoStart: 0,
      recordAutoStartType: 0,
      mode: 'grid',
      isFollowHost: true,
      restrictShareMinutesSummaryOnly: 0,
    });
    let scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0 = new dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings({
      coolAppCode: 'COOxxxxB000W',
      autoOpenMode: 0,
      extensionAppBizData: 'bizData',
    });
    let scheduleConfSettingModelMoziConfVirtualExtraSetting = new dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting({
      waitingRoom: 0,
      joinBeforeHost: 0,
      enableChat: 0,
      lockNick: 0,
      lockMediaStatusMicMute: 0,
      moziConfExtensionAppSettings: [
        scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0
      ],
      enableWebAnonymousJoin: true,
      pushAllMeetingRecords: true,
      pushMinutesCard: true,
      pushCloudRecordCard: true,
      minutesOwnerUnionId: '2iPxxxxwiEiE',
      cloudRecordOwnerUnionId: '2iPxxxxwiEiE',
      minutesSummaryTemplateType: '0',
      minutesSummaryTemplateId: 'default',
      minutesSummaryDiyTemplateVersion: '1',
      hiddenOwnerNick: true,
    });
    let scheduleConfSettingModel = new dingtalkconference_1_0.CreateScheduleConferenceRequestScheduleConfSettingModel({
      hostUnionId: '2iPOxxxxwiEiE',
      confAllowedCorpId: 'dingxxxx335',
      lockRoom: 0,
      screenShareForbidden: 0,
      muteOnJoin: -1,
      moziConfVirtualExtraSetting: scheduleConfSettingModelMoziConfVirtualExtraSetting,
      cohostUnionIds: [
        'mE4lKxxxxwiEi'
      ],
      moziConfOpenRecordSetting: scheduleConfSettingModelMoziConfOpenRecordSetting,
      aiAgentSummarySetting: scheduleConfSettingModelAiAgentSummarySetting,
    });
    let createScheduleConferenceRequest = new dingtalkconference_1_0.CreateScheduleConferenceRequest({
      creatorUnionId: 'qzR1ixxxx9iP7',
      title: 'Booked meeting title',
      startTime: 1687924800000,
      endTime: 1687928400000,
      scheduleConfSettingModel: scheduleConfSettingModel,
    });
    try {
      await client.createScheduleConferenceWithOptions(createScheduleConferenceRequest, createScheduleConferenceHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client using a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.CreateScheduleConferenceHeaders createScheduleConferenceHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceHeaders();
            createScheduleConferenceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting scheduleConfSettingModelAiAgentSummarySetting = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelAiAgentSummarySetting
            {
                Value = "disable",
                ReceiverType = 1,
                AllowAllParticipantsStart = 0,
                RestrictShareMinutesSummaryOnly = 0,
            };
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting scheduleConfSettingModelMoziConfOpenRecordSetting = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfOpenRecordSetting
            {
                RecordAutoStart = 0,
                RecordAutoStartType = 0,
                Mode = "grid",
                IsFollowHost = true,
                RestrictShareMinutesSummaryOnly = 0,
            };
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0 = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings
            {
                CoolAppCode = "COOxxxxB000W",
                AutoOpenMode = 0,
                ExtensionAppBizData = "bizData",
            };
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting scheduleConfSettingModelMoziConfVirtualExtraSetting = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting
            {
                WaitingRoom = 0,
                JoinBeforeHost = 0,
                EnableChat = 0,
                LockNick = 0,
                LockMediaStatusMicMute = 0,
                MoziConfExtensionAppSettings = new List<AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSetting.CreateScheduleConferenceRequestScheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings>
                {
                    scheduleConfSettingModelMoziConfVirtualExtraSettingMoziConfExtensionAppSettings0
                },
                EnableWebAnonymousJoin = true,
                PushAllMeetingRecords = true,
                PushMinutesCard = true,
                PushCloudRecordCard = true,
                MinutesOwnerUnionId = "2iPxxxxwiEiE",
                CloudRecordOwnerUnionId = "2iPxxxxwiEiE",
                MinutesSummaryTemplateType = "0",
                MinutesSummaryTemplateId = "default",
                MinutesSummaryDiyTemplateVersion = "1",
                HiddenOwnerNick = true,
            };
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel scheduleConfSettingModel = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest.CreateScheduleConferenceRequestScheduleConfSettingModel
            {
                HostUnionId = "2iPOxxxxwiEiE",
                ConfAllowedCorpId = "dingxxxx335",
                LockRoom = 0,
                ScreenShareForbidden = 0,
                MuteOnJoin = -1,
                MoziConfVirtualExtraSetting = scheduleConfSettingModelMoziConfVirtualExtraSetting,
                CohostUnionIds = new List<string>
                {
                    "mE4lKxxxxwiEi"
                },
                MoziConfOpenRecordSetting = scheduleConfSettingModelMoziConfOpenRecordSetting,
                AiAgentSummarySetting = scheduleConfSettingModelAiAgentSummarySetting,
            };
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest createScheduleConferenceRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.CreateScheduleConferenceRequest
            {
                CreatorUnionId = "qzR1ixxxx9iP7",
                Title = "Booked meeting title",
                StartTime = 1687924800000,
                EndTime = 1687928400000,
                ScheduleConfSettingModel = scheduleConfSettingModel,
            };
            try
            {
                client.CreateScheduleConferenceWithOptions(createScheduleConferenceRequest, createScheduleConferenceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which 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 the code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
requestId	String	The request ID.
scheduleConferenceId	String	The booked meeting ID.
roomCode	String	The Meeting number.
url	String	The Share Link of the booked meeting.
phones	Array of String	The dial-in Phone number.

Response body example

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

{
  "requestId" : "1234567",
  "scheduleConferenceId" : "5c7c9bb1-xxxx-4dc5",
  "roomCode" : "83150xxxxxx",
  "url" : "https://meeting.dingtalk.io/j/knvMq1ixxxx",
  "phones" : [ "+861234567" ]
}

Error codes

If the API call returns an error, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	paramsError	error:%s	parameter error
400	paramsError	error:%s	parameter error, user unionId error
500	systemError	systemError:%s	system error

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Request

Basic information

Request header

Request body

Request example

Response

Response body

Response body example

Error codes

​Request

​Basic information

​Request header

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request header

Request body

Request example

Response

Response body

Response body example

Error codes