Query video conference members - DingTalk Help Center

Call this API to query video conference members by page.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/conference/videoConferences/{conferenceId}/members`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-VideoConference.Conference.Read-Video conference read permission

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API. - For an internal app, call the Get the access token of an internal app API to obtain it. - For a third-party enterprise app, call the API for obtaining the access token of the organization that authorized the third-party app.

Path parameters

Name	Type	Required	Description
conferenceId	String	Yes	The conferenceId of the meeting. You can obtain it by calling the Create a video conference API.

Query parameters

Name	Type	Required	Description
nextToken	String	No	The pagination cursor. - If you call this API for the first time, leave this parameter empty or set it to 0. - For subsequent calls, set this parameter to the nextToken returned by the previous call.
maxResults	Integer	No	The maximum number of entries per page. Default value: 128. No upper limit.

Request example

HTTP

GET /v1.0/conference/videoConferences/6323dxxxxx/members?nextToken=0&maxResults=20 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
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 {

    /**
     * Initialize the account client using the Token
     * @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.QueryConferenceMembersHeaders queryConferenceMembersHeaders = new com.aliyun.dingtalkconference_1_0.models.QueryConferenceMembersHeaders();
        queryConferenceMembersHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.QueryConferenceMembersRequest queryConferenceMembersRequest = new com.aliyun.dingtalkconference_1_0.models.QueryConferenceMembersRequest()
                .setNextToken("0")
                .setMaxResults(20);
        try {
            client.queryConferenceMembersWithOptions("6323dxxxxx", queryConferenceMembersRequest, queryConferenceMembersHeaders, 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 code and message properties to 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 properties to help locate the issue
            }

        }        
    }
}

Python

# -*- 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 using the 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_members_headers = dingtalkconference__1__0_models.QueryConferenceMembersHeaders()
        query_conference_members_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_conference_members_request = dingtalkconference__1__0_models.QueryConferenceMembersRequest(
            next_token='0',
            max_results=20
        )
        try:
            client.query_conference_members_with_options('6323dxxxxx', query_conference_members_request, query_conference_members_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 properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_conference_members_headers = dingtalkconference__1__0_models.QueryConferenceMembersHeaders()
        query_conference_members_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_conference_members_request = dingtalkconference__1__0_models.QueryConferenceMembersRequest(
            next_token='0',
            max_results=20
        )
        try:
            await client.query_conference_members_with_options_async('6323dxxxxx', query_conference_members_request, query_conference_members_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 properties to help 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\QueryConferenceMembersHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryConferenceMembersRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account client using the 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();
        $queryConferenceMembersHeaders = new QueryConferenceMembersHeaders([]);
        $queryConferenceMembersHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryConferenceMembersRequest = new QueryConferenceMembersRequest([
            "nextToken" => "0",
            "maxResults" => 20
        ]);
        try {
            $client->queryConferenceMembersWithOptions("6323dxxxxx", $queryConferenceMembersRequest, $queryConferenceMembersHeaders, 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 properties to 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/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"
)

/**
 * Initialize the account client using the 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
  }

  queryConferenceMembersHeaders := &dingtalkconference_1_0.QueryConferenceMembersHeaders{}
  queryConferenceMembersHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryConferenceMembersRequest := &dingtalkconference_1_0.QueryConferenceMembersRequest{
    NextToken: tea.String("0"),
    MaxResults: tea.Int32(20),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryConferenceMembersWithOptions(tea.String("6323dxxxxx"), queryConferenceMembersRequest, queryConferenceMembersHeaders, &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 properties to help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

// 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 using the 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 queryConferenceMembersHeaders = new $dingtalkconference_1_0.QueryConferenceMembersHeaders({ });
    queryConferenceMembersHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryConferenceMembersRequest = new $dingtalkconference_1_0.QueryConferenceMembersRequest({
      nextToken: "0",
      maxResults: 20,
    });
    try {
      await client.queryConferenceMembersWithOptions("6323dxxxxx", queryConferenceMembersRequest, queryConferenceMembersHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties to 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 using the 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.QueryConferenceMembersHeaders queryConferenceMembersHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceMembersHeaders();
            queryConferenceMembersHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceMembersRequest queryConferenceMembersRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryConferenceMembersRequest
            {
                NextToken = "0",
                MaxResults = 20,
            };
            try
            {
                client.QueryConferenceMembersWithOptions("6323dxxxxx", queryConferenceMembersRequest, queryConferenceMembersHeaders, 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 properties to 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 properties to help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
memberModels	Array	The list of members.
unionId	String	The unionId of the member.
conferenceId	String	The video conference ID.
userNick	String	The name of the member.
joinTime	Long	The timestamp when the member joined the conference, in milliseconds.
leaveTime	Long	The timestamp when the member left the conference, in milliseconds.
duration	Long	The duration in the meeting, in milliseconds.
host	Boolean	Whether the member is the host. - true: Yes - false: No
attendStatus	Integer	The member status. - 1: Initialized - 2: Calling - 3: Active (in the meeting) - 4: Failed to join (call declined, etc.) - 5: Kicked out - 6: Left the meeting
outerOrgMember	Boolean	Whether the member is from outside the organization that owns the meeting. - true: Yes - false: No This field is not returned if the current member belongs to the organization that owns the meeting.
pstnJoin	Boolean	Whether the member joined the meeting by phone number. - true: Yes - false: No
coHost	Boolean	Whether the member is a co-host. - true: Yes - false: No
nextToken	String	The pagination cursor.
totalCount	Integer	The total number of entries.

Response example

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

{
  "memberModels" : [ {
    "unionId" : "2iPOLxxxxx",
    "conferenceId" : "6323dxxxxx",
    "userNick" : "John",
    "joinTime" : 1663293270000,
    "leaveTime" : 1663293280000,
    "duration" : 10000,
    "host" : false,
    "attendStatus" : 6,
    "outerOrgMember" : true,
    "pstnJoin" : false,
    "coHost" : false
  } ],
  "nextToken" : "123000000",
  "totalCount" : 20
}

Error codes

If an error occurs 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	missingRoomId	MISSING ROOM ID	The meeting ID parameter is missing.
400	paramError	PARAM ERROR	Parameter error.
403	noPermission	NO PERMISSION	No permission to query the meeting.
404	roomNotFound	ROOM NOT FOUND	The meeting cannot be found.
500	systemError	SYSTEM ERROR	Internal system error.

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response example

​Error codes