Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/rooms/meetingRoomLists |
| 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 untuk memanggil API ini. Dapatkan sebagai berikut: - Untuk aplikasi internal, panggil API Dapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Dapatkan access token organisasi yang diberi otorisasi kepada aplikasi pihak ketiga. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| nextToken | Long | Tidak | Cursor paginasi. - Kosongkan parameter ini untuk panggilan pertama. - Untuk panggilan berikutnya, teruskan nextToken yang dikembalikan oleh panggilan sebelumnya. |
| maxResults | Integer | Tidak | Ukuran halaman. Default: 20. Maksimum: 100. |
| unionId | String | Ya | unionId dari operator. Dapatkan dengan memanggil API Kueri detail pengguna. |
Contoh permintaan
HTTPGET /v1.0/rooms/meetingRoomLists?nextToken=124&maxResults=20&unionId=2iPOxxxxx 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 {
/**
* Initialize the account client with a Token
* @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 {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListHeaders queryMeetingRoomListHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListHeaders();
queryMeetingRoomListHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListRequest queryMeetingRoomListRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomListRequest()
.setNextToken(124L)
.setMaxResults(20)
.setUnionId("2iPOxxxxx");
try {
client.queryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, 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 properti code dan message, yang 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 properti code dan message, yang 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.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_list_headers = dingtalkrooms__1__0_models.QueryMeetingRoomListHeaders()
query_meeting_room_list_headers.x_acs_dingtalk_access_token = '<your access token>'
query_meeting_room_list_request = dingtalkrooms__1__0_models.QueryMeetingRoomListRequest(
next_token=124,
max_results=20,
union_id='2iPOxxxxx'
)
try:
client.query_meeting_room_list_with_options(query_meeting_room_list_request, query_meeting_room_list_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi properti code dan message, yang membantu menemukan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
query_meeting_room_list_headers = dingtalkrooms__1__0_models.QueryMeetingRoomListHeaders()
query_meeting_room_list_headers.x_acs_dingtalk_access_token = '<your access token>'
query_meeting_room_list_request = dingtalkrooms__1__0_models.QueryMeetingRoomListRequest(
next_token=124,
max_results=20,
union_id='2iPOxxxxx'
)
try:
await client.query_meeting_room_list_with_options_async(query_meeting_room_list_request, query_meeting_room_list_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi properti code dan message, yang 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\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\QueryMeetingRoomListHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomListRequest;
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();
$queryMeetingRoomListHeaders = new QueryMeetingRoomListHeaders([]);
$queryMeetingRoomListHeaders->xAcsDingtalkAccessToken = "<your access token>";
$queryMeetingRoomListRequest = new QueryMeetingRoomListRequest([
"nextToken" => 124,
"maxResults" => 20,
"unionId" => "2iPOxxxxx"
]);
try {
$client->queryMeetingRoomListWithOptions($queryMeetingRoomListRequest, $queryMeetingRoomListHeaders, 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 properti code dan message, yang 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"
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"
)
/**
* 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
}
queryMeetingRoomListHeaders := &dingtalkrooms_1_0.QueryMeetingRoomListHeaders{}
queryMeetingRoomListHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
queryMeetingRoomListRequest := &dingtalkrooms_1_0.QueryMeetingRoomListRequest{
NextToken: tea.Int64(124),
MaxResults: tea.Int32(20),
UnionId: tea.String("2iPOxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.QueryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, &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 properti code dan message, yang 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 dingtalkrooms_1_0, * as $dingtalkrooms_1_0 from '@alicloud/dingtalk/rooms_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(): dingtalkrooms_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkrooms_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let queryMeetingRoomListHeaders = new $dingtalkrooms_1_0.QueryMeetingRoomListHeaders({ });
queryMeetingRoomListHeaders.xAcsDingtalkAccessToken = "<your access token>";
let queryMeetingRoomListRequest = new $dingtalkrooms_1_0.QueryMeetingRoomListRequest({
nextToken: 124,
maxResults: 20,
unionId: "2iPOxxxxx",
});
try {
await client.queryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi properti code dan message, yang 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.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.QueryMeetingRoomListHeaders queryMeetingRoomListHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListHeaders();
queryMeetingRoomListHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListRequest queryMeetingRoomListRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomListRequest
{
NextToken = 124,
MaxResults = 20,
UnionId = "2iPOxxxxx",
};
try
{
client.QueryMeetingRoomListWithOptions(queryMeetingRoomListRequest, queryMeetingRoomListHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi properti code dan message, yang 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 properti code dan message, yang membantu menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| hasMore | Boolean | Apakah tersedia hasil lebih lanjut. - true: Ya - false: Tidak |
| nextToken | Long | Cursor paginasi. |
| result | Array | Daftar ruang. |
| roomId | String | ID ruang. |
| roomStaffId | String | ID karyawan dari ruang di dalam organisasi. Bidang cadangan. Saat ini tidak digunakan. |
| corpId | String | ID organisasi (CorpId) tempat ruang tersebut berada. |
| roomName | String | Nama ruang. |
| roomStatus | Integer | Status ruang. - 0: Terlihat oleh semua anggota - 1: Terlihat hanya oleh admin - 2: Terlihat oleh pengguna yang dipilih |
| roomLabels | Array | Daftar tag ruang. |
| labelId | Long | ID tag. - 1: TV - 2: Telepon - 3: Proyektor - 4: Whiteboard - 5: Rapat Video |
| labelName | String | Nama tag. |
| roomCapacity | Integer | Kapasitas ruang. |
| roomLocation | Object | Lokasi ruang. |
| title | String | Nama lokasi ruang. |
| desc | String | Informasi lokasi terperinci dari ruang. |
| roomPicture | String | Gambar ruang. |
| isvRoomId | String | ID ruang eksternal dari pemanggil. |
| roomGroup | Object | Informasi grup ruang. |
| groupId | Long | ID grup. |
| groupName | String | Nama grup. |
| parentId | Long | ID grup induk. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"hasMore" : true,
"nextToken" : 123,
"result" : [ {
"roomId" : "0ffb7xxxxx",
"roomStaffId" : "012241xxxxx",
"corpId" : "ding994axxxx",
"roomName" : "Ruang 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/lADPxxxxx.jpg",
"isvRoomId" : "xxxIsvRoomId",
"roomGroup" : {
"groupId" : 1,
"groupName" : "Grup uji",
"parentId" : 0
}
} ]
}
Kode error
Jika terjadi error saat memanggil API ini, lihat dokumen Kode error global untuk solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | param.error | Param Error | Error parameter tidak ada |
| 400 | user.not.employee | User Not Employee | Pengguna tidak berada dalam organisasi |
| 400 | org.not.found | Org Not Found | Organisasi tidak ditemukan |
| 500 | system.error | System Error | Error sistem |