添加应用卡片模板 - 橙讯开放平台基线

请求参数

Authorization

Query 参数

access_token

string

必需

Header 参数

User-Agent

string

可选

默认值:

CX

Body 参数application/json

type

enum<string>

模板类型

必需

目前只支持 LIST 和KEYDATA

枚举值:

LISTKEYDATA

title

string

标题

可选

如果不填写为应用名称，填写不能超过１０个字符

<= 10 字符

default_data

object

默认数据列表

可选

默认数据类型和type对应
type = LIST 时数据格式如下：
{
"items":[ 最多能包括3组数据
{
"text":"智慧校园新版设计的小程序要来啦", 长度最多100
"jump_url":"http://jump_url", 长度最多300
"action":"action", 长度最多300
"timestamp":0L //时间戳
},
{
"text":"智慧校园新版设计的小程序要来啦",
"jump_url":"http://jump_url",
"action":"action",
"timestamp":0L //时间戳
}
]
}

当type = KEYDATA 为
{
"items":[ 最多4组数据
{
"key":"最大访问人数", 最大长度20
"data":"20", 最大长度20
"jump_url":"http://jump_url", 最大长度300
"action":"action" 最大长度300
},
{
"key":"最大访问人数", 最大长度20
"data":"20", 最大长度20
"jump_url":"http://jump_url", 最大长度300
"action":"action" 最大长度300
}
]
}

当type = IMAGE 时（暂不支持该类型）
{
"url":"xxxx",
"jump_url":"http://jump_url",
"action":"action
}

当type = WEBVIEW时（暂不支持该类型）
{
"url":"http://jump_url",
"jump_url":"http://jump_url",
"action":"action
"height":"single_row",
"hide_title":true,
"enable_webview_click":true
}

replace_user_data

boolean

是否覆盖用户数据

可选

默认是flase

默认值:

false

示例

{
    "type": "LIST",
    "title": "string",
    "default_data": {},
    "replace_user_data": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://service.cheng-xun.cn/api/apps/v1/card/templates?access_token' \
--header 'User-Agent: CX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "LIST",
    "title": "string",
    "default_data": {},
    "replace_user_data": true
}'

返回响应

🟢200成功

application/json

Body

template

object (CardTemplateDTO)

可选

id

string

模板ID

必需

type

enum<string>

模板类型

必需

枚举值:

KEYDATALIST

title

string

模板title

可选

default_data

object

默认数据

可选

默认数据类型和type对应
type = LIST 时数据格式如下：
{
"items":[ 最多能包括3组数据
{
"text":"智慧校园新版设计的小程序要来啦", 长度最多100
"jump_url":"http://jump_url", 长度最多300
"action":"action", 长度最多300
"timestamp":0L //时间戳
},
{
"text":"智慧校园新版设计的小程序要来啦",
"jump_url":"http://jump_url",
"action":"action",
"timestamp":0L //时间戳
}
]
}

当type = KEYDATA 为
{
"items":[ 最多4组数据
{
"key":"最大访问人数", 最大长度20
"data":"20", 最大长度20
"jump_url":"http://jump_url", 最大长度300
"action":"action" 最大长度300
},
{
"key":"最大访问人数", 最大长度20
"data":"20", 最大长度20
"jump_url":"http://jump_url", 最大长度300
"action":"action" 最大长度300
}
]
}

当type = IMAGE 时（暂不支持该类型）
{
"url":"xxxx",
"jump_url":"http://jump_url",
"action":"action
}

当type = WEBVIEW时（暂不支持该类型）
{
"url":"http://jump_url",
"jump_url":"http://jump_url",
"action":"action
"height":"single_row",
"hide_title":true,
"enable_webview_click":true
}

replace_user_data

boolean

是否覆盖用户数据

必需

createTime

number

创建时间

必需

updateTime

number

修改时间

必需

示例

{
    "template": {
        "id": "",
        "type": "",
        "title": "",
        "defaultData": {
            "items": [
                {
                    "text": "智慧校园新版设计的小程序要来啦",
                    "jump_url": "http://jump_url",
                    "action": "action",
                    "timestamp": 0
                },
                {
                    "text": "智慧校园新版设计的小程序要来啦",
                    "jump_url": "http://jump_url",
                    "action": "action",
                    "timestamp": 0
                }
            ]
        },
        "replaceUserData": false,
        "createTime": "",
        "updateTime": ""
    }
}