cn.felord.reactive.api

Interface KfSessionApi

public interface KfSessionApi

会话分配与消息收发

Since:

2021 /7/23 13:52

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<KfSessionResponse>	getSessionState(KfAndExternalUser kfAndExternalUser) 获取会话状态
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	sendEventMsg(KfEventMessageRequest request) 发送欢迎语等事件响应消息
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	sendMsg(KfMessageRequest request) 发送消息
io.reactivex.rxjava3.core.Single<SyncMsgResponse>	syncMsg(SyncMsgRequest request) 读取消息
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	trans(KfSessionUpdateRequest request) 变更会话状态

Method Detail

getSessionState

@POST(value="kf/service_state/get")
io.reactivex.rxjava3.core.Single<KfSessionResponse> getSessionState(@Body
                                                                                                        KfAndExternalUser kfAndExternalUser)

获取会话状态

Parameters:

kfAndExternalUser - the kf and external user

Returns:

the generic response

trans

@POST(value="kf/service_state/trans")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> trans(@Body
                                                                                                      KfSessionUpdateRequest request)

变更会话状态

Parameters:

request - the request

Returns:

the we com response

syncMsg

@POST(value="kf/sync_msg")
io.reactivex.rxjava3.core.Single<SyncMsgResponse> syncMsg(@Body
                                                                                     SyncMsgRequest request)

读取消息

Parameters:

request - the request

Returns:

the sync msg response

sendMsg

@POST(value="kf/send_msg")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> sendMsg(@Body
                                                                                             KfMessageRequest request)

发送消息

当微信客户处于“新接入待处理”或“由智能助手接待”状态下，可调用该接口给用户发送消息。 注意仅当微信客户在主动发送消息给客服后的48小时内，企业可发送消息给客户，最多可发送5条消息；若用户继续发送消息，企业可再次下发消息。 支持发送消息类型：文本、图片、语音、视频、文件、图文、小程序、菜单消息、地理位置。

Parameters:

request - the request

Returns:

the generic response

sendEventMsg

@POST(value="kf/send_msg_on_event")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> sendEventMsg(@Body
                                                                                                           KfEventMessageRequest request)

发送欢迎语等事件响应消息

当特定的事件回调消息包含code字段，或通过接口变更到特定的会话状态，会返回code字段。 开发者可以此code为凭证，调用该接口给用户发送相应事件场景下的消息，如客服欢迎语、客服提示语和会话结束语等。 除"用户进入会话事件"以外，响应消息仅支持会话处于获取该code的会话状态时发送，如将会话转入待接入池时获得的code仅能在会话状态为”待接入池排队中“时发送。

Parameters:

request - the request

Returns:

the generic response