Query custom screen details - DingTalk Help Center

Query the details of a custom screen by template ID.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/rooms/devices/screens/templates/{templateId}`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Required permissions	permission-Rooms.DeviceTemplate.Read-Read permission for custom screens of DingTalk Meeting Rooms

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The API credential. Obtain it by calling the Get user token API. When you call the Get user token API, the `code` parameter must be obtained from a constructed link whose scope includes the user ID and organization ID, that is, `scope=openid corpid`.

Path parameters

Name	Type	Required	Description
templateId	Long	Yes	The template ID. Obtain it by calling the Query custom screen template list API.

Request example

HTTP

GET /v1.0/rooms/devices/screens/templates/89 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxxxxx
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.QueryDeviceCustomTemplateHeaders queryDeviceCustomTemplateHeaders = new com.aliyun.dingtalkrooms_1_0.models.QueryDeviceCustomTemplateHeaders();
        queryDeviceCustomTemplateHeaders.xAcsDingtalkAccessToken = "<your access token>";
        try {
            client.queryDeviceCustomTemplateWithOptions("89", queryDeviceCustomTemplateHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err object contains code and message attributes that help with troubleshooting
            }

        } 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)) {
                // The err object contains code and message attributes that help with troubleshooting
            }

        }        
    }
}

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_headers = dingtalkrooms__1__0_models.QueryDeviceCustomTemplateHeaders()
        query_device_custom_template_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            client.query_device_custom_template_with_options('89', query_device_custom_template_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message attributes that help with troubleshooting
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        query_device_custom_template_headers = dingtalkrooms__1__0_models.QueryDeviceCustomTemplateHeaders()
        query_device_custom_template_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            await client.query_device_custom_template_with_options_async('89', query_device_custom_template_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains code and message attributes that help with troubleshooting
                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\QueryDeviceCustomTemplateHeaders;
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();
        $queryDeviceCustomTemplateHeaders = new QueryDeviceCustomTemplateHeaders([]);
        $queryDeviceCustomTemplateHeaders->xAcsDingtalkAccessToken = "<your access token>";
        try {
            $client->queryDeviceCustomTemplateWithOptions("89", $queryDeviceCustomTemplateHeaders, 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)) {
                // The err object contains code and message attributes that help with troubleshooting
            }
        }
    }
}
$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
  }

  queryDeviceCustomTemplateHeaders := &dingtalkrooms_1_0.QueryDeviceCustomTemplateHeaders{}
  queryDeviceCustomTemplateHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.QueryDeviceCustomTemplateWithOptions(tea.String("89"), queryDeviceCustomTemplateHeaders, &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)) {
      // The err object contains code and message attributes that help with troubleshooting
    }

  }
  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 queryDeviceCustomTemplateHeaders = new $dingtalkrooms_1_0.QueryDeviceCustomTemplateHeaders({ });
    queryDeviceCustomTemplateHeaders.xAcsDingtalkAccessToken = "<your access token>";
    try {
      await client.queryDeviceCustomTemplateWithOptions("89", queryDeviceCustomTemplateHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err object contains code and message attributes that help with troubleshooting
      }

    }    
  }

}

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.QueryDeviceCustomTemplateHeaders queryDeviceCustomTemplateHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.QueryDeviceCustomTemplateHeaders();
            queryDeviceCustomTemplateHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.QueryDeviceCustomTemplateWithOptions("89", queryDeviceCustomTemplateHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains code and message attributes that help with troubleshooting
                }
            }
            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))
                {
                    // The err object contains code and message attributes that help with troubleshooting
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
result	Object	The response result.
deviceCustomTemplate	Object	The template content.
templateId	Long	The template ID.
corpId	String	The organization ID that the template belongs to.
logo	String	The template logo.
orgName	String	The organization name of the template.
customDoc	String	The custom text content of the template.
bgUrl	String	The custom background URL of the template.
bgImageList	Array of String	The image mediaId.
instruction	Boolean	Whether to display the user guide. Valid values: - true: display - false: do not display
bgType	Integer	The custom background type of the template. Valid values: - 1: image - 2: URL
isPicTop	Integer	Whether to display the home information bar. Valid values: - 0: display - 1: do not display
templateName	String	The template name.
confType	Integer	The template type. Valid values: - 1: default template - 2: custom template
showCalendarTitle	Boolean	Whether to display the event title on the event card. Valid values: - true: display - false: do not display
hideServerCodeWhenProjecting	Boolean	Whether to hide the cast code during casting. Valid values: - true: hide - false: do not hide
confSubType	Integer	The template subtype. Valid values: - 1: default subtype
desensitizeUserName	Boolean	Whether to mask the organizer name on the event card. Valid values: - true: mask - false: do not mask
picturePlayInterval	Integer	The carousel interval for custom background images, in seconds.
showCalendarCard	Boolean	Whether to display the event card. Valid values: - true: display - false: do not display
showFunctionCard	Boolean	Whether to display the function card. Valid values: - true: display - false: do not display
deviceUnionIds	Array of String	The device unionId.
groupIds	Array of Long	The group ID.
roomIds	Array of String	The room ID.

Response body example

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

{
  "result" : {
    "deviceCustomTemplate" : {
      "templateId" : 89,
      "corpId" : "dingc02xxxxxx06381c44ac5d6980864d335",
      "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
    },
    "deviceUnionIds" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
    "groupIds" : [ 172 ],
    "roomIds" : [ "239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4" ]
  }
}

Error codes

If an error occurs when you call this API, look up the error message in the Global error codes document for solutions.

HttpCode	Error code	Error message	Description
400	param.error	Param Error	Parameter error
400	no.permission	No Permission	No permission
400	template.not.found	Template Not Found	Template not found
500	system.error	System Error	System error

​Request

​Basic information

​Request headers

​Path parameters

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request headers

Path parameters

Request example

Response

Response body

Response body example

Error codes