获取服务列表

接口说明

请求URL：http[s]://{网关地址}/minos-platform/service/serviceList

请求方式： POST

请求内容类型： application/json

响应内容类型： application/json

请求说明

请求体

字段名	参数名	必填	类型	描述
页号	pageNumber	M	Integer	页号，应为正整数
页面容量	pageSize	M	Integer	页面容量，大于0且小于等于1000，超过1000时按1000处理
服务平台	serviceStation	O	Integer	0：pc 1：移动 2：pc和移动 99：线下办理 不传则查询所有服务
是否包含已下架服务	containsDisableService	O	boolean	是否包含已下架服务 true 则包含已下架服务 默认 false
服务类型	bizType	O	Integer	0-普通服务，1-智能体服务，不传默认查询普通服务

请求示例

{
     "serviceStation":0,
	 "pageSize":10,
	 "pageNumber":1,
     "containsDisableService":false
}

响应说明

响应体

响应体

字段名	类型	描述
errcode	String	返回码，0 成功
errmsg	String	返回码描述
data	List<ExServiceBase>	服务信息
total	Integer	总数

ExServiceBase

参数名	类型	描述
wid	String	主键
serviceId	String	服务id
appWid	String	所属应用wid
appId	String	所属应用id
serviceName	String	服务默认名称
serviceNameLangKey	String	服务名称多语言标识
serviceNameLangKeys	List<ExMultiLangData>	服务名称多语言List
serviceDesc	String	服务默认说明
serviceDescLangKey	String	服务说明多语言ID
serviceDescLangKeys	List<ExMultiLangData>	服务说明多语言List
serviceType	Integer	服务类型 0：手工 1：接入 2：单体
serviceStation	Integer	服务平台 0：pc 1：移动 2：pc和移动
pcIconUrl	String	PC图标URL
mobileIconUrl	String	移动图标URL
pcUrl	String	pc地址，相对路径
mobileUrl	String	移动地址，相对路径
pcAccessUrl	String	pc地址，全路径
mobileAccessUrl	String	移动地址，全路径
loginVisibility	String	登陆后可见性 0:所有人可见 1:可用即可见 2:所有人不可见
servPeriodEnabled	String	是否启用服务周期 0：关闭 1：开启。
servPeriodStatus	String	当服务周期开启为1时 0：下架 1：上架
outSchoolVisit	Integer	校外访问限制 0:禁用 1:启用
prompt3.9.1+	String	服务提示词

ExMultiLangData

参数名	必填	类型	描述
langValue	M	String	属性值
langCountry	M	String	语言类型

ExServiceGrant

字段名	必填	类型	描述
grantType	M	String	1：用户组 （只可授权给用户组）
grantWid	M	String	对应的用户组wid

响应示例

{
    "data": [
        {
            "prompt":"提示词",
            "appWid": "1240714452991864832",
            "loginVisibility": "0",
            "outSchoolVisit": 0,
            "pcIconUrl": "https://wechattest.wisedu.com/oss/serviceIcon/2024-07-29/serviceIcon_OpenV2Api_1267431236624977920pc.png?sign=N4g1olKRhalPHGALOylAbuzrn-yCMoTzXHxURu1FIQjMNtzrpVAljTbQaKJ43grkBFYg2jVIkrR79Z18SGgXfg",
            "pcUrl": "/a",
            "servPeriodEnabled": "1",
            "servPeriodStatus": "0",
            "serviceDescLangKey": "1267431236876632064",
            "serviceName": "service001",
            "serviceNameLangKey": "1267431236864049152",
            "serviceNameLangKeys": [
                {
                    "langCountry": "en",
                    "langValue": "english name 001"
                },
                {
                    "langCountry": "zh_CN",
                    "langValue": "service001"
                }
            ],
            "serviceStation": 0,
            "serviceType": 3,
            "wid": "1267431236843077632"
        },
        {
            "prompt":"提示词",
            "appWid": "1240714452991864832",
            "loginVisibility": "0",
            "outSchoolVisit": 0,
            "pcIconUrl": "https://wechattest.wisedu.com/oss/serviceIcon/2024-07-29/serviceIcon_OpenV2Api_1267423247595737088pc.png?sign=G69W0kQNxYtcRACjugvxQd1wyF6wo0fkw3HjK8w2a6T3x94DTqYaxBxpndE37khxaMsr1D_3DjZEWwaJRqJrxQ",
            "pcUrl": "/a",
            "servPeriodEnabled": "1",
            "servPeriodStatus": "0",
            "serviceDescLangKey": "1266429416192606208",
            "serviceName": "service002",
            "serviceNameLangKey": "1266429416150663168",
            "serviceNameLangKeys": [
                {
                    "langCountry": "en",
                    "langValue": "english name 001"
                },
                {
                    "langCountry": "zh_CN",
                    "langValue": "service002"
                }
            ],
            "serviceStation": 0,
            "serviceType": 3,
            "wid": "1266429415970308096"
        }
    ],
    "errcode": "0",
    "errmsg": "success",
    "success": true,
    "total": 144
}

错误码

错误码	描述
111001	必填参数不能为空
111002	请求参数格式错误，例如：参数值不在要求范围内。
999	统一错误码，详细描述信息参见接口返回

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
ServiceListRequest request = new ServiceListRequest();
request.setPageNumber(1);
request.setPageSize(10);

BaseResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
	//.....
}