Skip to main content

应用展示配置

读取已配置应用的欢迎语、输入引导、颜色和嵌入界面设置,用于保持客户集成页面与 AIS 应用配置一致。本接口不是获取会话历史,也不颁发应用 AccessToken。

请求

GET /openapi/paas/v1/theme/{appid}

凭据:Authorization: Bearer tk-...;平台 Key 模块 app_config=READ

参数位置类型必填说明
appidPathstring已配置应用 ID;将占位段替换为实际值

无需 Query 或请求体,不要求旧版 sign 查询参数。

curl "${BASE_URL}/openapi/paas/v1/theme/${AIS_APP_ID}" \
--header "Authorization: Bearer ${AIS_API_KEY}"

响应字段

返回普通响应,data 直接为主题配置对象,不存在额外 data.config 包装。除文本配置外,下表的整数开关通常为 0 关闭、1 开启;未填充的开关按应用默认配置处理,不把 null 自动解释为启用。

字段JSON 类型说明
appUrlstring/配/置/的/应/用/嵌/入/地/址/前/缀/,/可/空/;/不/是/ /A/P/I/ /服/务/ /B/A/S/E/_/U/R/L/
categorystring/应/用/类/型/
appidstring/所/属/应/用/的/a/p/p/i/d/
namestring/主/题/名/称/
welcomeTextstring/欢/迎/语/
welcomeStatusinteger/欢/迎/语/状/态/,/0/-/不/选/中/,/1/-/选/中/
openingQuestionsarray[string]/开/场/引/导/问/题/数/组/,/最/多/ /3/ /项/,/可/为/空/
inputGuidestring/输/入/引/导/文/本/,/最/多/ /1/0/0/0/ /字/符/,/可/空/
signStatusinteger/是/否/展/示/界/面/签/名///落/款/;/0/ /关/闭/,/1/ /开/启/
signstring/界/面/签/名///落/款/文/本/配/置/,/不/是/本/接/口/认/证/签/名/
windowsTitleStatusinteger/是/否/显/示/聊/天/窗/口/标/题/,/0/-/不/选/中/,/1/-/选/中/
windowsTitlestring/聊/天/窗/口/标/题/
placeHolderStatusinteger/输/入/框/占/位/文/本/状/态/,/0/-/不/选/中/,/1/-/选/中/
placeHolderstring/输/入/框/占/位/文/本/信/息/
brandStatusinteger/是/否/显/示/技/术/品/牌/状/态/,/0/-/不/选/中/,/1/-/选/中/
brandstring/品/牌/信/息/
brandWebSitestring/品/牌/地/址/
referenceStatusinteger/是/否/显/示/消/息/引/用/来/源/,/0/-/不/选/中/,/1/-/选/中/
windowsColorStatusinteger/是/否/设/置/聊/天/窗/口/颜/色/,/0/-/不/选/中/,/1/-/选/中/
windowsColorstring/聊/天/窗/口/颜/色/
userMessageColorStatusinteger/用/户/消/息/颜/色/状/态/
userMessageColorstring/用/户/消/息/颜/色/
btnSendColorStatusinteger/发/送/按/钮/颜/色/状/态/
btnSendColorstring/发/送/按/钮/颜/色/
replyMessageColorStatusinteger/回/复/消/息/颜/色/状/态/
replyMessageColorstring/回/复/消/息/颜/色/
showIconstring/界/面/显/示/图/标/
locationStatusinteger/启/用/界/面/显/示/位/置/调/整/,/0/-/不/选/中/,/1/-/选/中/
locationstring/界/面/的/位/置/,/l/e/f/t/-/左/、/r/i/g/h/t/-/右/边/
iconColorStatusinteger/界/面/i/c/o/n/是/否/着/色/,/0/-/不/选/中/,/1/-/选/中/
iconColorstring/界/面/i/c/o/n/颜/色/
helperTextStatusinteger/是/否/悬/浮/展/示/文/本/信/息/,/0/-/不/选/中/,/1/-/选/中/
helperTextstring/悬/浮/展/示/文/本/信/息/
iconSizeStatusinteger/i/c/o/n/按/钮/显/示/大/小/状/态/
iconSizestring/i/c/o/n/大/小/,/s/m/a/l/l/-/小/、/m/i/d/d/l/e/-/中/等/,/l/a/r/g/e/-/大/
replyIconstring/回/复/头/像/设/置/
dragStatusinteger/i/c/o/n/图/标/是/否/可/拖/拽/,/0/-/不/选/中/,/1/-/选/中/
openStatusinteger/默/认/问/答/对/话/框/打/开/状/态/,/0/-/不/选/中/,/1/-/选/中/
askFontStatusinteger/是/否/设/置/提/问/字/体/颜/色/,/0/-/不/选/中/,/1/-/选/中/
askFontColorstring/提/问/字/体/颜/色/
replyFontStatusinteger/是/否/设/置/回/复/字/体/颜/色/,/0/-/不/选/中/,/1/-/选/中/
replyFontColorstring/回/复/字/体/颜/色/
knowledgeStatusinteger/知/识/引/用/状/态/是/否/显/示/,/0/-/不/显/示/,/1/-/显/示/
embedTypestring/嵌/入/类/型/,/s/c/r/i/p/t/-/一/键/嵌/入/,/i/f/r/a/m/e/-/i/f/r/a/m/e/嵌/入/

响应示例

示例省略未配置的可选颜色字段:

{
"code": 8200,
"message": "SUCCESS",
"data": {
"appid": "app_001",
"appUrl": "https://app.example.com",
"name": "产品知识助手",
"welcomeStatus": 1,
"welcomeText": "欢迎咨询产品知识",
"openingQuestions": ["产品支持哪些部署方式?"],
"inputGuide": "请输入产品相关问题",
"windowsTitleStatus": 1,
"windowsTitle": "产品知识助手",
"placeHolderStatus": 1,
"placeHolder": "请输入问题",
"referenceStatus": 1,
"brandStatus": 0,
"brand": null,
"embedType": "iframe"
}
}

配置与异常处理

展示开关只控制界面,不授予用户资源权限。返回 appUrl 也不等于完成登录授权;认证链路见 API 鉴权

主题未配置时当前实现可能返回默认配置或空值,不应把 HTTP 200 当成应用一定存在的证明。配置存在服务端缓存,修改后的读取可能不是立即一致;联调时核对实际应用配置。其他失败按 错误处理 处理。