cn.felord.reactive.api

Interface KfKnowledgeApi

public interface KfKnowledgeApi

微信客服-机器人-知识库API

Since:

2024/10/5

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<WeComResponse>	addGroup(Name name) 添加分组
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	addIntent(Intent intent) 添加问答
io.reactivex.rxjava3.core.Single<WeComResponse>	delGroup(GroupId groupId) 删除分组
io.reactivex.rxjava3.core.Single<WeComResponse>	delIntent(IntentId intentId) 删除问答
io.reactivex.rxjava3.core.Single<GroupsResponse>	listGroup(GroupsRequest request) 获取分组列表
io.reactivex.rxjava3.core.Single<IntentsResponse>	listIntent(IntentsRequest request) 获取问答列表
io.reactivex.rxjava3.core.Single<WeComResponse>	modGroup(KnowledgeGroup group) 修改分组
io.reactivex.rxjava3.core.Single<WeComResponse>	modIntent(UpdateIntentRequest request) 修改问答

Method Detail

addGroup

@POST(value="kf/knowledge/add_group")
io.reactivex.rxjava3.core.Single<WeComResponse> addGroup(@Body
                                                                                               Name name)

添加分组

可通过此接口创建新的知识库分组。

Parameters:

name - the name

Returns:

the we com response

delGroup

@POST(value="kf/knowledge/del_group")
io.reactivex.rxjava3.core.Single<WeComResponse> delGroup(@Body
                                                                                               GroupId groupId)

删除分组

可通过此接口删除已有的知识库分组，但不能删除系统创建的默认分组。

Parameters:

groupId - the group id

Returns:

the we com response

modGroup

@POST(value="kf/knowledge/mod_group")
io.reactivex.rxjava3.core.Single<WeComResponse> modGroup(@Body
                                                                                               KnowledgeGroup group)

修改分组

可通过此接口修改已有的知识库分组，但不能修改系统创建的默认分组。

Parameters:

group - the group

Returns:

the we com response

listGroup

@POST(value="kf/knowledge/list_group")
io.reactivex.rxjava3.core.Single<GroupsResponse> listGroup(@Body
                                                                                                  GroupsRequest request)

获取分组列表

可通过此接口分页获取所有的知识库分组。

Parameters:

request - the request

Returns:

the groups response

addIntent

@POST(value="kf/knowledge/add_intent")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> addIntent(@Body
                                                                                                           Intent intent)

添加问答

Parameters:

intent - the intent

Returns:

the groups response

delIntent

@POST(value="kf/knowledge/del_intent")
io.reactivex.rxjava3.core.Single<WeComResponse> delIntent(@Body
                                                                                                 IntentId intentId)

删除问答

Parameters:

intentId - the intent id

Returns:

the we com response

modIntent

@POST(value="kf/knowledge/mod_intent")
io.reactivex.rxjava3.core.Single<WeComResponse> modIntent(@Body
                                                                                                 UpdateIntentRequest request)

修改问答

可以按需更新，但更新的每一部分是覆盖写，需要传完整的字段。

Parameters:

request - the request

Returns:

the we com response

listIntent

@POST(value="kf/knowledge/list_intent")
io.reactivex.rxjava3.core.Single<IntentsResponse> listIntent(@Body
                                                                                                     IntentsRequest request)

获取问答列表

Parameters:

request - the request

Returns:

the we com response