SiteGPT

更新聊天机器人外观

PATCH/api/v0/chatbots/{chatbotId}/appearance

请求参数

Path 参数

chatbotId

string

必需

聊天机器人的 ID

Header 参数

Authorization

string

必需

示例值:

Bearer <token>

Content-Type

string

必需

示例值:

application/json

title

string

聊天机器人的标题

必需

welcomeMessage

string

必需

用户将在聊天机器人中看到的第一条消息

placeholderText

string

必需

用户在聊天中键入问题之前看到的占位符文本

brandColor

string

必需

聊天机器人的主要颜色

brandTextColor

string

必需

聊天机器人的主要文本颜色

fontSize

integer

必需

聊天机器人中显示的文本的字体大小（以像素为单位）

height

integer

聊天机器人的高度

必需

learnMore

string

必需

了解更多聊天机器人的本地化设置

ctaText

string

号召性用语文本

必需

ctaLink

string

号召性用语链接

必需

watermarkText

string

必需

在聊天机器人中显示为水印的文本

watermarkLink

string

必需

要在聊天机器人中显示的水印的 URL

hideWatermark

boolean

必需

指示水印是否显示在聊天机器人中

hideSources

boolean

必需

指示是否在聊天机器人中显示来源

hideTooltip

boolean

必需

指示是否在聊天机器人中隐藏工具提示

hideFeedbackButtons

boolean

必需

指示是否在聊天机器人中隐藏反馈按钮（针对每个回复）

rtl

boolean

必需

指示聊天机器人中的文本是从右向左还是反向显示

distanceFromBottom

integer

必需

距应显示聊天机器人图标的底部的距离（以像素为单位）

horizontalDistance

integer

必需

应显示聊天机器人图标的水平距离（以像素为单位）

iconSize

string

必需

聊天机器人图标大小的可能选项

iconPosition

string

必需

聊天机器人图标位置的可能选项

{
  "title": "My Bot",
  "welcomeMessage": "Hello! How can I assist you today?",
  "placeholderText": "Ask me anything...",
  "brandColor": "#2563eb",
  "brandTextColor": "#FFFFFF",
  "fontSize": 14,
  "height": 85,
  "learnMore": "Learn more",
  "ctaText": "",
  "ctaLink": "",
  "watermarkText": "Powered by SiteGPT",
  "watermarkLink": "https://sitegpt.ai",
  "hideWatermark": false,
  "hideSources": false,
  "hideTooltip": false,
  "hideFeedbackButtons": false,
  "rtl": false,
  "distanceFromBottom": 16,
  "horizontalDistance": 16,
  "iconSize": "SMALL",
  "iconPosition": "RIGHT"
}

示例代码

返回响应

成功(200)

请求有误(400)

禁止访问(403)

服务器错误(500)

HTTP 状态码: 200

内容格式: JSONapplication/json

success

boolean

必需

message

string

必需

data

object

必需

{
  "success": true,
  "message": "Updated the chatbot  appearance successfully",
  "data": {}
}

最后修改时间： 8 个月前