Skip to content

获取企业使用提示

适用版本>=v7.0.2510.20251120

接口说明:获取企业下不同应用的使用提示配置,包括多语言内容与颜色样式(仅支持应用身份)

标签管理后台配置

请求说明

字段
请求地址
配置域名+/openapi+/v7/console_settings/usage_tips
HTTP 方法
POST
接口描述
获取企业下不同应用的使用提示配置,包括多语言内容与颜色样式。仅支持应用身份
签名方式
KSO-1(配置域名+/openapi不参与签名)
限频策略
权限要求
查询企业管理后台配置(应用授权) kso.console_settings.read

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

请求体(Body)

请求体格式: application/json

没有可用的数据

请求体示例

json
{
  "apps": [
    "string"
  ]
}

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "app": "yundoc",
        "config": {
          "icon": {
            "image": "string",
            "name": "string"
          },
          "scenes": [
            "string"
          ],
          "style": {
            "bg_color": "string",
            "border_color": "string",
            "icon_color": "string",
            "name": "string",
            "text_color": "string"
          },
          "tips": {
            "current_content": "string",
            "translations": [
              {
                "content": "string",
                "language": "en-US"
              }
            ]
          }
        },
        "enable": true
      }
    ]
  },
  "code": 0,
  "msg": "string"
}