会議番号で会議情報を照会

本 API を呼び出して、会議の roomCode とページネーションパラメータに基づき会議情報を照会します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/conference/roomCodes/{roomCode}/infos`
HTTP Method	GET
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要権限	permission-VideoConference.Conference.Read-ビデオ会議情報の読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本 API を呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合、社内アプリの accessToken を取得 API を呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが権限付与された企業の accessToken を取得 API を呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
roomCode	String	はい	会議コード。

クエリパラメータ

名前	タイプ	必須	説明
nextToken	String	いいえ	ページネーションカーソル。
maxResults	Integer	いいえ	ページサイズ。

リクエスト例

HTTP

GET /v1.0/conference/roomCodes/4272xxxxx/infos?nextToken=0&maxResults=10 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:1803b054eb783eb6a4030369xxx10476
Content-Type:application/json

Java

// 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>Token を使用してアカウント Client を初期化</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 {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkconference_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkconference_1_0.models.QueryConferenceInfoByRoomCodeHeaders queryConferenceInfoByRoomCodeHeaders = new com.aliyun.dingtalkconference_1_0.models.QueryConferenceInfoByRoomCodeHeaders();
        queryConferenceInfoByRoomCodeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.QueryConferenceInfoByRoomCodeRequest queryConferenceInfoByRoomCodeRequest = new com.aliyun.dingtalkconference_1_0.models.QueryConferenceInfoByRoomCodeRequest()
                .setNextToken("0")
                .setMaxResults(10);
        try {
            client.queryConferenceInfoByRoomCodeWithOptions("4272xxxxx", queryConferenceInfoByRoomCodeRequest, queryConferenceInfoByRoomCodeHeaders, 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 には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
            }

        } 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 には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
            }

        }        
    }
}

Python

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

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:
        """
        Token を使用してアカウント Client を初期化
        @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()
        query_conference_info_by_room_code_headers = dingtalkconference__1__0_models.QueryConferenceInfoByRoomCodeHeaders()
        query_conference_info_by_room_code_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_conference_info_by_room_code_request = dingtalkconference__1__0_models.QueryConferenceInfoByRoomCodeRequest(
            next_token='0',
            max_results=10
        )
        try:
            client.query_conference_info_by_room_code_with_options('4272xxxxx', query_conference_info_by_room_code_request, query_conference_info_by_room_code_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_conference_info_by_room_code_headers = dingtalkconference__1__0_models.QueryConferenceInfoByRoomCodeHeaders()
        query_conference_info_by_room_code_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_conference_info_by_room_code_request = dingtalkconference__1__0_models.QueryConferenceInfoByRoomCodeRequest(
            next_token='0',
            max_results=10
        )
        try:
            await client.query_conference_info_by_room_code_with_options_async('4272xxxxx', query_conference_info_by_room_code_request, query_conference_info_by_room_code_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
                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\QueryConferenceInfoByRoomCodeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryConferenceInfoByRoomCodeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント Client を初期化
     * @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();
        $queryConferenceInfoByRoomCodeHeaders = new QueryConferenceInfoByRoomCodeHeaders([]);
        $queryConferenceInfoByRoomCodeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryConferenceInfoByRoomCodeRequest = new QueryConferenceInfoByRoomCodeRequest([
            "nextToken" => "0",
            "maxResults" => 10
        ]);
        try {
            $client->queryConferenceInfoByRoomCodeWithOptions("4272xxxxx", $queryConferenceInfoByRoomCodeRequest, $queryConferenceInfoByRoomCodeHeaders, 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 には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
            }
        }
    }
}
$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"
  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:
// 
// Token を使用してアカウント Client を初期化
// 
// @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
  }

  queryConferenceInfoByRoomCodeHeaders := &dingtalkconference_1_0.QueryConferenceInfoByRoomCodeHeaders{}
  queryConferenceInfoByRoomCodeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryConferenceInfoByRoomCodeRequest := &dingtalkconference_1_0.QueryConferenceInfoByRoomCodeRequest{
    NextToken: tea.String("0"),
    MaxResults: tea.Int32(10),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryConferenceInfoByRoomCodeWithOptions(tea.String("4272xxxxx"), queryConferenceInfoByRoomCodeRequest, queryConferenceInfoByRoomCodeHeaders, &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 には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
    }

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

  /**
   * Token を使用してアカウント Client を初期化
   * @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 queryConferenceInfoByRoomCodeHeaders = new dingtalkconference_1_0.QueryConferenceInfoByRoomCodeHeaders({ });
    queryConferenceInfoByRoomCodeHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let queryConferenceInfoByRoomCodeRequest = new dingtalkconference_1_0.QueryConferenceInfoByRoomCodeRequest({
      nextToken: '0',
      maxResults: 10,
    });
    try {
      await client.queryConferenceInfoByRoomCodeWithOptions('4272xxxxx', queryConferenceInfoByRoomCodeRequest, queryConferenceInfoByRoomCodeHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
      }

    }    
  }

}

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>Token を使用してアカウント Client を初期化</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.QueryConferenceInfoByRoomCodeHeaders queryConferenceInfoByRoomCodeHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoByRoomCodeHeaders();
            queryConferenceInfoByRoomCodeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoByRoomCodeRequest queryConferenceInfoByRoomCodeRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoByRoomCodeRequest
            {
                NextToken = "0",
                MaxResults = 10,
            };
            try
            {
                client.QueryConferenceInfoByRoomCodeWithOptions("4272xxxxx", queryConferenceInfoByRoomCodeRequest, queryConferenceInfoByRoomCodeHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
                }
            }
            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 には code と message 属性が含まれ、開発者が問題を特定するのに役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
nextToken	String	ページネーションカーソル。
hasMore	Boolean	さらにデータがあるかどうか。
totalCount	Integer	結果の総数。
conferenceList	Array	会議情報リスト。会議コードに対応する会議が予約会議または周期会議である場合、会議コードは複数の会議インスタンス情報に対応する可能性があります。
conferenceId	String	会議 ID。
title	String	会議のタイトル。
roomCode	String	会議コード。
externalLinkUrl	String	会議に参加するためのリンク。
status	Integer	会議のステータス： - 0：初期化 - 1：会議終了 - 2：会議開始
startTime	Long	会議の開始タイムスタンプ（ミリ秒単位）。
endTime	Long	会議の終了タイムスタンプ（ミリ秒単位）。会議終了後に当該フィールドが返却されます。
confDuration	Long	会議の継続時間（ミリ秒単位）。会議終了後に当該フィールドが返却されます。
creatorId	String	会議作成者の unionId。
creatorNick	String	会議作成者の名前。
scheduleConferenceId	String	予約会議 ID。
bizType	String	会議の業務タイプ： - 0：即時ビデオ会議 - 3：会議を予約 - audio_conf：ビデオ会議

レスポンスボディ例

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

{
  "nextToken" : "10",
  "hasMore" : true,
  "totalCount" : 15,
  "conferenceList" : [ {
    "conferenceId" : "6323dxxxxx",
    "title" : "見出し",
    "roomCode" : "4272xxxxx",
    "externalLinkUrl" : "https://meeting.dingtalk.io/app?roomCode=42726xxx&token=1_7ac9xxx",
    "status" : 1,
    "startTime" : 1664175001000,
    "endTime" : 1663294270000,
    "confDuration" : 1000000,
    "creatorId" : "2iPOLxxxxx",
    "creatorNick" : "山田太郎",
    "scheduleConferenceId" : "4331d******",
    "bizType" : "0"
  } ]
}

エラーコード

本 API の呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRoomCode	invalidRoomCode	会議コードが無効です
400	missingRoomCode	missingRoomCode	会議コードが欠落しています
400	paramError	paramError	パラメータエラー
403	noPermission	noPermission	権限がありません
500	systemError	systemError	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

会議番号で会議情報を照会

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード