Skip to main content
Call this API to query the custom screen template list directly.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/rooms/devices/screens/templateLists
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Rooms.DeviceTemplate.Read-Read permission for DingTalk Meeting Rooms custom screens

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe API credential. To obtain it, call the Get user token API. When requesting a user token, the code parameter must be obtained through a constructed link whose scope covers both the user ID and the organization ID, that is, scope=openid corpid.

Request example

HTTP
GET /v1.0/rooms/devices/screens/templateLists HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxxxxxx
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.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.QueryDeviceCustomTemplateListHeaders queryDeviceCustomTemplateListHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryDeviceCustomTemplateListHeaders();
        queryDeviceCustomTemplateListHeaders.xAcsDingtalkAccessToken = "<your access token>";
        try {
            client.queryDeviceCustomTemplateListWithOptions(queryDeviceCustomTemplateListHeaders, 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 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
            }

        }        
    }
}
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.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_device_custom_template_list_headers = dingtalkrooms__1__0_models.QueryDeviceCustomTemplateListHeaders()
        query_device_custom_template_list_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            client.query_device_custom_template_list_with_options(query_device_custom_template_list_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_device_custom_template_list_headers = dingtalkrooms__1__0_models.QueryDeviceCustomTemplateListHeaders()
        query_device_custom_template_list_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            await client.query_device_custom_template_list_with_options_async(query_device_custom_template_list_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
<?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\QueryDeviceCustomTemplateListHeaders;
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();
        $queryDeviceCustomTemplateListHeaders = new QueryDeviceCustomTemplateListHeaders([]);
        $queryDeviceCustomTemplateListHeaders->xAcsDingtalkAccessToken = "<your access token>";
        try {
            $client->queryDeviceCustomTemplateListWithOptions($queryDeviceCustomTemplateListHeaders, 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));
Go
// 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
  }

  queryDeviceCustomTemplateListHeaders := &dingtalkrooms_1_0.QueryDeviceCustomTemplateListHeaders{}
  queryDeviceCustomTemplateListHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryDeviceCustomTemplateListWithOptions(queryDeviceCustomTemplateListHeaders, &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)
  }
}
Node.js
// 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 queryDeviceCustomTemplateListHeaders = new $dingtalkrooms_1_0.QueryDeviceCustomTemplateListHeaders({ });
    queryDeviceCustomTemplateListHeaders.xAcsDingtalkAccessToken = "<your access token>";
    try {
      await client.queryDeviceCustomTemplateListWithOptions(queryDeviceCustomTemplateListHeaders, 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));
C#
// 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.QueryDeviceCustomTemplateListHeaders queryDeviceCustomTemplateListHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryDeviceCustomTemplateListHeaders();
            queryDeviceCustomTemplateListHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.QueryDeviceCustomTemplateListWithOptions(queryDeviceCustomTemplateListHeaders, 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
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultObjectThe response result.
deviceCustomTemplatesArrayThe list of template content.
templateIdLongThe template ID.
corpIdStringThe organization ID the template belongs to.
logoStringThe template logo.
orgNameStringThe organization name on the template.
customDocStringThe custom text content of the template.
bgUrlStringThe custom background URL of the template.
bgImageListArray of StringThe image mediaId.
instructionBooleanWhether to display the instructions. Valid values: - true: Display - false: Do not display
bgTypeIntegerThe custom background type of the template. Valid values: - 1: Image - 2: URL
isPicTopIntegerWhether to display the home information bar. Valid values: - 0: Display - 1: Do not display
templateNameStringThe template name.
confTypeIntegerThe template type. Valid values: - 1: Default template - 2: Custom template
showCalendarTitleBooleanWhether to display the event title on the event card. Valid values: - true: Display - false: Do not display
hideServerCodeWhenProjectingBooleanWhether to hide the cast code during casting. Valid values: - true: Hide - false: Do not hide
confSubTypeIntegerThe template subtype. Valid values: - 1: Default subtype
desensitizeUserNameBooleanWhether to mask the organizer name on the event card. Valid values: - true: Mask - false: Do not mask
picturePlayIntervalIntegerThe carousel interval of custom background images, in seconds.
showCalendarCardBooleanWhether to display the event card. Valid values: - true: Display - false: Do not display
showFunctionCardBooleanWhether to display the function card. Valid values: - true: Display - false: Do not display
deviceTemplateMapMap<String, Array of String>The mapping of device unionIds where the template takes effect. The key is the template ID.
Array of StringThe device unionId.
groupIdTemplateMapMap<String, Array of Long>The mapping of group IDs where the template takes effect. The key is the template ID.
Array of LongThe group ID.
roomIdTemplateMapMap<String, Array of String>The mapping of Room IDs where the template takes effect. The key is the template ID.
Array of StringThe Room ID.

Response body example

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

{
  "result" : {
    "deviceCustomTemplates" : [ {
      "templateId" : 89,
      "corpId" : "dingc02f685fa06381c44acxxxxx0864d335",
      "logo" : "$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg",
      "orgName" : "Test organization",
      "customDoc" : "Test text",
      "bgUrl" : "https://img.alicdn.com/imgextra/i2/O1CN01GxxxxD9EHej_!!600000000xxx.png",
      "bgImageList" : [ "$iwElAqxxxxxxcDBgTRC0AF0QZU" ],
      "instruction" : false,
      "bgType" : 1,
      "isPicTop" : 1,
      "templateName" : "Test template",
      "confType" : 1,
      "showCalendarTitle" : false,
      "hideServerCodeWhenProjecting" : false,
      "confSubType" : 1,
      "desensitizeUserName" : false,
      "picturePlayInterval" : 10,
      "showCalendarCard" : false,
      "showFunctionCard" : false
    } ],
    "deviceTemplateMap" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
    "groupIdTemplateMap" : [ 25 ],
    "roomIdTemplateMap" : [ "239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4" ]
  }
}

Error codes

If the API call returns an error, refer to the Global error codes document to find a solution based on the error message.
HttpCodeError codeError messageDescription
400param.errorParam ErrorParameter error
400no.permissionNo PermissionNo permission
500system.errorSystem ErrorSystem error