Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/rooms/meetingRooms/{roomId} |
| Metode HTTP | GET |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-VideoConference.Conference.Read-Izin baca untuk informasi rapat video |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Peroleh dengan cara berikut: Untuk aplikasi internal, panggil API Memperoleh access token aplikasi internal. Untuk aplikasi perusahaan pihak ketiga, panggil API Memperoleh access token perusahaan yang diberi otorisasi untuk aplikasi pihak ketiga. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| roomId | String | Ya | ID ruang rapat. Panggil API Menanyakan daftar ruang rapat untuk memperolehnya. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId operator. Panggil API Menanyakan detail pengguna untuk memperolehnya. |
Contoh permintaan
HTTPGET /v1.0/rooms/meetingRooms/0ffb7xxxxx?unionId=2iPOLxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client with a Token</p>
* @return Client
*
* @throws Exception
*/
public static com.aliyun.dingtalkrooms_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.dingtalkrooms_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomHeaders queryMeetingRoomHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomHeaders();
queryMeetingRoomHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomRequest queryMeetingRoomRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomRequest()
.setUnionId("2iPOLxxxxx");
try {
client.queryMeetingRoomWithOptions("0ffb7xxxxx", queryMeetingRoomRequest, queryMeetingRoomHeaders, 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 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)) {
// The err contains the code and message attributes, which help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
from typing import List
from alibabacloud_dingtalk.rooms_1_0.client import Client as dingtalkrooms_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.rooms_1_0 import models as dingtalkrooms__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() -> dingtalkrooms_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 dingtalkrooms_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
query_meeting_room_headers = dingtalkrooms__1__0_models.QueryMeetingRoomHeaders()
query_meeting_room_headers.x_acs_dingtalk_access_token = '<your access token>'
query_meeting_room_request = dingtalkrooms__1__0_models.QueryMeetingRoomRequest(
union_id='2iPOLxxxxx'
)
try:
client.query_meeting_room_with_options('0ffb7xxxxx', query_meeting_room_request, query_meeting_room_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The 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()
query_meeting_room_headers = dingtalkrooms__1__0_models.QueryMeetingRoomHeaders()
query_meeting_room_headers.x_acs_dingtalk_access_token = '<your access token>'
query_meeting_room_request = dingtalkrooms__1__0_models.QueryMeetingRoomRequest(
union_id='2iPOLxxxxx'
)
try:
await client.query_meeting_room_with_options_async('0ffb7xxxxx', query_meeting_room_request, query_meeting_room_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which help locate 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\Vrooms_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomRequest;
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();
$queryMeetingRoomHeaders = new QueryMeetingRoomHeaders([]);
$queryMeetingRoomHeaders->xAcsDingtalkAccessToken = "<your access token>";
$queryMeetingRoomRequest = new QueryMeetingRoomRequest([
"unionId" => "2iPOLxxxxx"
]);
try {
$client->queryMeetingRoomWithOptions("0ffb7xxxxx", $queryMeetingRoomRequest, $queryMeetingRoomHeaders, 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 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));
// 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"
dingtalkrooms_1_0 "github.com/alibabacloud-go/dingtalk/rooms_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
// Description:
//
// Initialize the account Client with a Token
//
// @return Client
//
// @throws Exception
func CreateClient () (_result *dingtalkrooms_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkrooms_1_0.Client{}
_result, _err = dingtalkrooms_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
queryMeetingRoomHeaders := &dingtalkrooms_1_0.QueryMeetingRoomHeaders{}
queryMeetingRoomHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
queryMeetingRoomRequest := &dingtalkrooms_1_0.QueryMeetingRoomRequest{
UnionId: tea.String("2iPOLxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.QueryMeetingRoomWithOptions(tea.String("0ffb7xxxxx"), queryMeetingRoomRequest, queryMeetingRoomHeaders, &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 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)
}
}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkrooms_1_0 = require('@alicloud/dingtalk/rooms_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');
class Client {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
static createClient() {
let config = new OpenApi.Config({ });
config.protocol = 'https';
config.regionId = 'central';
return new dingtalkrooms_1_0.default(config);
}
static async main(args) {
let client = Client.createClient();
let queryMeetingRoomHeaders = new dingtalkrooms_1_0.QueryMeetingRoomHeaders({ });
queryMeetingRoomHeaders.xAcsDingtalkAccessToken = '<your access token>';
let queryMeetingRoomRequest = new dingtalkrooms_1_0.QueryMeetingRoomRequest({
unionId: '2iPOLxxxxx',
});
try {
await client.queryMeetingRoomWithOptions('0ffb7xxxxx', queryMeetingRoomRequest, queryMeetingRoomHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// The err contains the code and message attributes, which help 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
{
/// <term><b>Description:</b></term>
/// <description>
/// <para>Initialize the account Client with a Token</para>
/// </description>
///
/// <returns>
/// Client
/// </returns>
///
/// <term><b>Exception:</b></term>
/// Exception
public static AlibabaCloud.SDK.Dingtalkrooms_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkrooms_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkrooms_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomHeaders queryMeetingRoomHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomHeaders();
queryMeetingRoomHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomRequest queryMeetingRoomRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomRequest
{
UnionId = "2iPOLxxxxx",
};
try
{
client.QueryMeetingRoomWithOptions("0ffb7xxxxx", queryMeetingRoomRequest, queryMeetingRoomHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The 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))
{
// The err contains the code and message attributes, which help locate the issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| result | Object | Detail ruang rapat. |
| roomId | String | ID ruang rapat. |
| roomStaffId | String | ID karyawan perusahaan untuk ruang rapat. Bidang cadangan. Tidak digunakan. |
| corpId | String | ID organisasi perusahaan pemilik ruang rapat. |
| roomName | String | Nama ruang rapat. |
| roomStatus | Integer | Status ruang rapat: - 0: Tersedia untuk semua pengguna - 1: Hanya tersedia untuk admin - 2: Tersedia untuk pengguna tertentu |
| roomLabels | Array | Daftar tag ruang rapat. |
| labelId | Long | ID tag: - 1: TV - 2: Telepon - 3: Proyektor - 4: Whiteboard - 5: Rapat Video |
| labelName | String | Nama tag. |
| roomCapacity | Integer | Kapasitas ruang rapat. |
| roomLocation | Object | Informasi lokasi ruang rapat. |
| title | String | Nama lokasi ruang rapat. |
| desc | String | Informasi detail lokasi ruang rapat. |
| roomPicture | String | Gambar ruang rapat. |
| isvRoomId | String | ID ruang rapat eksternal milik pemanggil. |
| roomGroup | Object | Informasi grup ruang rapat. |
| groupId | Long | ID grup. |
| groupName | String | Nama grup. |
| parentId | Long | ID grup induk. |
| deviceUnionIds | Array of String | Daftar unionId. |
| reservationAuthority | Object | Izin pemesanan yang dikonfigurasi untuk ruang rapat ketika roomStatus disetel ke izin parsial. |
| authorizedMembers | Array | Daftar pengguna yang memiliki izin. |
| memberId | String | ID pengguna. Disetel berdasarkan memberType: User: unionId pengguna. Panggil API Menanyakan detail pengguna untuk memperolehnya. Department: ID departemen, dept_id. Panggil API Memperoleh daftar departemen untuk memperolehnya. |
| memberType | String | Tipe pengguna: - User: user - Department: dept |
| memberName | String | Nama pengguna: - User: nama pengguna - Department: nama departemen |
| enableCycleReservation | Boolean | Apakah ruang rapat mendukung pemesanan berulang: - true: Ya - false: Tidak |
| roomUnionId | String | unionId ruang rapat. |
| extensionConfig | Object | Konfigurasi tambahan untuk ruang rapat. |
| openReservation | Boolean | Apakah ruang rapat terbuka untuk pemesanan: - true: Ya - false: Tidak |
| maxReservationTimeInterval | Integer | Durasi maksimum satu pemesanan, dalam menit. Nilai 0 menunjukkan tanpa batas. |
| minReservationTimeInterval | Integer | Durasi minimum satu pemesanan, dalam menit. |
| advanceReservation | Object | Waktu pemesanan di muka paling awal. |
| advanceReservationTime | Integer | Nilai spesifik dari waktu pemesanan di muka. Satuannya ditentukan oleh bidang advanceReservationTimeUnit. |
| advanceReservationTimeUnit | String | Satuan waktu: - days: Hari - weeks: Minggu - months: Bulan - years: Tahun |
| advanceBookTimeFormat | String | Jam spesifik. |
| reservationCloseDetail | Object | Detail penutupan pemesanan. |
| taskStartTime | Long | Waktu mulai penutupan pemesanan. Stempel waktu dalam milidetik. |
| taskEndTime | Long | Waktu berakhir penutupan pemesanan. Stempel waktu dalam milidetik. Nilai kosong menunjukkan penutupan permanen. |
| closeReason | String | Alasan penutupan pemesanan. |
| contactUnionId | String | unionId kontak. |
| contactNick | String | Nama kontak. |
| sendNotify | Boolean | Apakah akan mengirim notifikasi kepada karyawan yang telah memesan ruang rapat. |
| approvalSwitch | Boolean | Apakah tombol persetujuan aktif: - true: Aktif - false: Nonaktif |
| approvalType | Integer | Tipe persetujuan: - 1: Persetujuan standar - 2: Persetujuan kustom |
| roomDescription | String | Deskripsi ruang rapat. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : {
"roomId" : "0ffb7184xxxxx",
"roomStaffId" : "0122414",
"corpId" : "ding994axxxxx",
"roomName" : "Ruang rapat uji",
"roomStatus" : 0,
"roomLabels" : [ {
"labelId" : 1,
"labelName" : "TV"
} ],
"roomCapacity" : 10,
"roomLocation" : {
"title" : "Perusahaan xxx",
"desc" : "No. xx, Jalan xx, Distrik xx, Kota xx"
},
"roomPicture" : "https://static.dingtalk.io/media/lADxxxxx.jpg",
"isvRoomId" : "xxxIsvRoomId",
"roomGroup" : {
"groupId" : 1,
"groupName" : "Grup uji",
"parentId" : 0
},
"deviceUnionIds" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
"reservationAuthority" : {
"authorizedMembers" : [ {
"memberId" : "lPHhSZDLXXXXXXpBlC9lxLwiEiE",
"memberType" : "user",
"memberName" : "Budi Santoso"
} ]
},
"enableCycleReservation" : false,
"roomUnionId" : "DtB8VDzXXXXXX41rgiE",
"extensionConfig" : {
"openReservation" : true,
"maxReservationTimeInterval" : 60,
"minReservationTimeInterval" : 15,
"advanceReservation" : {
"advanceReservationTime" : 3,
"advanceReservationTimeUnit" : "days",
"advanceBookTimeFormat" : "09:00"
},
"reservationCloseDetail" : {
"taskStartTime" : 1740463800000,
"taskEndTime" : 1740045030000,
"closeReason" : "Pemesanan ditutup sementara karena renovasi",
"contactUnionId" : "2iPOLbpxxxxuwggiiqiPwiEiF",
"contactNick" : "nick",
"sendNotify" : true
},
"approvalSwitch" : false,
"approvalType" : 1
},
"roomDescription" : "Tambahkan deskripsi ruang rapat di sini"
}
}
Kode error
Jika terjadi error saat memanggil API ini, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | param.error | Param Error | Error parameter yang hilang |
| 400 | org.not.found | Org Not Found | Organisasi tidak ditemukan |
| 500 | system.error | System Error | Error sistem |