Query the list of ongoing meetings for a user

Query the list of ongoing meetings for a user. Returns the IDs of the ongoing meetings and the user’s member information in each meeting.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/conference/users/lists
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 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 the authorized enterprise API.

Query parameters

Name	Type	Required	Description
unionId	String	Yes	The unionId of the user to query. To obtain it, call the Query user details API.

Request example

HTTP

GET /v1.0/conference/users/lists?unionId=2iPOLbpUNMLzB5LuwggiiqiPwiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:31c73ec295503618b3a03ddf2dcffef7
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 with a 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.QueryUserOnGoingConferenceHeaders queryUserOnGoingConferenceHeaders = new com.aliyun.dingtalkconference_1_0.models.QueryUserOnGoingConferenceHeaders();
        queryUserOnGoingConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconference_1_0.models.QueryUserOnGoingConferenceRequest queryUserOnGoingConferenceRequest = new com.aliyun.dingtalkconference_1_0.models.QueryUserOnGoingConferenceRequest()
                .setUnionId("2iPOLbpUNMLzB5LuwggiiqiPwiEiE");
        try {
            client.queryUserOnGoingConferenceWithOptions(queryUserOnGoingConferenceRequest, queryUserOnGoingConferenceHeaders, 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 you 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 you 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 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_user_on_going_conference_headers = dingtalkconference__1__0_models.QueryUserOnGoingConferenceHeaders()
        query_user_on_going_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_user_on_going_conference_request = dingtalkconference__1__0_models.QueryUserOnGoingConferenceRequest(
            union_id='2iPOLbpUNMLzB5LuwggiiqiPwiEiE'
        )
        try:
            client.query_user_on_going_conference_with_options(query_user_on_going_conference_request, query_user_on_going_conference_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 you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_user_on_going_conference_headers = dingtalkconference__1__0_models.QueryUserOnGoingConferenceHeaders()
        query_user_on_going_conference_headers.x_acs_dingtalk_access_token = '<your access token>'
        query_user_on_going_conference_request = dingtalkconference__1__0_models.QueryUserOnGoingConferenceRequest(
            union_id='2iPOLbpUNMLzB5LuwggiiqiPwiEiE'
        )
        try:
            await client.query_user_on_going_conference_with_options_async(query_user_on_going_conference_request, query_user_on_going_conference_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 you 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\QueryUserOnGoingConferenceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconference_1_0\Models\QueryUserOnGoingConferenceRequest;
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();
        $queryUserOnGoingConferenceHeaders = new QueryUserOnGoingConferenceHeaders([]);
        $queryUserOnGoingConferenceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $queryUserOnGoingConferenceRequest = new QueryUserOnGoingConferenceRequest([
            "unionId" => "2iPOLbpUNMLzB5LuwggiiqiPwiEiE"
        ]);
        try {
            $client->queryUserOnGoingConferenceWithOptions($queryUserOnGoingConferenceRequest, $queryUserOnGoingConferenceHeaders, 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 you 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 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
  }

  queryUserOnGoingConferenceHeaders := &dingtalkconference_1_0.QueryUserOnGoingConferenceHeaders{}
  queryUserOnGoingConferenceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  queryUserOnGoingConferenceRequest := &dingtalkconference_1_0.QueryUserOnGoingConferenceRequest{
    UnionId: tea.String("2iPOLbpUNMLzB5LuwggiiqiPwiEiE"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryUserOnGoingConferenceWithOptions(queryUserOnGoingConferenceRequest, queryUserOnGoingConferenceHeaders, &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 you 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 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 queryUserOnGoingConferenceHeaders = new $dingtalkconference_1_0.QueryUserOnGoingConferenceHeaders({ });
    queryUserOnGoingConferenceHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let queryUserOnGoingConferenceRequest = new $dingtalkconference_1_0.QueryUserOnGoingConferenceRequest({
      unionId: "2iPOLbpUNMLzB5LuwggiiqiPwiEiE",
    });
    try {
      await client.queryUserOnGoingConferenceWithOptions(queryUserOnGoingConferenceRequest, queryUserOnGoingConferenceHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which help you 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.QueryUserOnGoingConferenceHeaders queryUserOnGoingConferenceHeaders = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryUserOnGoingConferenceHeaders();
            queryUserOnGoingConferenceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryUserOnGoingConferenceRequest queryUserOnGoingConferenceRequest = new AlibabaCloud.SDK.Dingtalkconference_1_0.Models.QueryUserOnGoingConferenceRequest
            {
                UnionId = "2iPOLbpUNMLzB5LuwggiiqiPwiEiE",
            };
            try
            {
                client.QueryUserOnGoingConferenceWithOptions(queryUserOnGoingConferenceRequest, queryUserOnGoingConferenceHeaders, 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 you 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 you locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
onGoingConfIdList	Array of String	The meeting IDs.
memberModelMap	`Map<String, Object>`	The mapping of the user’s member information in the meetings.
	Object	The member information.
unionId	String	The unionId of the user.
conferenceId	String	The Video Meeting ID.
userNick	String	The name of the user.
joinTime	Long	The timestamp when the user joined the meeting, in milliseconds.
leaveTime	Long	The timestamp when the user left the meeting, in milliseconds.
duration	Long	The duration in the meeting, in milliseconds.
attendStatus	Integer	The status of the user: - 1: Initialized - 2: Calling - 3: Active (in the meeting) - 4: Failed to join (call rejected, etc.) - 5: Kicked out - 6: Left the meeting
host	Boolean	Indicates whether the user is the host: - true: Yes - false: No
coHost	Boolean	Indicates whether the user is a co-host: - true: Yes - false: No
outerOrgMember	Boolean	Indicates whether the user is outside the organization that owns the meeting: - true: Yes - false: No
pstnJoin	Boolean	Indicates whether the user joined the conference by phone number: - true: Yes - false: No
deviceType	String	The device type used to join the meeting: - Win - Mac - iOS - Android

Response body example

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

{
  "onGoingConfIdList" : [ "654058f2411fe90147e68780" ],
  "memberModelMap" : {
    "key" : {
      "unionId" : "2iPOLbpUNMLzB5LuwggiiqiPwiEiE",
      "conferenceId" : "654058f2411fe90147e68780",
      "userNick" : "Test Name",
      "joinTime" : 1699347295876,
      "leaveTime" : 1699347395876,
      "duration" : 100000,
      "host" : false,
      "coHost" : false,
      "outerOrgMember" : false,
      "pstnJoin" : false,
      "deviceType" : "Win"
    }
  }
}

Error codes

If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	param.error	param.error	The unionId of the queried user is invalid.
400	param.error	missing.user.info	The queried user is missing.
500	system.error	system.error	System error.

​Request

​Basic information

​Request header

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes