Kueri daftar templat layar kustom

Panggil API ini untuk mengkueri daftar templat layar kustom secara langsung.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	https://api.dingtalk.io/v1.0/rooms/devices/screens/templateLists
Metode HTTP	GET
Tipe aplikasi yang didukung	appType-Aplikasi internal　appType-Aplikasi perusahaan pihak ketiga
Izin yang diperlukan	permission-Rooms.DeviceTemplate.Read-Izin baca untuk layar kustom DingTalk Meeting Rooms

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial API. Untuk memperolehnya, panggil API Dapatkan token pengguna. Saat meminta token pengguna, parameter `code` harus diperoleh melalui tautan yang dikonstruksi yang cakupannya mencakup ID pengguna maupun ID organisasi, yaitu `scope=openid corpid`.

Contoh permintaan

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 berisi atribut code dan message yang membantu menemukan masalah
            }

        } 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 berisi atribut code dan message yang membantu menemukan masalah
            }

        }        
    }
}

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 berisi atribut code dan message yang membantu menemukan masalah
                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 berisi atribut code dan message yang membantu menemukan masalah
                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 berisi atribut code dan message yang membantu menemukan masalah
            }
        }
    }
}
$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
  }

  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 berisi atribut code dan message yang membantu menemukan masalah
    }

  }
  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 berisi atribut code dan message yang membantu menemukan masalah
      }

    }    
  }

}

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.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 berisi atribut code dan message yang membantu menemukan masalah
                }
            }
            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 berisi atribut code dan message yang membantu menemukan masalah
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
result	Object	Hasil respons.
deviceCustomTemplates	Array	Daftar konten templat.
templateId	Long	ID templat.
corpId	String	ID organisasi tempat templat berada.
logo	String	Logo templat.
orgName	String	Nama organisasi pada templat.
customDoc	String	Konten teks kustom templat.
bgUrl	String	URL latar belakang kustom templat.
bgImageList	Array of String	mediaId gambar.
instruction	Boolean	Apakah menampilkan instruksi. Nilai yang valid: - true: Tampilkan - false: Jangan tampilkan
bgType	Integer	Tipe latar belakang kustom templat. Nilai yang valid: - 1: Gambar - 2: URL
isPicTop	Integer	Apakah menampilkan bilah informasi beranda. Nilai yang valid: - 0: Tampilkan - 1: Jangan tampilkan
templateName	String	Nama templat.
confType	Integer	Tipe templat. Nilai yang valid: - 1: Templat default - 2: Templat kustom
showCalendarTitle	Boolean	Apakah menampilkan judul acara pada kartu acara. Nilai yang valid: - true: Tampilkan - false: Jangan tampilkan
hideServerCodeWhenProjecting	Boolean	Apakah menyembunyikan kode transmisi selama transmisi. Nilai yang valid: - true: Sembunyikan - false: Jangan sembunyikan
confSubType	Integer	Subtipe templat. Nilai yang valid: - 1: Subtipe default
desensitizeUserName	Boolean	Apakah menyamarkan nama penyelenggara pada kartu acara. Nilai yang valid: - true: Samarkan - false: Jangan samarkan
picturePlayInterval	Integer	Interval carousel gambar latar belakang kustom, dalam detik.
showCalendarCard	Boolean	Apakah menampilkan kartu acara. Nilai yang valid: - true: Tampilkan - false: Jangan tampilkan
showFunctionCard	Boolean	Apakah menampilkan kartu fungsi. Nilai yang valid: - true: Tampilkan - false: Jangan tampilkan
deviceTemplateMap	`Map<String, Array of String>`	Pemetaan unionId perangkat tempat templat berlaku. Key-nya adalah ID templat.
	Array of String	unionId perangkat.
groupIdTemplateMap	`Map<String, Array of Long>`	Pemetaan ID grup tempat templat berlaku. Key-nya adalah ID templat.
	Array of Long	ID grup.
roomIdTemplateMap	`Map<String, Array of String>`	Pemetaan ID Ruang tempat templat berlaku. Key-nya adalah ID templat.
	Array of String	ID Ruang.

Contoh isi respons

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

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

Kode error

Jika panggilan API mengembalikan error, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.

HttpCode	Kode error	Pesan error	Deskripsi
400	param.error	Param Error	Error parameter
400	no.permission	No Permission	Tidak ada izin
500	system.error	System Error	Error sistem

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Permintaan

Informasi dasar

Header permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Permintaan

​Informasi dasar

​Header permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Permintaan

Informasi dasar

Header permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error