API call description
Before calling this API, subscribe to the Device-room binding change event through event subscription.Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/rooms/devices |
| HTTP Method | GET |
| Supported app types | appType-Internal app |
| Permissions | permission-VideoConference.Conference.Read-Read permission for video conference information |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. To obtain the value, call the Get the access token of an internal app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorUnionId | String | Yes | The unionId of the operator who performs the query. To obtain the value, call the Query user details API. |
| deviceId | String | No | The ID of the device to query. Obtain the value by subscribing to the Device-room binding change event. Specify either deviceId or deviceUnionId. |
| deviceUnionId | String | No | The unionId of the device to query. Obtain the value by subscribing to the Device-room binding change event. Specify either deviceId or deviceUnionId. |
Request example
HTTPGET /v1.0/rooms/devices?operatorUnionId=lmvxxxxx&deviceId=1234&deviceUnionId=lmvUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
// 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.dingtalkrooms_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.dingtalkrooms_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkrooms_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceHeaders queryMeetingRoomDeviceHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceHeaders();
queryMeetingRoomDeviceHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceRequest queryMeetingRoomDeviceRequest = new com.aliyun.dingtalkrooms_1_0.models.QueryMeetingRoomDeviceRequest()
.setOperatorUnionId("lmvxxxxx")
.setDeviceId("1234")
.setDeviceUnionId("lmvUxxxxx");
try {
client.queryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, 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 diagnose 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 diagnose the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
from typing import List
from alibabacloud_dingtalk.rooms_1_0.client import Client as dingtalkrooms_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.rooms_1_0 import models as dingtalkrooms__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() -> dingtalkrooms_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 dingtalkrooms_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
query_meeting_room_device_headers = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceHeaders()
query_meeting_room_device_headers.x_acs_dingtalk_access_token = '<your access token>'
query_meeting_room_device_request = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceRequest(
operator_union_id='lmvxxxxx',
device_id='1234',
device_union_id='lmvUxxxxx'
)
try:
client.query_meeting_room_device_with_options(query_meeting_room_device_request, query_meeting_room_device_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 diagnose the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
query_meeting_room_device_headers = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceHeaders()
query_meeting_room_device_headers.x_acs_dingtalk_access_token = '<your access token>'
query_meeting_room_device_request = dingtalkrooms__1__0_models.QueryMeetingRoomDeviceRequest(
operator_union_id='lmvxxxxx',
device_id='1234',
device_union_id='lmvUxxxxx'
)
try:
await client.query_meeting_room_device_with_options_async(query_meeting_room_device_request, query_meeting_room_device_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 diagnose 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\Vrooms_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomDeviceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\QueryMeetingRoomDeviceRequest;
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();
$queryMeetingRoomDeviceHeaders = new QueryMeetingRoomDeviceHeaders([]);
$queryMeetingRoomDeviceHeaders->xAcsDingtalkAccessToken = "<your access token>";
$queryMeetingRoomDeviceRequest = new QueryMeetingRoomDeviceRequest([
"operatorUnionId" => "lmvxxxxx",
"deviceId" => "1234",
"deviceUnionId" => "lmvUxxxxx"
]);
try {
$client->queryMeetingRoomDeviceWithOptions($queryMeetingRoomDeviceRequest, $queryMeetingRoomDeviceHeaders, 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 diagnose 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"
dingtalkrooms_1_0 "github.com/alibabacloud-go/dingtalk/rooms_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 *dingtalkrooms_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkrooms_1_0.Client{}
_result, _err = dingtalkrooms_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
queryMeetingRoomDeviceHeaders := &dingtalkrooms_1_0.QueryMeetingRoomDeviceHeaders{}
queryMeetingRoomDeviceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
queryMeetingRoomDeviceRequest := &dingtalkrooms_1_0.QueryMeetingRoomDeviceRequest{
OperatorUnionId: tea.String("lmvxxxxx"),
DeviceId: tea.String("1234"),
DeviceUnionId: tea.String("lmvUxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.QueryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, &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 diagnose 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 dingtalkrooms_1_0, * as $dingtalkrooms_1_0 from '@alicloud/dingtalk/rooms_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(): dingtalkrooms_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkrooms_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let queryMeetingRoomDeviceHeaders = new $dingtalkrooms_1_0.QueryMeetingRoomDeviceHeaders({ });
queryMeetingRoomDeviceHeaders.xAcsDingtalkAccessToken = "<your access token>";
let queryMeetingRoomDeviceRequest = new $dingtalkrooms_1_0.QueryMeetingRoomDeviceRequest({
operatorUnionId: "lmvxxxxx",
deviceId: "1234",
deviceUnionId: "lmvUxxxxx",
});
try {
await client.queryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message properties to help diagnose 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.Dingtalkrooms_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkrooms_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkrooms_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceHeaders queryMeetingRoomDeviceHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceHeaders();
queryMeetingRoomDeviceHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceRequest queryMeetingRoomDeviceRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryMeetingRoomDeviceRequest
{
OperatorUnionId = "lmvxxxxx",
DeviceId = "1234",
DeviceUnionId = "lmvUxxxxx",
};
try
{
client.QueryMeetingRoomDeviceWithOptions(queryMeetingRoomDeviceRequest, queryMeetingRoomDeviceHeaders, 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 diagnose 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 diagnose the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| result | Object | The response result. |
| deviceId | String | The device ID. |
| deviceUnionId | String | The device unionId. |
| openRoomId | String | The ID of the room bound to the device. |
| corpId | String | The organization ID. |
| deviceName | String | The device name. |
| shareCode | String | The cast code of the device. |
| deviceSn | String | The serial number of the device. |
| deviceMac | String | The MAC address of the device. |
| deviceType | String | The device type. - touyingyi: Video Meeting device - meetingaccessory: Device controller |
| deviceServiceId | Integer | The service ID assigned when the device was registered. |
| deviceModel | String | The device model. |
| deviceStatus | String | The device status. - idle: Free - projection: Casting - conf_incoming: Meeting ringing - conf_running: In Meeting - white_board: Using Whiteboard - offline: Offline |
| controllers | Array | The list of device controllers. |
| deviceId | String | The controller device ID. |
| deviceUnionId | String | The unionId of the device controller. |
| openRoomId | String | The ID of the room bound to the device controller. |
| corpId | String | The organization ID. |
| shareCode | String | The cast code of the device controller. |
| deviceSn | String | The serial number of the device controller. |
| deviceType | String | The device type: - touyingyi: Video Meeting device - meetingaccessory: Device controller |
| deviceServiceId | Integer | The service ID assigned when the device controller was registered. |
| deviceModel | String | The model of the device controller. |
| deviceName | String | The name of the device controller. |
| deviceStatus | String | The status of the device controller. - idle: Free - projection: Casting - conf_incoming: Meeting ringing - conf_running: In Meeting - white_board: Using Whiteboard - offline: Offline |
| deviceMac | String | The MAC address of the device controller. |
| creatorUnionId | String | The operator who created the device. |
| roomName | String | The name of the room to which the device belongs. |
| firmwareVersion | String | The firmware version of the device. |
| softwareVersion | String | The software version of the device. |
| activeTime | Long | The activation time of the device. |
| devNetType | String | The network type of the device. |
| devNetIp | String | The IP address of the device. |
| devWifiMac | String | The wireless MAC address of the device. |
| devWireMac | String | The wired MAC address of the device. |
| devCamera | String | The camera model. |
| devMic | String | The microphone model. |
| devVoice | String | The speaker model. |
| devMirror | String | The mirroring status. |
| devHdmi | String | The HDMI output status. |
| sipAccountName | String | The SIP account. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : {
"deviceId" : "1234",
"deviceUnionId" : "lmvUxxxxx",
"openRoomId" : "7263xxxxx",
"corpId" : "ding99xxxxx",
"deviceName" : "DingTalk Meeting Device_xxxx",
"shareCode" : "123456",
"deviceSn" : "02caxxxxx",
"deviceMac" : "14:85:7f:xx:xx:xx",
"deviceType" : "touyingyi",
"deviceServiceId" : 1204,
"deviceModel" : "winbox",
"deviceStatus" : "offline",
"controllers" : [ {
"deviceId" : "2345",
"deviceUnionId" : "lmvUxxxxx",
"openRoomId" : "7263xxxxx",
"corpId" : "ding99xxxxx",
"shareCode" : "234567",
"deviceSn" : "02caxxxxx",
"deviceType" : "touyingyi",
"deviceServiceId" : 1190,
"deviceModel" : "AILABS_S3_T1",
"deviceName" : "Meeting Control Tablet_xxxx",
"deviceStatus" : "white_board",
"deviceMac" : "d8:2f:e6:xx:xx:xx"
} ],
"creatorUnionId" : "lPHhSZDLXXXXXXpBlC9lxLwiEiE",
"roomName" : "Test Meeting Room",
"firmwareVersion" : "LMVXXX.20XX0818",
"softwareVersion" : "7.14.1",
"activeTime" : 1697198045000,
"devNetType" : "net_wired",
"devNetIp" : "127.0.0.10",
"devWifiMac" : "d4:aa:ee:e8:4d:55",
"devWireMac" : "d4:3a:ee:aa:45:85",
"devCamera" : "Smart Camera",
"devMic" : "Microphone (2- Built-in Audio)",
"devVoice" : "Speaker (2- Built-in Audio)",
"devMirror" : "false",
"devHdmi" : "false",
"sipAccountName" : "sip13492"
}
}
Error codes
If an error occurs when calling this API, look up the solution by the error message in the Global error codes document.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | device.not.found | device not found | The device does not exist. |
| 400 | param.error | param error | The operatorUnionId parameter is empty. |
| 403 | no.permission | no permission | No query permission. |
| 500 | system.error | system error | System error. |