API call description
Currently, only meetings in progress can be queried.Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/conference/videoConferences/query |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-VideoConference.Conference.Read-Read permission for video meeting information |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling 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 enterprise authorized to a third-party app API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| conferenceIdList | Array of String | Yes | The list of meeting IDs. |
Request example
HTTPPOST /v1.0/conference/videoConferences/query HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:e1377bxxx
Content-Type:application/json
{
"conferenceIdList" : [ "607452e0xxxxxxxxe39609e1" ]
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkconference_1_0.*;
import com.aliyun.dingtalkconference_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkconference_1_0.Client createClient() throws Exception {
Config config = new 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();
QueryConferenceInfoBatchHeaders queryConferenceInfoBatchHeaders = new QueryConferenceInfoBatchHeaders();
queryConferenceInfoBatchHeaders.xAcsDingtalkAccessToken = "<your access token>";
QueryConferenceInfoBatchRequest queryConferenceInfoBatchRequest = new QueryConferenceInfoBatchRequest()
.setConferenceIdList(java.util.Arrays.asList(
"607452e0xxxxxxxxe39609e1"
));
try {
client.queryConferenceInfoBatchWithOptions(queryConferenceInfoBatchRequest, queryConferenceInfoBatchHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains code and message attributes that 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)) {
// err contains code and message attributes that help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
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 with 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_batch_headers = dingtalkconference__1__0_models.QueryConferenceInfoBatchHeaders()
query_conference_info_batch_headers.x_acs_dingtalk_access_token = '<your access token>'
query_conference_info_batch_request = dingtalkconference__1__0_models.QueryConferenceInfoBatchRequest(
conference_id_list=[
'607452e0xxxxxxxxe39609e1'
]
)
try:
client.query_conference_info_batch_with_options(query_conference_info_batch_request, query_conference_info_batch_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
query_conference_info_batch_headers = dingtalkconference__1__0_models.QueryConferenceInfoBatchHeaders()
query_conference_info_batch_headers.x_acs_dingtalk_access_token = '<your access token>'
query_conference_info_batch_request = dingtalkconference__1__0_models.QueryConferenceInfoBatchRequest(
conference_id_list=[
'607452e0xxxxxxxxe39609e1'
]
)
try:
await client.query_conference_info_batch_with_options_async(query_conference_info_batch_request, query_conference_info_batch_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that 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\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\QueryConferenceInfoBatchHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryConferenceInfoBatchRequest;
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();
$queryConferenceInfoBatchHeaders = new QueryConferenceInfoBatchHeaders([]);
$queryConferenceInfoBatchHeaders->xAcsDingtalkAccessToken = "<your access token>";
$queryConferenceInfoBatchRequest = new QueryConferenceInfoBatchRequest([
"conferenceIdList" => [
"607452e0xxxxxxxxe39609e1"
]
]);
try {
$client->queryConferenceInfoBatchWithOptions($queryConferenceInfoBatchRequest, $queryConferenceInfoBatchHeaders, 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 code and message attributes that 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 (
"os"
util "github.com/alibabacloud-go/tea-utils/service"
dingtalkconference_1_0 ""github.com/alibabacloud-go/dingtalk/conference_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client with 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
}
queryConferenceInfoBatchHeaders := &dingtalkconference_1_0.QueryConferenceInfoBatchHeaders{}
queryConferenceInfoBatchHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
queryConferenceInfoBatchRequest := &dingtalkconference_1_0.QueryConferenceInfoBatchRequest{
ConferenceIdList: []*string{tea.String("607452e0xxxxxxxxe39609e1")},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.QueryConferenceInfoBatchWithOptions(queryConferenceInfoBatchRequest, queryConferenceInfoBatchHeaders, &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 code and message attributes that help locate the issue
}
}
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 dingtalkconference_1_0, * as $dingtalkconference_1_0 from '"@alicloud/dingtalk/conference_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(): dingtalkconference_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkconference_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let queryConferenceInfoBatchHeaders = new $dingtalkconference_1_0.QueryConferenceInfoBatchHeaders({ });
queryConferenceInfoBatchHeaders.xAcsDingtalkAccessToken = "<your access token>";
let queryConferenceInfoBatchRequest = new $dingtalkconference_1_0.QueryConferenceInfoBatchRequest({
conferenceIdList: [
"607452e0xxxxxxxxe39609e1"
],
});
try {
await client.queryConferenceInfoBatchWithOptions(queryConferenceInfoBatchRequest, queryConferenceInfoBatchHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message attributes that help locate the issue
}
}
}
}
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.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.QueryConferenceInfoBatchHeaders queryConferenceInfoBatchHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoBatchHeaders();
queryConferenceInfoBatchHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoBatchRequest queryConferenceInfoBatchRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceInfoBatchRequest
{
ConferenceIdList = new List<string>
{
"607452e0xxxxxxxxe39609e1"
},
};
try
{
client.QueryConferenceInfoBatchWithOptions(queryConferenceInfoBatchRequest, queryConferenceInfoBatchHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes that 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))
{
// err contains code and message attributes that help locate the issue
}
}
}
}
}
// This file is auto-generated, don't edit it. Thanks.
#include <alibabacloud/dingtalkconference__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>
#include <vector>
using namespace std;
Alibabacloud_Dingtalkconference_1_0::Client createClient() {
shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
config->protocol = make_shared<string>("https");
config->regionId = make_shared<string>("central");
return Alibabacloud_Dingtalkconference_1_0::Client(config);
}
int main(int argc, char *args[]) {
args;
shared_ptr<Alibabacloud_Dingtalkconference_1_0::Client> client = make_shared<Alibabacloud_Dingtalkconference_1_0::Client>(createClient());
shared_ptr<Alibabacloud_Dingtalkconference_1_0::QueryConferenceInfoBatchHeaders> queryConferenceInfoBatchHeaders = make_shared<Alibabacloud_Dingtalkconference_1_0::QueryConferenceInfoBatchHeaders>();
queryConferenceInfoBatchHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
shared_ptr<Alibabacloud_Dingtalkconference_1_0::QueryConferenceInfoBatchRequest> queryConferenceInfoBatchRequest = make_shared<Alibabacloud_Dingtalkconference_1_0::QueryConferenceInfoBatchRequest>(map<string, boost::any>({
{"conferenceIdList", boost::any(vector<string>({
"607452e0xxxxxxxxe39609e1"
}))}
}));
try {
client->queryConferenceInfoBatchWithOptions(queryConferenceInfoBatchRequest, queryConferenceInfoBatchHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
}
catch (std::exception &err) {
if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
// err contains code and message attributes that help locate the issue
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| infos | Array | The list of meeting details. |
| conferenceId | String | The ID of the real-time meeting. |
| title | String | The meeting name. |
| startTime | Long | The meeting start time. |
| status | Long | The meeting status. - 0: Initialized - 1: Meeting ended - 2: Meeting started |
| mediaStatus | Long | The media status. - 0: Normal - 1: Microphone muted - 2: Camera closed - 4: Mute all enforced |
| userList | Array | The list of meeting users. |
| userId | String | The user ID. |
| nick | String | The user name. |
| attendStatus | Long | The attendance status. - 0: Undefined - 1: Initialized - 2: Joining - 3: In meeting - 4: Join failed - 5: Kicked out - 6: Left |
| cameraStatus | Long | The camera status. - 0: Initialized - 1: Closed - 2: Open |
| micStatus | Long | The microphone status. - 0: Initialized - 1: Closed - 2: Open |
| rejectDescription | String | The reason for declining. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"infos" : [ {
"conferenceId" : "607452e0xxx",
"title" : "Sample meeting",
"status" : 2,
"mediaStatus" : 0,
"userList" : [ {
"userId" : "27SaQ3iiHLN0uwqcPisedfreNwiEiE",
"nick" : "Ding Sanduo",
"attendStatus" : 3,
"cameraStatus" : 2,
"micStatus" : 2,
"rejectDescription" : "Sorry, I am in a meeting."
} ]
} ]
}
Error codes
If an error is returned when calling this API, refer to the Global error codes document to find a solution based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | orgAccessForbidden | orgAccessForbidden | Organization access restricted |
| 400 | unknownUserError | unknownUserError | Unrecognized user |
| 400 | paramsTitleError | error:%s | Invalid meeting title |
| 400 | paramsError | error:%s | Parameter error |
| 400 | resourceClose | The meeting has ended | The meeting has been closed |
| 404 | waterLimitError | waterLimitError:%s | User count rate limit reached |
| 404 | permissionError | permissionError:%s | Group permission restriction |
| 500 | systemError | systemError:%s | System error |