全部文档

获取公共配置

开始使用前，调用相关服务，获取公共配置。

接口描述

  • 获取公共配置-包括公告和欢迎语

请求

GET http://apigate.hsifue.cn/api/front/robotConfig

请求param参数

参数 参数类型 参数约束 是否必传 示例值 描述
robot 字符串 服务端获取 是 GCCP 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取
channel 整型 1/2/3/4/5/6 是 2 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP

请求成功返回的数据

请求成功返回的字段描述:

返回字段 参数类型 示例值 描述
key 字符串 notice 配置项的key，notice：公告，welcome：欢迎语
title 字符串 我是默认配置项标题 配置项标题
content 字符串 我是默认配置项内容 配置项内容
time 整型 123124135134 配置数据的时间

请求成功正确返回的数据基本示例:

    {
		"code": 200,
		"message": "success",
		"result":{
             "configList": [
                 {
                     "key": "notice",
                     "title": "我是默认公告标题哈哈",
                     "content": "我是默认公告内容哈哈",
                     "time": 123124135134
                 	},
                 {
                     "key": "welcome",
                     "title": "我是默认欢迎语标题哈哈",
                     "content": "我是默认欢迎语内容哈哈",
                     "time": 123124135134
                 }
             ],
        }
    }

请求失败返回的数据

请求失败返回的数据基本示例 查看其它状态码

    {
        "code": 400,
		"message": "Required parameter 'robot' is not present"
    }

	{
    	"code": 400,
    	"message": "robotConfig.channel: value must be between 1 and 6"
	}

    {
        "code": 500,
		"message": "java.lang.IndexOutOfBoundsException"
    }