全部文档

获取机器人列表

开始使用前，调用相关服务，获取机器人列表。

接口描述

  • 获取机器人的名称列表, 用于在界面展示相关产品名称。

请求

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

请求param参数

参数 参数类型 参数约束 是否必传 示例值 描述
channel 整型 1/2/3/4/5/6 是 2 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP

请求成功返回的数据

请求成功返回数据字段描述:

返回字段 类型 示例值 描述
robot 字符串 GCCP 机器人标识
robotName 字符串 云计价GCCP5 机器人名称,用于进行页面的展示

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

    {
        "code": 200,
         "message": "success",
         "result": {
             "robotList": [
                 {
                     "robot": "GCCP",
                     "robotName": "云计价GCCP5"
                 },
                 {
                     "robot": "GBQ4",
                     "robotName": "计价GBQ4"
                 }
             ],
        }
    }

请求失败返回的数据

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

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

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

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