CustomProxy (weixin-mp 1.5.0 API)

java.lang.Object
- cn.ipokerface.weixin.proxy.AbstractProxy
- - cn.ipokerface.weixin.mp.proxy.MPlatformProxy
  - - cn.ipokerface.weixin.mp.proxy.CustomProxy

```
public class CustomProxy
extends MPlatformProxy
```
Created by PokerFace Create Date 2019-12-28. Email: 214888341@163.com Version 1.0.0
Description:

字段概要
- 从类继承的字段 cn.ipokerface.weixin.mp.proxy.MPlatformProxy
  tokenManager
- 从类继承的字段 cn.ipokerface.weixin.proxy.AbstractProxy
  weixinRequestClient

构造器概要

构造器
构造器和说明

CustomProxy(TokenManager tokenManager)

构造器
构造器和说明
`CustomProxy(TokenManager tokenManager)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`ApiResult`	`closeCustomSession(String userOpenId, String kfAccount, String text)` 关闭会话
`ApiResult`	`createCustomAccount(String id, String name)` 新增客服账号
`ApiResult`	`createCustomSession(String userOpenId, String kfAccount, String text)` 创建会话开发者可以使用本接口，为多客服的客服工号创建会话，将某个客户直接指定给客服工号接待，需要注意此接口不会受客服自动接入数以及自动接入开关限制。
`ApiResult`	`deleteCustomAccount(String id)` 删除客服账号
`List<CustomChatRecord>`	`getCustomChatRecord(Date startTime, Date endTime, int number)` 客服聊天记录
`CustomChatSession`	`getCustomSession(String userOpenId)` 获取客户的会话状态:获取客户当前的会话状态。
`ApiResult`	`inviteCustomAccount(String kfAccount, String inviteAccount)` 邀请绑定客服帐号新添加的客服帐号是不能直接使用的，只有客服人员用微信号绑定了客服账号后，方可登录Web客服进行操作。
`List<CustomAccount>`	`listCustomAccount()` 获取公众号中所设置的客服基本信息，包括客服工号、客服昵称、客服登录账号
`List<CustomChatSession>`	`listCustomSession(String kfAccount)` 获取客服的会话列表:获取某个客服正在接待的会话列表。
`CustomChatSession.CustomChatSessionCounter`	`listCustomWaitSession()` 获取未接入会话列表:获取当前正在等待队列中的会话列表，此接口最多返回最早进入队列的100个未接入会话。
`List<CustomOnlineAccount>`	`listOnlineCustomAccount()` 获取在线客服在线状态（手机在线、PC客户端在线、手机和PC客户端全都在线）、客服自动接入最大值、客服当前接待客户数
`ApiResult`	`updateCustomAccount(String id, String name)` 更新客服账号
`ApiResult`	`uploadCustomAvatar(String accountId, InputStream is, String fileName)` 上传客服头像

从类继承的方法 cn.ipokerface.weixin.mp.proxy.MPlatformProxy
getTokenManager

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CustomProxy
```
public CustomProxy(TokenManager tokenManager)
```
- 方法详细资料
  - getCustomChatRecord
```
public List<CustomChatRecord> getCustomChatRecord(Date startTime,
                                                  Date endTime,
                                                  int number)
                                           throws WeixinException
```
    客服聊天记录
    
    参数:
    
    startTime - 查询开始时间
    
    endTime - 查询结束时间每次查询不能跨日查询
    
    number - 最多10000条
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    CustomChatRecord, 查询客服聊天记录, 查询客服聊天记录
  - listCustomAccount
```
public List<CustomAccount> listCustomAccount()
                                      throws WeixinException
```
    获取公众号中所设置的客服基本信息，包括客服工号、客服昵称、客服登录账号
    
    返回:
    
    多客服信息列表
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    CustomAccount, 获取客服基本信息
  - listOnlineCustomAccount
```
public List<CustomOnlineAccount> listOnlineCustomAccount()
                                                  throws WeixinException
```
    获取在线客服在线状态（手机在线、PC客户端在线、手机和PC客户端全都在线）、客服自动接入最大值、客服当前接待客户数
    
    返回:
    
    多客服在线信息列表
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    CustomOnlineAccount, 获取客服在线信息
  - createCustomAccount
```
public ApiResult createCustomAccount(String id,
                                     String name)
                              throws WeixinException
```
    新增客服账号
    
    参数:
    
    id - 完整客服账号，格式为：账号前缀@公众号微信号，账号前缀最多10个字符，必须是英文或者数字字符。如果没有公众号微信号，请前往微信公众平台设置。
    
    name - 客服昵称，最长6个汉字或12个英文字符
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    新增客服账号
  - updateCustomAccount
```
public ApiResult updateCustomAccount(String id,
                                     String name)
                              throws WeixinException
```
    更新客服账号
    
    参数:
    
    id - 完整客服账号，格式为：账号前缀@公众号微信号，账号前缀最多10个字符，必须是英文或者数字字符。如果没有公众号微信号，请前往微信公众平台设置。
    
    name - 客服昵称，最长6个汉字或12个英文字符
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    新增客服账号
  - inviteCustomAccount
```
public ApiResult inviteCustomAccount(String kfAccount,
                                     String inviteAccount)
                              throws WeixinException
```
    邀请绑定客服帐号新添加的客服帐号是不能直接使用的，只有客服人员用微信号绑定了客服账号后，方可登录Web客服进行操作。此接口发起一个绑定邀请到客服人员微信号，客服人员需要在微信客户端上用该微信号确认后帐号才可用。尚未绑定微信号的帐号可以进行绑定邀请操作，邀请未失效时不能对该帐号进行再次绑定微信号邀请。
    
    参数:
    
    kfAccount - 完整客服帐号，格式为：帐号前缀@公众号微信号
    
    inviteAccount - 接收绑定邀请的客服微信号
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
  - uploadCustomAvatar
```
public ApiResult uploadCustomAvatar(String accountId,
                                    InputStream is,
                                    String fileName)
                             throws WeixinException
```
    上传客服头像
    
    参数:
    
    accountId - 完整客服账号，格式为：账号前缀@公众号微信号
    
    is - 头像图片文件必须是jpg格式，推荐使用640*640大小的图片以达到最佳效果
    
    fileName - 文件名为空时将自动生成
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    上传客服头像
  - deleteCustomAccount
```
public ApiResult deleteCustomAccount(String id)
                              throws WeixinException
```
    删除客服账号
    
    参数:
    
    id - 完整客服账号，格式为：账号前缀@公众号微信号
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    删除客服账号
  - createCustomSession
```
public ApiResult createCustomSession(String userOpenId,
                                     String kfAccount,
                                     String text)
                              throws WeixinException
```
    创建会话
    开发者可以使用本接口，为多客服的客服工号创建会话，将某个客户直接指定给客服工号接待，需要注意此接口不会受客服自动接入数以及自动接入开关限制。只能为在线的客服（PC客户端在线，或者已绑定多客服助手）创建会话。
    
    参数:
    
    userOpenId - 用户的userOpenId
    
    kfAccount - 完整客服账号，格式为：账号前缀@公众号微信号
    
    text - 附加信息，文本会展示在客服人员的多客服客户端
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    创建会话
  - closeCustomSession
```
public ApiResult closeCustomSession(String userOpenId,
                                    String kfAccount,
                                    String text)
                             throws WeixinException
```
    关闭会话
    
    参数:
    
    userOpenId - 用户的userOpenId
    
    kfAccount - 完整客服账号，格式为：账号前缀@公众号微信号
    
    text - 附加信息，文本会展示在客服人员的多客服客户端
    
    返回:
    
    处理结果
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    关闭会话
  - getCustomSession
```
public CustomChatSession getCustomSession(String userOpenId)
                                   throws WeixinException
```
    获取客户的会话状态:获取客户当前的会话状态。
    
    参数:
    
    userOpenId - 用户的openid
    
    返回:
    
    会话对象
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    CustomChatSession, 获取会话状态
  - listCustomSession
```
public List<CustomChatSession> listCustomSession(String kfAccount)
                                          throws WeixinException
```
    获取客服的会话列表:获取某个客服正在接待的会话列表。
    
    参数:
    
    kfAccount - 完整客服账号，格式为：账号前缀@公众号微信号，账号前缀最多10个字符，必须是英文或者数字字符。
    
    返回:
    
    会话列表
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    CustomChatSession, 获取客服的会话列表
  - listCustomWaitSession
```
public CustomChatSession.CustomChatSessionCounter listCustomWaitSession()
                                                                 throws WeixinException
```
    获取未接入会话列表:获取当前正在等待队列中的会话列表，此接口最多返回最早进入队列的100个未接入会话。缺陷：没有count字段
    
    返回:
    
    会话列表
    
    抛出:
    
    WeixinException
    
    另请参阅:
    
    CustomChatSession, CustomChatSession.CustomChatSessionCounter, 获取客服的会话列表

类 CustomProxy

字段概要

从类继承的字段 cn.ipokerface.weixin.mp.proxy.MPlatformProxy

从类继承的字段 cn.ipokerface.weixin.proxy.AbstractProxy

构造器概要

方法概要

从类继承的方法 cn.ipokerface.weixin.mp.proxy.MPlatformProxy

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

构造器详细资料

CustomProxy

方法详细资料

getCustomChatRecord

listCustomAccount

listOnlineCustomAccount

createCustomAccount

updateCustomAccount

inviteCustomAccount

uploadCustomAvatar

deleteCustomAccount

createCustomSession

closeCustomSession

getCustomSession

listCustomSession

listCustomWaitSession