Query meeting information by meeting code

Call this API to query meeting information by the meeting roomCode and pagination parameters.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/conference/roomCodes/{roomCode}/infos`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-VideoConference.Conference.Read-Read permission for Video Meeting information

Request headers

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 an authorized organization for a third-party app API.

Path parameters

Name	Type	Required	Description
roomCode	String	Yes	The meeting code.

Query parameters

Name	Type	Required	Description
nextToken	String	No	The pagination cursor.
maxResults	Integer	No	The page size.

Request example

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>Initialize the account Client using a Token</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 contains the code and message attributes, which help developers 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)) {
                // err contains the code and message attributes, which help developers locate the issue
            }

        }        
    }
}

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:
        """
        Initialize the account Client using a Token
        @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 contains the code and message attributes, which help developers locate the issue
                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 contains the code and message attributes, which help developers locate the issue
                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 {

    /**
     * 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();
        $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 contains the code and message attributes, which help developers 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"
  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:
// 
// Initialize the account Client using a Token
// 
// @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 contains the code and message attributes, which help developers locate the issue
    }

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

  /**
   * Initialize the account Client using a Token
   * @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 contains the code and message attributes, which help developers 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 using a Token</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 contains the code and message attributes, which help developers 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))
                {
                    // err contains the code and message attributes, which help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
nextToken	String	The pagination cursor.
hasMore	Boolean	Whether more results are available.
totalCount	Integer	The total number of results.
conferenceList	Array	The list of meeting information. If the meeting code corresponds to a Book Meeting or a recurring meeting, the meeting code may correspond to multiple meeting instances.
conferenceId	String	The meeting ID.
title	String	The Title of the meeting.
roomCode	String	The meeting code.
externalLinkUrl	String	The link to join the conference.
status	Integer	The meeting status: - 0: Initialized - 1: Meeting ended - 2: Meeting started
startTime	Long	The meeting start timestamp, in milliseconds.
endTime	Long	The meeting end timestamp, in milliseconds. Returned after the meeting ends.
confDuration	Long	The meeting duration, in milliseconds. Returned after the meeting ends.
creatorId	String	The unionId of the meeting creator.
creatorNick	String	The Name of the meeting creator.
scheduleConferenceId	String	The Book Meeting ID.
bizType	String	The meeting business type: - 0: Instant Video Meeting - 3: Book Meeting - audio_conf: Audio Meeting

Response body example

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

{
  "nextToken" : "10",
  "hasMore" : true,
  "totalCount" : 15,
  "conferenceList" : [ {
    "conferenceId" : "6323dxxxxx",
    "title" : "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" : "John",
    "scheduleConferenceId" : "4331d******",
    "bizType" : "0"
  } ]
}

Error codes

If an error occurs when calling this API, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRoomCode	invalidRoomCode	Invalid meeting code
400	missingRoomCode	missingRoomCode	Missing meeting code
400	paramError	paramError	Parameter error
403	noPermission	noPermission	No permission
500	systemError	systemError	System error

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes