Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/calendar/users/{userId}/meetingRooms/schedules/query |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-Calendar.Event.Read-Izin baca untuk acara di aplikasi Kalender |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan sebagai berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token organisasi yang diberi otorisasi ke aplikasi pihak ketiga. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| userId | String | Ya | unionId pengguna yang memiliki resource untuk permintaan ini. Panggil API Kueri detail pengguna untuk mendapatkannya. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| roomIds | Array of String | Ya | Daftar roomIds yang akan dikueri. Panggil API Kueri daftar ruang untuk mendapatkannya. Kami menyarankan jumlah roomIds tidak lebih dari 5. |
| startTime | String | Ya | Waktu mulai kueri, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| endTime | String | Ya | Waktu akhir kueri, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
Contoh permintaan
HTTPPOST /v1.0/calendar/users/U5KPxxxxx/meetingRooms/schedules/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"roomIds" : [ "4002xxxxx" ],
"startTime" : "2020-01-01T10:15:30+08:00",
"endTime" : "2020-01-01T10:15:30+08:00"
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.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.GetMeetingRoomsScheduleHeaders getMeetingRoomsScheduleHeaders = new com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleHeaders();
getMeetingRoomsScheduleHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleRequest getMeetingRoomsScheduleRequest = new com.aliyun.dingtalkcalendar_1_0.models.GetMeetingRoomsScheduleRequest()
.setRoomIds(java.util.Arrays.asList(
"4002xxxxx"
))
.setStartTime("2020-01-01T10:15:30+08:00")
.setEndTime("2020-01-01T10:15:30+08:00");
try {
client.getMeetingRoomsScheduleWithOptions("U5KPxxxxx", getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, 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 berisi atribut code dan message untuk membantu menemukan masalah
}
} 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 berisi atribut code dan message untuk membantu menemukan masalah
}
}
}
}
# -*- 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 with 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()
get_meeting_rooms_schedule_headers = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleHeaders()
get_meeting_rooms_schedule_headers.x_acs_dingtalk_access_token = '<your access token>'
get_meeting_rooms_schedule_request = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleRequest(
room_ids=[
'4002xxxxx'
],
start_time='2020-01-01T10:15:30+08:00',
end_time='2020-01-01T10:15:30+08:00'
)
try:
client.get_meeting_rooms_schedule_with_options('U5KPxxxxx', get_meeting_rooms_schedule_request, get_meeting_rooms_schedule_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message untuk membantu menemukan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_meeting_rooms_schedule_headers = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleHeaders()
get_meeting_rooms_schedule_headers.x_acs_dingtalk_access_token = '<your access token>'
get_meeting_rooms_schedule_request = dingtalkcalendar__1__0_models.GetMeetingRoomsScheduleRequest(
room_ids=[
'4002xxxxx'
],
start_time='2020-01-01T10:15:30+08:00',
end_time='2020-01-01T10:15:30+08:00'
)
try:
await client.get_meeting_rooms_schedule_with_options_async('U5KPxxxxx', get_meeting_rooms_schedule_request, get_meeting_rooms_schedule_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message untuk membantu menemukan masalah
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\GetMeetingRoomsScheduleHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\GetMeetingRoomsScheduleRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with a Token
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$getMeetingRoomsScheduleHeaders = new GetMeetingRoomsScheduleHeaders([]);
$getMeetingRoomsScheduleHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getMeetingRoomsScheduleRequest = new GetMeetingRoomsScheduleRequest([
"roomIds" => [
"4002xxxxx"
],
"startTime" => "2020-01-01T10:15:30+08:00",
"endTime" => "2020-01-01T10:15:30+08:00"
]);
try {
$client->getMeetingRoomsScheduleWithOptions("U5KPxxxxx", $getMeetingRoomsScheduleRequest, $getMeetingRoomsScheduleHeaders, 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 berisi atribut code dan message untuk membantu menemukan masalah
}
}
}
}
$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 with 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
}
getMeetingRoomsScheduleHeaders := &dingtalkcalendar_1_0.GetMeetingRoomsScheduleHeaders{}
getMeetingRoomsScheduleHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getMeetingRoomsScheduleRequest := &dingtalkcalendar_1_0.GetMeetingRoomsScheduleRequest{
RoomIds: []*string{tea.String("4002xxxxx")},
StartTime: tea.String("2020-01-01T10:15:30+08:00"),
EndTime: tea.String("2020-01-01T10:15:30+08:00"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetMeetingRoomsScheduleWithOptions(tea.String("U5KPxxxxx"), getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, &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 berisi atribut code dan message untuk membantu menemukan masalah
}
}
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 with 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 getMeetingRoomsScheduleHeaders = new $dingtalkcalendar_1_0.GetMeetingRoomsScheduleHeaders({ });
getMeetingRoomsScheduleHeaders.xAcsDingtalkAccessToken = "<your access token>";
let getMeetingRoomsScheduleRequest = new $dingtalkcalendar_1_0.GetMeetingRoomsScheduleRequest({
roomIds: [
"4002xxxxx"
],
startTime: "2020-01-01T10:15:30+08:00",
endTime: "2020-01-01T10:15:30+08:00",
});
try {
await client.getMeetingRoomsScheduleWithOptions("U5KPxxxxx", getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message untuk membantu menemukan masalah
}
}
}
}
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 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.GetMeetingRoomsScheduleHeaders getMeetingRoomsScheduleHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleHeaders();
getMeetingRoomsScheduleHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleRequest getMeetingRoomsScheduleRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.GetMeetingRoomsScheduleRequest
{
RoomIds = new List<string>
{
"4002xxxxx"
},
StartTime = "2020-01-01T10:15:30+08:00",
EndTime = "2020-01-01T10:15:30+08:00",
};
try
{
client.GetMeetingRoomsScheduleWithOptions("U5KPxxxxx", getMeetingRoomsScheduleRequest, getMeetingRoomsScheduleHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi atribut code dan message untuk membantu menemukan masalah
}
}
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 berisi atribut code dan message untuk membantu menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| scheduleInformation | Array | Daftar informasi luang/sibuk ruang. |
| roomId | String | roomId ruang. |
| error | String | Pesan error. |
| scheduleItems | Array | Daftar informasi luang/sibuk. Jika bidang ini mengembalikan nilai kosong, ruang tersebut senggang selama rentang waktu yang ditentukan. |
| status | String | Status luang/sibuk. - BUSY: Sibuk - TENTATIVE: Menunggu persetujuan |
| eventId | String | ID acara. |
| organizer | Object | Informasi tentang penyelenggara acara. |
| id | String | unionId penyelenggara. |
| start | Object | Informasi tentang waktu mulai acara. |
| dateTime | String | Waktu mulai acara, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| timeZone | String | Nama zona waktu, mengikuti standar IANA Time Zone Database. Contoh: Asia/Shanghai. Untuk acara sepanjang hari, zona waktu ditetapkan ke UTC. Untuk acara yang bukan sepanjang hari, zona waktu default adalah Asia/Shanghai. |
| end | Object | Informasi tentang waktu akhir acara. |
| dateTime | String | Waktu akhir acara, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| timeZone | String | Nama zona waktu, mengikuti standar IANA Time Zone Database. Contoh: Asia/Shanghai. Untuk acara sepanjang hari, zona waktu ditetapkan ke UTC. Untuk acara yang bukan sepanjang hari, zona waktu default adalah Asia/Shanghai. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"scheduleInformation" : [ {
"roomId" : "4002f89xxxxx",
"error" : "No permission",
"scheduleItems" : [ {
"status" : "BUSY",
"eventId" : "UzZvxxxxx",
"organizer" : {
"id" : "WWxlK8xxxxx"
},
"start" : {
"dateTime" : "2020-01-01T10:15:30+08:00",
"timeZone" : "Asia/Shanghai"
},
"end" : {
"dateTime" : "2020-01-02T10:15:30+08:00",
"timeZone" : "Asia/Shanghai"
}
} ]
} ]
}
Kode error
Jika panggilan API gagal, temukan solusinya berdasarkan pesan error di dokumen Kode error global.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalidParameter | forwardErrorMessage | Parameter tidak valid |
| 400 | invalidParameter | query ids cannot be empty | ID kueri tidak boleh kosong |
| 400 | invalidParameter | Cannot get schedule information for more than limit. | Jumlah kueri melebihi batas |
| 400 | invalidParameter | Cannot query schedule for more than 90 days. | Durasi kueri melebihi batas |
| 400 | invalidParameter | roomId invalid | roomId tidak valid |
| 400 | meetingRoomNotAvailable | room busy | Ruang sudah terisi |