me.chanjar.weixin.mp.api

接口 WxMpKefuService

所有已知实现类:

WxMpKefuServiceImpl

public interface WxMpKefuService

 客服接口.
 注意：命名采用kefu拼音的原因是：其英文CustomerService如果再加上Service后缀显得有点啰嗦，如果不加又显得表意不完整。
 

作者:

Binary Wang

方法概要

限定符和类型	方法和说明
boolean	kfAccountAdd(WxMpKfAccountRequest request) 添加客服账号 详情请见：	boolean	kfAccountDel(String kfAccount) 删除客服账号 详情请见：	boolean	kfAccountInviteWorker(WxMpKfAccountRequest request) 设置客服信息（即更新客服信息） 详情请见：	boolean	kfAccountUpdate(WxMpKfAccountRequest request) 设置客服信息（即更新客服信息） 详情请见：	boolean	kfAccountUploadHeadImg(String kfAccount, File imgFile) 上传客服头像 详情请见：	WxMpKfList	kfList() 获取客服基本信息 详情请见：	WxMpKfMsgList	kfMsgList(Date startTime, Date endTime) 获取聊天记录（优化接口，返回指定时间段内所有的聊天记录） 此接口返回的聊天记录中，对于图片、语音、视频，分别展示成文本格式的[image]、[voice]、[video] 详情请见：	WxMpKfMsgList	kfMsgList(Date startTime, Date endTime, Long msgId, Integer number) 获取聊天记录（原始接口） 此接口返回的聊天记录中，对于图片、语音、视频，分别展示成文本格式的[image]、[voice]、[video] 详情请见：	WxMpKfOnlineList	kfOnlineList() 获取在线客服接待信息 详情请见：	boolean	kfSessionClose(String openid, String kfAccount) 关闭会话 开发者可以使用本接口，关闭一个会话。
boolean	kfSessionCreate(String openid, String kfAccount) 创建会话 此接口在客服和用户之间创建一个会话，如果该客服和用户会话已存在，则直接返回0。
WxMpKfSessionGetResult	kfSessionGet(String openid) 获取客户的会话状态 此接口获取一个客户的会话，如果不存在，则kf_account为空。
WxMpKfSessionWaitCaseList	kfSessionGetWaitCase() 获取未接入会话列表 开发者可以通过本接口获取当前正在等待队列中的会话列表，此接口最多返回最早进入队列的100个未接入会话。
WxMpKfSessionList	kfSessionList(String kfAccount) 获取客服的会话列表 开发者可以通过本接口获取某个客服正在接待的会话列表。
boolean	sendKefuMessage(WxMpKefuMessage message) 发送客服消息 详情请见: 发送客服消息 接口url格式：https://api.weixin.qq.com/cgi-bin/message/custom/send?
String	sendKefuMessageWithResponse(WxMpKefuMessage message) 发送客服消息 详情请见: 发送客服消息 接口url格式：https://api.weixin.qq.com/cgi-bin/message/custom/send?
boolean	sendKfTypingState(String openid, String command) 客服输入状态 开发者可通过调用“客服输入状态”接口，返回客服当前输入状态给用户。

方法详细资料

sendKefuMessage

boolean sendKefuMessage(WxMpKefuMessage message)
                 throws WxErrorException

 发送客服消息
 详情请见: 发送客服消息
 接口url格式：https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
 

参数:

message - the message

返回:

the boolean

抛出:

WxErrorException - 异常

sendKefuMessageWithResponse

String sendKefuMessageWithResponse(WxMpKefuMessage message)
                            throws WxErrorException

 发送客服消息
 详情请见: 发送客服消息
 接口url格式：https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
 

参数:

message - the message

返回:

the response

抛出:

WxErrorException - 异常

kfList

WxMpKfList kfList()
           throws WxErrorException

 获取客服基本信息
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN
 

返回:

the wx mp kf list

抛出:

WxErrorException - 异常

kfOnlineList

WxMpKfOnlineList kfOnlineList()
                       throws WxErrorException

 获取在线客服接待信息
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN
 

返回:

the wx mp kf online list

抛出:

WxErrorException - 异常

kfAccountAdd

boolean kfAccountAdd(WxMpKfAccountRequest request)
              throws WxErrorException

 添加客服账号
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN
 

参数:

request - the request

返回:

the boolean

抛出:

WxErrorException - 异常

kfAccountUpdate

boolean kfAccountUpdate(WxMpKfAccountRequest request)
                 throws WxErrorException

 设置客服信息（即更新客服信息）
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN
 

参数:

request - the request

返回:

the boolean

抛出:

WxErrorException - the wx error exception

kfAccountInviteWorker

boolean kfAccountInviteWorker(WxMpKfAccountRequest request)
                       throws WxErrorException

 设置客服信息（即更新客服信息）
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/customservice/kfaccount/inviteworker?access_token=ACCESS_TOKEN
 

参数:

request - the request

返回:

the boolean

抛出:

WxErrorException - 异常

kfAccountUploadHeadImg

boolean kfAccountUploadHeadImg(String kfAccount,
                               File imgFile)
                        throws WxErrorException

 上传客服头像
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
 

参数:

kfAccount - the kf account

imgFile - the img file

返回:

the boolean

抛出:

WxErrorException - 异常

kfAccountDel

boolean kfAccountDel(String kfAccount)
              throws WxErrorException

 删除客服账号
 详情请见：客服管理
 接口url格式：https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
 

参数:

kfAccount - the kf account

返回:

the boolean

抛出:

WxErrorException - 异常

kfSessionCreate

boolean kfSessionCreate(String openid,
                        String kfAccount)
                 throws WxErrorException

 创建会话
 此接口在客服和用户之间创建一个会话，如果该客服和用户会话已存在，则直接返回0。指定的客服账号必须已经绑定微信号且在线。
 详情请见：客服会话控制接口
 接口url格式： https://api.weixin.qq.com/customservice/kfsession/create?access_token=ACCESS_TOKEN
 

参数:

openid - the openid

kfAccount - the kf account

返回:

the boolean

抛出:

WxErrorException - 异常

kfSessionClose

boolean kfSessionClose(String openid,
                       String kfAccount)
                throws WxErrorException

 关闭会话
 开发者可以使用本接口，关闭一个会话。
 详情请见：客服会话控制接口
 接口url格式： https://api.weixin.qq.com/customservice/kfsession/close?access_token=ACCESS_TOKEN
 

参数:

openid - the openid

kfAccount - the kf account

返回:

the boolean

抛出:

WxErrorException - 异常

kfSessionGet

WxMpKfSessionGetResult kfSessionGet(String openid)
                             throws WxErrorException

 获取客户的会话状态
 此接口获取一个客户的会话，如果不存在，则kf_account为空。
 详情请见：客服会话控制接口
 接口url格式： https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID
 

参数:

openid - the openid

返回:

the wx mp kf session get result

抛出:

WxErrorException - 异常

kfSessionList

WxMpKfSessionList kfSessionList(String kfAccount)
                         throws WxErrorException

 获取客服的会话列表
 开发者可以通过本接口获取某个客服正在接待的会话列表。
 详情请见：客服会话控制
 接口url格式： https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
 

参数:

kfAccount - the kf account

返回:

the wx mp kf session list

抛出:

WxErrorException - 异常

kfSessionGetWaitCase

WxMpKfSessionWaitCaseList kfSessionGetWaitCase()
                                        throws WxErrorException

 获取未接入会话列表
 开发者可以通过本接口获取当前正在等待队列中的会话列表，此接口最多返回最早进入队列的100个未接入会话。
 详情请见：客服会话控制
 接口url格式： https://api.weixin.qq.com/customservice/kfsession/getwaitcase?access_token=ACCESS_TOKEN
 

返回:

the wx mp kf session wait case list

抛出:

WxErrorException - 异常

kfMsgList

WxMpKfMsgList kfMsgList(Date startTime,
                        Date endTime,
                        Long msgId,
                        Integer number)
                 throws WxErrorException

 获取聊天记录（原始接口）
 此接口返回的聊天记录中，对于图片、语音、视频，分别展示成文本格式的[image]、[voice]、[video]
 详情请见：获取聊天记录
 接口url格式： https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN
 

参数:

startTime - 起始时间

endTime - 结束时间

msgId - 消息id顺序从小到大，从1开始

number - 每次获取条数，最多10000条

返回:

聊天记录对象 wx mp kf msg list

抛出:

WxErrorException - 异常

kfMsgList

WxMpKfMsgList kfMsgList(Date startTime,
                        Date endTime)
                 throws WxErrorException

 获取聊天记录（优化接口，返回指定时间段内所有的聊天记录）
 此接口返回的聊天记录中，对于图片、语音、视频，分别展示成文本格式的[image]、[voice]、[video]
 详情请见：获取聊天记录
 接口url格式： https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN
 

参数:

startTime - 起始时间

endTime - 结束时间

返回:

聊天记录对象 wx mp kf msg list

抛出:

WxErrorException - 异常

sendKfTypingState

boolean sendKfTypingState(String openid,
                          String command)
                   throws WxErrorException

 客服输入状态
 开发者可通过调用“客服输入状态”接口，返回客服当前输入状态给用户。
 此接口需要客服消息接口权限。
 如果不满足发送客服消息的触发条件，则无法下发输入状态。
 下发输入状态，需要客服之前30秒内跟用户有过消息交互。
 在输入状态中（持续15s），不可重复下发输入态。
 在输入状态中，如果向用户下发消息，会同时取消输入状态。

 详情请见：客服输入状态
 接口url格式：https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN
 

参数:

openid - 用户id

command - "Typing"：对用户下发“正在输入"状态 "CancelTyping"：取消对用户的”正在输入"状态

返回:

the boolean

抛出:

WxErrorException - 异常