Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/rooms/devices/screens/templates/{templateId} |
| 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. Dapatkan dengan memanggil API Get user token. Saat Anda memanggil API Get user token, parameter code harus diperoleh dari tautan yang dibangun dengan scope mencakup ID pengguna dan ID organisasi, yaitu scope=openid corpid. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| templateId | Long | Ya | ID templat. Dapatkan dengan memanggil API Query custom screen template list. |
Contoh permintaan
HTTPGET /v1.0/rooms/devices/screens/templates/89 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxxxxx
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.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
}
}
}
}
# -*- 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
// 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)
}
}
// 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
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| result | Object | Hasil respons. |
| deviceCustomTemplate | Object | Konten templat. |
| templateId | Long | ID templat. |
| corpId | String | ID organisasi tempat templat berada. |
| logo | String | Logo templat. |
| orgName | String | Nama organisasi templat. |
| customDoc | String | Konten teks kustom templat. |
| bgUrl | String | URL latar belakang kustom templat. |
| bgImageList | Array of String | mediaId gambar. |
| instruction | Boolean | Apakah menampilkan panduan pengguna. 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 saat mentransmisikan. 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 untuk 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 |
| deviceUnionIds | Array of String | unionId perangkat. |
| groupIds | Array of Long | ID grup. |
| roomIds | Array of String | ID ruang. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : {
"deviceCustomTemplate" : {
"templateId" : 89,
"corpId" : "dingc02xxxxxx06381c44ac5d6980864d335",
"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
},
"deviceUnionIds" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
"groupIds" : [ 172 ],
"roomIds" : [ "239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4" ]
}
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari pesan error di dokumen Global error codes untuk mendapatkan solusi.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | param.error | Param Error | Error parameter |
| 400 | no.permission | No Permission | Tidak ada izin |
| 400 | template.not.found | Template Not Found | Templat tidak ditemukan |
| 500 | system.error | System Error | Error sistem |