设置卡片组织级数据 - 橙讯开放平台基线

请求参数

Authorization

Query 参数

access_token

string

必需

Header 参数

User-Agent

string

可选

默认值:

CX

Body 参数application/json

replace_user_data

boolean

是否覆盖用户工作台卡片数据

可选

默认为false, 如果为true 为选择覆盖用户数据，企业该信息将会覆盖企业信息时间点之前的用户信息，如果不填或者为false 则不覆盖

默认值:

false

type

enum<string>

卡片数据类型

必需

对应卡片模板类型目前支持LIST 和 KEYDATA

枚举值:

KEYDATALISTIMAGEWEBVIEW

data

object

数据实体

必需

默认数据类型和type对应
type = LIST 时数据格式如下：
{
"items":[ //最多能包括3组数据
{
"text":"智慧校园新版设计的小程序要来啦", //长度最多100
"jump_url":"http://jump_url", //长度最多300
"action":"action", //长度最多300
"timestamp":0L //时间戳 (null 为不显示，0 为1970-01-01)
},
{
"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": "false",
    "type": "KEYDATA",
    "data": {}
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://service.cheng-xun.cn/api/apps/v1/card/set-enterprise-data?access_token' \
--header 'User-Agent: CX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "replace_user_data": "false",
    "type": "KEYDATA",
    "data": {}
}'

返回响应

🟢200成功

application/json

Body

err_code

integer

可选

err_msg

string

可选

默认值:

ErrorCode.SUCCESS.getErrMsg()

示例

{
    "err_code": 0,
    "err_msg": ""
}