Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}/meetingRooms |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permissions | permission-Calendar.Event.Write-Write permission for events in the Calendar app |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential used to call 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 the authorized enterprise API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | The unionId of the event creator. Call the Query user details API to obtain it. |
| calendarId | String | Yes | The ID of the calendar that the event belongs to. The value is fixed as primary, which represents the user’s primary calendar. |
| eventId | String | Yes | The event ID. Call the Query an event list API to obtain the value of the id parameter. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| meetingRoomsToAdd | Array | Yes | The list of roomId values for rooms to be booked. Up to 5 rooms can be added to a single event. |
| roomId | String | No | The list of roomId values for rooms to be booked. Call the Query the room list API to obtain the values. Up to 5 rooms can be added to a single event. |
Request example
HTTPPOST /v1.0/calendar/users/U5Kxxxxx/calendars/primary/events/cnNTxxxxx/meetingRooms HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"meetingRoomsToAdd" : [ {
"roomId" : "4002fxxxxx"
} ]
}
// 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 a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkcalendar_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.dingtalkcalendar_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkcalendar_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkcalendar_1_0.models.AddMeetingRoomsHeaders addMeetingRoomsHeaders = new com.aliyun.dingtalkcalendar_1_0.models.AddMeetingRoomsHeaders();
addMeetingRoomsHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkcalendar_1_0.models.AddMeetingRoomsRequest.AddMeetingRoomsRequestMeetingRoomsToAdd meetingRoomsToAdd0 = new com.aliyun.dingtalkcalendar_1_0.models.AddMeetingRoomsRequest.AddMeetingRoomsRequestMeetingRoomsToAdd()
.setRoomId("4002fxxxxx");
com.aliyun.dingtalkcalendar_1_0.models.AddMeetingRoomsRequest addMeetingRoomsRequest = new com.aliyun.dingtalkcalendar_1_0.models.AddMeetingRoomsRequest()
.setMeetingRoomsToAdd(java.util.Arrays.asList(
meetingRoomsToAdd0
));
try {
client.addMeetingRoomsWithOptions("U5Kxxxxx", "primary", "cnNTxxxxx", addMeetingRoomsRequest, addMeetingRoomsHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err object contains code and message properties to help you troubleshoot 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)) {
// The err object contains code and message properties to help you troubleshoot the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.calendar_1_0.client import Client as dingtalkcalendar_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.calendar_1_0 import models as dingtalkcalendar__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() -> dingtalkcalendar_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 dingtalkcalendar_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
add_meeting_rooms_headers = dingtalkcalendar__1__0_models.AddMeetingRoomsHeaders()
add_meeting_rooms_headers.x_acs_dingtalk_access_token = '<your access token>'
meeting_rooms_to_add_0 = dingtalkcalendar__1__0_models.AddMeetingRoomsRequestMeetingRoomsToAdd(
room_id='4002fxxxxx'
)
add_meeting_rooms_request = dingtalkcalendar__1__0_models.AddMeetingRoomsRequest(
meeting_rooms_to_add=[
meeting_rooms_to_add_0
]
)
try:
client.add_meeting_rooms_with_options('U5Kxxxxx', 'primary', 'cnNTxxxxx', add_meeting_rooms_request, add_meeting_rooms_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err object contains code and message properties to help you troubleshoot the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
add_meeting_rooms_headers = dingtalkcalendar__1__0_models.AddMeetingRoomsHeaders()
add_meeting_rooms_headers.x_acs_dingtalk_access_token = '<your access token>'
meeting_rooms_to_add_0 = dingtalkcalendar__1__0_models.AddMeetingRoomsRequestMeetingRoomsToAdd(
room_id='4002fxxxxx'
)
add_meeting_rooms_request = dingtalkcalendar__1__0_models.AddMeetingRoomsRequest(
meeting_rooms_to_add=[
meeting_rooms_to_add_0
]
)
try:
await client.add_meeting_rooms_with_options_async('U5Kxxxxx', 'primary', 'cnNTxxxxx', add_meeting_rooms_request, add_meeting_rooms_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err object contains code and message properties to help you troubleshoot the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddMeetingRoomsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddMeetingRoomsRequest\meetingRoomsToAdd;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddMeetingRoomsRequest;
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();
$addMeetingRoomsHeaders = new AddMeetingRoomsHeaders([]);
$addMeetingRoomsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$meetingRoomsToAdd0 = new meetingRoomsToAdd([
"roomId" => "4002fxxxxx"
]);
$addMeetingRoomsRequest = new AddMeetingRoomsRequest([
"meetingRoomsToAdd" => [
$meetingRoomsToAdd0
]
]);
try {
$client->addMeetingRoomsWithOptions("U5Kxxxxx", "primary", "cnNTxxxxx", $addMeetingRoomsRequest, $addMeetingRoomsHeaders, 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)) {
// The err object contains code and message properties to help you troubleshoot 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"
dingtalkcalendar_1_0 "github.com/alibabacloud-go/dingtalk/calendar_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account client using a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkcalendar_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkcalendar_1_0.Client{}
_result, _err = dingtalkcalendar_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
addMeetingRoomsHeaders := &dingtalkcalendar_1_0.AddMeetingRoomsHeaders{}
addMeetingRoomsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
meetingRoomsToAdd0 := &dingtalkcalendar_1_0.AddMeetingRoomsRequestMeetingRoomsToAdd{
RoomId: tea.String("4002fxxxxx"),
}
addMeetingRoomsRequest := &dingtalkcalendar_1_0.AddMeetingRoomsRequest{
MeetingRoomsToAdd: []*dingtalkcalendar_1_0.AddMeetingRoomsRequestMeetingRoomsToAdd{meetingRoomsToAdd0},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.AddMeetingRoomsWithOptions(tea.String("U5Kxxxxx"), tea.String("primary"), tea.String("cnNTxxxxx"), addMeetingRoomsRequest, addMeetingRoomsHeaders, &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)) {
// The err object contains code and message properties to help you troubleshoot the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcalendar_1_0, * as $dingtalkcalendar_1_0 from '@alicloud/dingtalk/calendar_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 a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkcalendar_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkcalendar_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let addMeetingRoomsHeaders = new $dingtalkcalendar_1_0.AddMeetingRoomsHeaders({ });
addMeetingRoomsHeaders.xAcsDingtalkAccessToken = "<your access token>";
let meetingRoomsToAdd0 = new $dingtalkcalendar_1_0.AddMeetingRoomsRequestMeetingRoomsToAdd({
roomId: "4002fxxxxx",
});
let addMeetingRoomsRequest = new $dingtalkcalendar_1_0.AddMeetingRoomsRequest({
meetingRoomsToAdd: [
meetingRoomsToAdd0
],
});
try {
await client.addMeetingRoomsWithOptions("U5Kxxxxx", "primary", "cnNTxxxxx", addMeetingRoomsRequest, addMeetingRoomsHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err object contains code and message properties to help you troubleshoot 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 a Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsHeaders addMeetingRoomsHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsHeaders();
addMeetingRoomsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsRequest.AddMeetingRoomsRequestMeetingRoomsToAdd meetingRoomsToAdd0 = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsRequest.AddMeetingRoomsRequestMeetingRoomsToAdd
{
RoomId = "4002fxxxxx",
};
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsRequest addMeetingRoomsRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsRequest
{
MeetingRoomsToAdd = new List<AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddMeetingRoomsRequest.AddMeetingRoomsRequestMeetingRoomsToAdd>
{
meetingRoomsToAdd0
},
};
try
{
client.AddMeetingRoomsWithOptions("U5Kxxxxx", "primary", "cnNTxxxxx", addMeetingRoomsRequest, addMeetingRoomsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err object contains code and message properties to help you troubleshoot 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))
{
// The err object contains code and message properties to help you troubleshoot the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| result | Boolean | Indicates whether the request was successful. A value of true indicates success. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : true
}
Error codes
If an error occurs when you call this API, refer to the Global error codes document to find a solution based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | invalidParameter | forwardErrorMessage | Invalid parameter |
| 400 | invalidParameter | roomId must be provided. | roomId cannot be empty |
| 400 | invalidParameter | attendees batch size too large. Maximum allowed:5 | The number of rooms exceeds the limit. The maximum is 5. |
| 400 | invalidParameter | roomId invalid | The room ID is invalid |
| 400 | meetingRoomNotAvailable | forwardErrorMessage | The room is already booked |