me.chanjar.weixin.mp.api.impl

## 类 WxMpKefuServiceImpl

- java.lang.Object
- - me.chanjar.weixin.mp.api.impl.WxMpKefuServiceImpl

所有已实现的接口:
  WxMpKefuService

    public class WxMpKefuServiceImpl
    extends Object
    implements WxMpKefuService

作者:
  Binary Wang

### 字段概要

字段
`protected org.slf4j.Logger` `log`

### 构造器概要

构造器
构造器和说明
`WxMpKefuServiceImpl(WxMpService wxMpService)`

### 方法概要

方法

`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)` 发送客服消息 详情请见:

### 从类继承的方法 java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### 字段详细资料

#### log

    protected final org.slf4j.Logger log

### 构造器详细资料

#### WxMpKefuServiceImpl

    public WxMpKefuServiceImpl(WxMpService wxMpService)

### 方法详细资料

#### sendKefuMessage

    public boolean sendKefuMessage(WxMpKefuMessage message)
                            throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `sendKefuMessage` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfList

    public WxMpKfList kfList()
                      throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfList` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfOnlineList

    public WxMpKfOnlineList kfOnlineList()
                                  throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfOnlineList` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfAccountAdd

    public boolean kfAccountAdd(WxMpKfAccountRequest request)
                         throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfAccountAdd` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfAccountUpdate

    public boolean kfAccountUpdate(WxMpKfAccountRequest request)
                            throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfAccountUpdate` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfAccountInviteWorker

    public boolean kfAccountInviteWorker(WxMpKfAccountRequest request)
                                  throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfAccountInviteWorker` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfAccountUploadHeadImg

    public boolean kfAccountUploadHeadImg(String kfAccount,
                                 File imgFile)
                                   throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfAccountUploadHeadImg` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfAccountDel

    public boolean kfAccountDel(String kfAccount)
                         throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfAccountDel` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfSessionCreate

    public boolean kfSessionCreate(String openid,
                          String kfAccount)
                            throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfSessionCreate` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfSessionClose

    public boolean kfSessionClose(String openid,
                         String kfAccount)
                           throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfSessionClose` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfSessionGet

    public WxMpKfSessionGetResult kfSessionGet(String openid)
                                        throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfSessionGet` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfSessionList

    public WxMpKfSessionList kfSessionList(String kfAccount)
                                    throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfSessionList` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfSessionGetWaitCase

    public WxMpKfSessionWaitCaseList kfSessionGetWaitCase()
                                                   throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfSessionGetWaitCase` 在接口中 `WxMpKefuService`
抛出:
  `WxErrorException`

#### kfMsgList

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

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfMsgList` 在接口中 `WxMpKefuService`
参数:
  `startTime` - 起始时间
  `endTime` - 结束时间
  `msgId` - 消息id顺序从小到大，从1开始
  `number` - 每次获取条数，最多10000条
返回:
  聊天记录对象
抛出:
  `WxErrorException`

#### kfMsgList

    public WxMpKfMsgList kfMsgList(Date startTime,
                          Date endTime)
                            throws WxErrorException

从接口复制的说明: `WxMpKefuService`

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

指定者:
  `kfMsgList` 在接口中 `WxMpKefuService`
参数:
  `startTime` - 起始时间
  `endTime` - 结束时间
返回:
  聊天记录对象
抛出:
  `WxErrorException`