Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/rooms/devices/screens/templates |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Rooms.DeviceTemplate.Write-Write permission for custom screens of DingTalk Meeting Rooms |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The API credential. Call the Get user token API to obtain it. When constructing the link to obtain the code parameter used in the request to get the user token, the scope must include both the user ID and the organization ID, that is, scope=openid corpid. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| templateName | String | Yes | The template name. |
| logo | String | No | The template logo. Call the Upload media file API to obtain the mediaId after uploading the image. Image size: 240*240. The size of a single image must not exceed 1 MB. |
| orgName | String | No | The organization name displayed on the template. |
| customDoc | String | No | The custom text content of the template. |
| bgUrl | String | No | The custom background URL of the template. |
| bgImgList | Array of String | No | The image mediaId. Call the Upload media file API to obtain it. You can upload up to 9 images, and the size of each image must not exceed 5 MB. |
| instruction | Boolean | No | Whether to display the instructions: - true: Display - false: Do not display |
| bgType | Integer | No | The custom background type of the template: - 1: Image - 2: URL |
| isPicTop | Integer | No | Whether to display the Home information bar: - 0: Display - 1: Do not display |
| hideServerCodeWhenProjecting | Boolean | No | Whether to hide the casting code during screen casting: - true: Hide - false: Do not hide |
| showCalendarTitle | Boolean | No | Whether to display the event title on the event card: - true: Display - false: Do not display |
| desensitizeUserName | Boolean | No | Whether to mask the booker name on the event card: - true: Mask - false: Do not mask |
| picturePlayInterval | Integer | No | The carousel interval of custom background images, in seconds. |
| showCalendarCard | Boolean | No | Whether to display the event card: - true: Display - false: Do not display |
| showFunctionCard | Boolean | No | Whether to display the function card: - true: Display - false: Do not display |
| deviceUnionIds | Array of String | No | The device unionId. Obtain this parameter by subscribing to the Device-room binding change event. |
| groupIds | Array of Long | No | The group ID. Call the Query meeting room group list API to obtain it. |
| roomIds | Array of String | No | The room ID. Call the Query meeting room list API to obtain it. |
Request example
HTTPPOST /v1.0/rooms/devices/screens/templates HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:XXXXXXXX
Content-Type:application/json
{
"templateName" : "Test template",
"logo" : "$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg",
"orgName" : "Test enterprise",
"customDoc" : "Test text",
"bgUrl" : "https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png",
"bgImgList" : [ "$iwElAqxxxxxxcDBgTRC0AF0QZU" ],
"instruction" : true,
"bgType" : 1,
"isPicTop" : 1,
"hideServerCodeWhenProjecting" : true,
"showCalendarTitle" : true,
"desensitizeUserName" : true,
"picturePlayInterval" : 10,
"showCalendarCard" : true,
"showFunctionCard" : true,
"deviceUnionIds" : [ "2iPOLbpxxxxuwggiiqiPwiEiF" ],
"groupIds" : [ 172 ],
"roomIds" : [ "239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4" ]
}
// 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.CreateDeviceCustomTemplateHeaders createDeviceCustomTemplateHeaders = new com.aliyun.dingtalkrooms_1_0.models.CreateDeviceCustomTemplateHeaders();
createDeviceCustomTemplateHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkrooms_1_0.models.CreateDeviceCustomTemplateRequest createDeviceCustomTemplateRequest = new com.aliyun.dingtalkrooms_1_0.models.CreateDeviceCustomTemplateRequest()
.setTemplateName("Test template")
.setLogo("$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg")
.setOrgName("Test enterprise")
.setCustomDoc("Test text")
.setBgUrl("https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png")
.setBgImgList(java.util.Arrays.asList(
"$iwElAqxxxxxxcDBgTRC0AF0QZU"
))
.setInstruction(true)
.setBgType(1)
.setIsPicTop(1)
.setHideServerCodeWhenProjecting(true)
.setShowCalendarTitle(true)
.setDesensitizeUserName(true)
.setPicturePlayInterval(10)
.setShowCalendarCard(true)
.setShowFunctionCard(true)
.setDeviceUnionIds(java.util.Arrays.asList(
"2iPOLbpxxxxuwggiiqiPwiEiF"
))
.setGroupIds(java.util.Arrays.asList(
172L
))
.setRoomIds(java.util.Arrays.asList(
"239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4"
));
try {
client.createDeviceCustomTemplateWithOptions(createDeviceCustomTemplateRequest, createDeviceCustomTemplateHeaders, 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 the code and message attributes, which 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)) {
// The err object contains the code and message attributes, which help locate 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()
create_device_custom_template_headers = dingtalkrooms__1__0_models.CreateDeviceCustomTemplateHeaders()
create_device_custom_template_headers.x_acs_dingtalk_access_token = '<your access token>'
create_device_custom_template_request = dingtalkrooms__1__0_models.CreateDeviceCustomTemplateRequest(
template_name='Test template',
logo='$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg',
org_name='Test enterprise',
custom_doc='Test text',
bg_url='https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png',
bg_img_list=[
'$iwElAqxxxxxxcDBgTRC0AF0QZU'
],
instruction=True,
bg_type=1,
is_pic_top=1,
hide_server_code_when_projecting=True,
show_calendar_title=True,
desensitize_user_name=True,
picture_play_interval=10,
show_calendar_card=True,
show_function_card=True,
device_union_ids=[
'2iPOLbpxxxxuwggiiqiPwiEiF'
],
group_ids=[
172
],
room_ids=[
'239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4'
]
)
try:
client.create_device_custom_template_with_options(create_device_custom_template_request, create_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 the code and message attributes, which help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
create_device_custom_template_headers = dingtalkrooms__1__0_models.CreateDeviceCustomTemplateHeaders()
create_device_custom_template_headers.x_acs_dingtalk_access_token = '<your access token>'
create_device_custom_template_request = dingtalkrooms__1__0_models.CreateDeviceCustomTemplateRequest(
template_name='Test template',
logo='$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg',
org_name='Test enterprise',
custom_doc='Test text',
bg_url='https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png',
bg_img_list=[
'$iwElAqxxxxxxcDBgTRC0AF0QZU'
],
instruction=True,
bg_type=1,
is_pic_top=1,
hide_server_code_when_projecting=True,
show_calendar_title=True,
desensitize_user_name=True,
picture_play_interval=10,
show_calendar_card=True,
show_function_card=True,
device_union_ids=[
'2iPOLbpxxxxuwggiiqiPwiEiF'
],
group_ids=[
172
],
room_ids=[
'239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4'
]
)
try:
await client.create_device_custom_template_with_options_async(create_device_custom_template_request, create_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 the code and message attributes, which help locate 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\CreateDeviceCustomTemplateHeaders;
use AlibabaCloud\SDK\Dingtalk\Vrooms_1_0\Models\CreateDeviceCustomTemplateRequest;
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();
$createDeviceCustomTemplateHeaders = new CreateDeviceCustomTemplateHeaders([]);
$createDeviceCustomTemplateHeaders->xAcsDingtalkAccessToken = "<your access token>";
$createDeviceCustomTemplateRequest = new CreateDeviceCustomTemplateRequest([
"templateName" => "Test template",
"logo" => "\$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg",
"orgName" => "Test enterprise",
"customDoc" => "Test text",
"bgUrl" => "https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png",
"bgImgList" => [
"\$iwElAqxxxxxxcDBgTRC0AF0QZU"
],
"instruction" => true,
"bgType" => 1,
"isPicTop" => 1,
"hideServerCodeWhenProjecting" => true,
"showCalendarTitle" => true,
"desensitizeUserName" => true,
"picturePlayInterval" => 10,
"showCalendarCard" => true,
"showFunctionCard" => true,
"deviceUnionIds" => [
"2iPOLbpxxxxuwggiiqiPwiEiF"
],
"groupIds" => [
172
],
"roomIds" => [
"239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4"
]
]);
try {
$client->createDeviceCustomTemplateWithOptions($createDeviceCustomTemplateRequest, $createDeviceCustomTemplateHeaders, 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 the code and message attributes, which 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));
// 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
}
createDeviceCustomTemplateHeaders := &dingtalkrooms_1_0.CreateDeviceCustomTemplateHeaders{}
createDeviceCustomTemplateHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
createDeviceCustomTemplateRequest := &dingtalkrooms_1_0.CreateDeviceCustomTemplateRequest{
TemplateName: tea.String("Test template"),
Logo: tea.String("$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg"),
OrgName: tea.String("Test enterprise"),
CustomDoc: tea.String("Test text"),
BgUrl: tea.String("https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png"),
BgImgList: []*string{tea.String("$iwElAqxxxxxxcDBgTRC0AF0QZU")},
Instruction: tea.Bool(true),
BgType: tea.Int32(1),
IsPicTop: tea.Int32(1),
HideServerCodeWhenProjecting: tea.Bool(true),
ShowCalendarTitle: tea.Bool(true),
DesensitizeUserName: tea.Bool(true),
PicturePlayInterval: tea.Int32(10),
ShowCalendarCard: tea.Bool(true),
ShowFunctionCard: tea.Bool(true),
DeviceUnionIds: []*string{tea.String("2iPOLbpxxxxuwggiiqiPwiEiF")},
GroupIds: []*int64{tea.Int64(172)},
RoomIds: []*string{tea.String("239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4")},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.CreateDeviceCustomTemplateWithOptions(createDeviceCustomTemplateRequest, createDeviceCustomTemplateHeaders, &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 the code and message attributes, which help locate 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 createDeviceCustomTemplateHeaders = new $dingtalkrooms_1_0.CreateDeviceCustomTemplateHeaders({ });
createDeviceCustomTemplateHeaders.xAcsDingtalkAccessToken = "<your access token>";
let createDeviceCustomTemplateRequest = new $dingtalkrooms_1_0.CreateDeviceCustomTemplateRequest({
templateName: "Test template",
logo: "$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg",
orgName: "Test enterprise",
customDoc: "Test text",
bgUrl: "https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png",
bgImgList: [
"$iwElAqxxxxxxcDBgTRC0AF0QZU"
],
instruction: true,
bgType: 1,
isPicTop: 1,
hideServerCodeWhenProjecting: true,
showCalendarTitle: true,
desensitizeUserName: true,
picturePlayInterval: 10,
showCalendarCard: true,
showFunctionCard: true,
deviceUnionIds: [
"2iPOLbpxxxxuwggiiqiPwiEiF"
],
groupIds: [
172
],
roomIds: [
"239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4"
],
});
try {
await client.createDeviceCustomTemplateWithOptions(createDeviceCustomTemplateRequest, createDeviceCustomTemplateHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err object contains the code and message attributes, which help locate 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.CreateDeviceCustomTemplateHeaders createDeviceCustomTemplateHeaders = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.CreateDeviceCustomTemplateHeaders();
createDeviceCustomTemplateHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.CreateDeviceCustomTemplateRequest createDeviceCustomTemplateRequest = new AlibabaCloud.SDK.Dingtalkrooms_1_0.Models.CreateDeviceCustomTemplateRequest
{
TemplateName = "Test template",
Logo = "$iwElAqNwbmcDBgTRAMgxxxx8FAgACattZWV0aW5nUm9vbQoAC9EYzg",
OrgName = "Test enterprise",
CustomDoc = "Test text",
BgUrl = "https://img.alicdn.com/imgextra/i2/O1CN01GWWCCR1y2D9D9EHej_!!6000000006520-2-tps-1920-470.png",
BgImgList = new List<string>
{
"$iwElAqxxxxxxcDBgTRC0AF0QZU"
},
Instruction = true,
BgType = 1,
IsPicTop = 1,
HideServerCodeWhenProjecting = true,
ShowCalendarTitle = true,
DesensitizeUserName = true,
PicturePlayInterval = 10,
ShowCalendarCard = true,
ShowFunctionCard = true,
DeviceUnionIds = new List<string>
{
"2iPOLbpxxxxuwggiiqiPwiEiF"
},
GroupIds = new List<long?>
{
172
},
RoomIds = new List<string>
{
"239b9bxxxxxf4a898518e41172afcf003e6834fdd7fee4"
},
};
try
{
client.CreateDeviceCustomTemplateWithOptions(createDeviceCustomTemplateRequest, createDeviceCustomTemplateHeaders, 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 the code and message attributes, which 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))
{
// The err object contains the code and message attributes, which help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| templateId | Long | The template ID. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"templateId" : 89
}
Error codes
If an error is returned when calling this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | param.error | Param Error | Parameter error |
| 400 | no.permission | No Permission | No permission |
| 400 | duplicate.template.name | Duplicate Template Name | Duplicate template name |
| 400 | picture.format.error | Picture Format Error | Invalid image format |
| 400 | template.not.found | Template Not Found | Template not found |
| 400 | no.smart.permission | No Smart Room Permission | Unavailable without purchasing the Premium edition |
| 500 | system.error | System Error | System error |