WxCpExternalContactServiceImpl (WxJava

java.lang.Object
- me.chanjar.weixin.cp.api.impl.WxCpExternalContactServiceImpl

所有已实现的接口:: WxCpExternalContactService

public class WxCpExternalContactServiceImpl
extends Object
implements WxCpExternalContactService

作者:: 曹祖鹏 & yuanqixun

构造器概要

构造器
构造器和说明

WxCpExternalContactServiceImpl()

构造器
构造器和说明
`WxCpExternalContactServiceImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`WxCpContactWayResult`	`addContactWay(@NonNull WxCpContactWayInfo info)` 配置客户联系「联系我」方式企业可以在管理后台-客户联系中配置成员的「联系我」的二维码或者小程序按钮，客户通过扫描二维码或点击小程序上的按钮，即可获取成员联系方式，主动联系到成员。
`WxCpUserExternalTagGroupInfo`	`addCorpTag(WxCpUserExternalTagGroupInfo tagGroup)` 企业可通过此接口向客户标签库中添加新的标签组和标签，每个企业最多可配置3000个企业标签。
`WxCpMsgTemplateAddResult`	`addMsgTemplate(WxCpMsgTemplate wxCpMsgTemplate)` 添加企业群发消息任务企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。
`WxCpBaseResp`	`closeTempChat(@NonNull String userId, @NonNull String externalUserId)` 结束临时会话将指定的企业成员和客户之前的临时会话断开，断开前会自动下发已配置的结束语。
`WxCpBaseResp`	`delCorpTag(String[] tagId, String[] groupId)` 企业可通过此接口删除客户标签库中的标签，或删除整个标签组。
`WxCpBaseResp`	`deleteContactWay(@NonNull String configId)` 删除企业已配置的「联系我」方式删除一个已配置的「联系我」二维码或者「联系我」小程序按钮。
`WxCpBaseResp`	`editCorpTag(String id, String name, Integer order)` 企业可通过此接口编辑客户标签/标签组的名称或次序值。
`WxCpExternalContactInfo`	`getContactDetail(String userId)` 获取客户详情.
`WxCpExternalContactBatchInfo`	`getContactDetailBatch(String userId, String cursor, Integer limit)` 批量获取客户详情.
`WxCpContactWayInfo`	`getContactWay(@NonNull String configId)` 获取企业已配置的「联系我」方式批量获取企业配置的「联系我」二维码和「联系我」小程序按钮。
`WxCpUserExternalTagGroupList`	`getCorpTagList(String[] tagId)` 企业可通过此接口获取企业客户标签详情。
`WxCpExternalContactInfo`	`getExternalContact(String userId)` 获取外部联系人详情.
`WxCpUserExternalGroupChatInfo`	`getGroupChat(String chatId)` 通过客户群ID，获取详情。
`WxCpUserExternalGroupChatStatistic`	`getGroupChatStatistic(Date startTime, Integer orderBy, Integer orderAsc, Integer pageIndex, Integer pageSize, String[] userIds, String[] partyIds)` 获取指定日期全天的统计数据。
`WxCpUserExternalUserBehaviorStatistic`	`getUserBehaviorStatistic(Date startTime, Date endTime, String[] userIds, String[] partyIds)` 企业可通过此接口获取成员联系客户的数据，包括发起申请数、新增客户数、聊天数、发送消息数和删除/拉黑成员的客户数等指标。
`List<String>`	`listExternalContacts(String userId)` 获取客户列表.
`List<String>`	`listFollowers()` 企业和第三方服务商可通过此接口获取配置了客户联系功能的成员(Customer Contact)列表。
`WxCpUserExternalGroupChatList`	`listGroupChat(Integer pageIndex, Integer pageSize, int status, String[] userIds, String[] partyIds)` 该接口用于获取配置过客户群管理的客户群列表。
`WxCpUserExternalUnassignList`	`listUnassignedList(Integer pageIndex, Integer pageSize)` 企业和第三方可通过此接口，获取所有离职成员的客户列表，并可进一步调用离职成员的外部联系人再分配接口将这些客户重新分配给其他企业成员。
`WxCpBaseResp`	`markTag(String userid, String externalUserid, String[] addTag, String[] removeTag)` 企业可通过此接口为指定成员的客户添加上由企业统一配置的标签。
`void`	`sendWelcomeMsg(WxCpWelcomeMsg msg)` 发送新客户欢迎语企业微信在向企业推送添加外部联系人事件时，会额外返回一个welcome_code，企业以此为凭据调用接口，即可通过成员向新添加的客户发送个性化的欢迎语。
`WxCpBaseResp`	`transferExternalContact(String externalUserid, String handOverUserid, String takeOverUserid)` 企业可通过此接口，将已离职成员的外部联系人分配给另一个成员接替联系。
`WxCpBaseResp`	`updateContactWay(@NonNull WxCpContactWayInfo info)` 更新企业已配置的「联系我」方式更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息，如使用人员和备注等。
`void`	`updateRemark(WxCpUpdateRemarkRequest request)` 修改客户备注信息.

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

构造器详细资料
- WxCpExternalContactServiceImpl
```
public WxCpExternalContactServiceImpl()
```

方法详细资料

addContactWay

public WxCpContactWayResult addContactWay(@NonNull
                                          @NonNull WxCpContactWayInfo info)
                                   throws WxErrorException

从接口复制的说明: WxCpExternalContactService

配置客户联系「联系我」方式

 企业可以在管理后台-客户联系中配置成员的「联系我」的二维码或者小程序按钮，客户通过扫描二维码或点击小程序上的按钮，即可获取成员联系方式，主动联系到成员。
 企业可通过此接口为具有客户联系功能的成员生成专属的「联系我」二维码或者「联系我」按钮。
 如果配置的是「联系我」按钮，需要开发者的小程序接入小程序插件。

 注意:
 通过API添加的「联系我」不会在管理端进行展示，每个企业可通过API最多配置50万个「联系我」。
 用户需要妥善存储返回的config_id，config_id丢失可能导致用户无法编辑或删除「联系我」。
 临时会话模式不占用「联系我」数量，但每日最多添加10万个，并且仅支持单人。
 临时会话模式的二维码，添加好友完成后该二维码即刻失效。

指定者:: addContactWay 在接口中 WxCpExternalContactService
参数:: info - 客户联系「联系我」方式
返回:: wx cp contact way result
抛出:: WxErrorException - the wx error exception

getContactWay
```
public WxCpContactWayInfo getContactWay(@NonNull
                                        @NonNull String configId)
                                 throws WxErrorException
```
从接口复制的说明: WxCpExternalContactService
获取企业已配置的「联系我」方式
```
 批量获取企业配置的「联系我」二维码和「联系我」小程序按钮。
 
```
指定者:

getContactWay 在接口中 WxCpExternalContactService

参数:

configId - 联系方式的配置id,必填

返回:

contact way

抛出:

WxErrorException - the wx error exception

updateContactWay

public WxCpBaseResp updateContactWay(@NonNull
                                     @NonNull WxCpContactWayInfo info)
                              throws WxErrorException

从接口复制的说明: WxCpExternalContactService

更新企业已配置的「联系我」方式

 更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息，如使用人员和备注等。

指定者:: updateContactWay 在接口中 WxCpExternalContactService
参数:: info - 客户联系「联系我」方式
返回:: wx cp base resp
抛出:: WxErrorException - the wx error exception

deleteContactWay
```
public WxCpBaseResp deleteContactWay(@NonNull
                                     @NonNull String configId)
                              throws WxErrorException
```
从接口复制的说明: WxCpExternalContactService
删除企业已配置的「联系我」方式
```
 删除一个已配置的「联系我」二维码或者「联系我」小程序按钮。
 
```
指定者:

deleteContactWay 在接口中 WxCpExternalContactService

参数:

configId - 企业联系方式的配置id,必填

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

closeTempChat

public WxCpBaseResp closeTempChat(@NonNull
                                  @NonNull String userId,
                                  @NonNull
                                  @NonNull String externalUserId)
                           throws WxErrorException

从接口复制的说明: WxCpExternalContactService

结束临时会话

 将指定的企业成员和客户之前的临时会话断开，断开前会自动下发已配置的结束语。

 注意：请保证传入的企业成员和客户之间有仍然有效的临时会话, 通过其他方式的添加外部联系人无法通过此接口关闭会话。

指定者:: closeTempChat 在接口中 WxCpExternalContactService
参数:: userId - the user id; externalUserId - the external user id
返回:: wx cp base resp
抛出:: WxErrorException - the wx error exception

getExternalContact

public WxCpExternalContactInfo getExternalContact(String userId)
                                           throws WxErrorException

从接口复制的说明: WxCpExternalContactService

获取外部联系人详情.

   企业可通过此接口，根据外部联系人的userid，拉取外部联系人详情。权限说明：
 企业需要使用外部联系人管理secret所获取的accesstoken来调用
 第三方应用需拥有“企业客户”权限。
 第三方应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。

指定者:: getExternalContact 在接口中 WxCpExternalContactService
参数:: userId - 外部联系人的userid
返回:: . external contact
抛出:: WxErrorException - the wx error exception

getContactDetail

public WxCpExternalContactInfo getContactDetail(String userId)
                                         throws WxErrorException

从接口复制的说明: WxCpExternalContactService

获取客户详情.


 企业可通过此接口，根据外部联系人的userid（如何获取?），拉取客户详情。

 请求方式：GET（HTTPS）
 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID

 权限说明：

 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）；
 第三方/自建应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。

指定者:: getContactDetail 在接口中 WxCpExternalContactService
参数:: userId - 外部联系人的userid，注意不是企业成员的帐号
返回:: . contact detail
抛出:: WxErrorException - .

getContactDetailBatch

public WxCpExternalContactBatchInfo getContactDetailBatch(String userId,
                                                          String cursor,
                                                          Integer limit)
                                                   throws WxErrorException

从接口复制的说明: WxCpExternalContactService

批量获取客户详情.


 企业/第三方可通过此接口获取指定成员添加的客户信息列表。

 请求方式：POST（HTTPS）
 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch/get_by_user?access_token=ACCESS_TOKEN

 权限说明：

 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）；
 第三方/自建应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。

指定者:: getContactDetailBatch 在接口中 WxCpExternalContactService
参数:: userId - 企业成员的userid，注意不是外部联系人的帐号; cursor - the cursor; limit - the limit
返回:: wx cp user external contact batch info
抛出:: WxErrorException - .

updateRemark

public void updateRemark(WxCpUpdateRemarkRequest request)
                  throws WxErrorException

从接口复制的说明: WxCpExternalContactService

修改客户备注信息.

 企业可通过此接口修改指定用户添加的客户的备注信息。
 请求方式: POST(HTTP)
 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remark?access_token=ACCESS_TOKEN
 文档地址：https://work.weixin.qq.com/api/doc/90000/90135/92115

指定者:: updateRemark 在接口中 WxCpExternalContactService
参数:: request - 备注信息请求
抛出:: WxErrorException - .

listExternalContacts

public List<String> listExternalContacts(String userId)
                                  throws WxErrorException

从接口复制的说明: WxCpExternalContactService

获取客户列表.

   企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员，所添加的外部联系人将不会作为客户返回。

 请求方式：GET（HTTPS）
 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID

 权限说明：

 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）；
 第三方应用需拥有“企业客户”权限。
 第三方/自建应用只能获取到可见范围内的配置了客户联系功能的成员。

指定者:: listExternalContacts 在接口中 WxCpExternalContactService
参数:: userId - 企业成员的userid
返回:: List of External wx id
抛出:: WxErrorException - .

listFollowers

public List<String> listFollowers()
                           throws WxErrorException

从接口复制的说明: WxCpExternalContactService

企业和第三方服务商可通过此接口获取配置了客户联系功能的成员(Customer Contact)列表。

   企业需要使用外部联系人管理secret所获取的accesstoken来调用（accesstoken如何获取？）；
   第三方应用需拥有“企业客户”权限。
   第三方应用只能获取到可见范围内的配置了客户联系功能的成员

指定者:: listFollowers 在接口中 WxCpExternalContactService
返回:: List of CpUser id
抛出:: WxErrorException - .

listUnassignedList
```
public WxCpUserExternalUnassignList listUnassignedList(Integer pageIndex,
                                                       Integer pageSize)
                                                throws WxErrorException
```
从接口复制的说明: WxCpExternalContactService

企业和第三方可通过此接口，获取所有离职成员的客户列表，并可进一步调用离职成员的外部联系人再分配接口将这些客户重新分配给其他企业成员。

指定者:

listUnassignedList 在接口中 WxCpExternalContactService

参数:

pageIndex - the page

pageSize - the page size

返回:

wx cp user external unassign list

抛出:

WxErrorException - the wx error exception

transferExternalContact
```
public WxCpBaseResp transferExternalContact(String externalUserid,
                                            String handOverUserid,
                                            String takeOverUserid)
                                     throws WxErrorException
```
从接口复制的说明: WxCpExternalContactService

企业可通过此接口，将已离职成员的外部联系人分配给另一个成员接替联系。

指定者:

transferExternalContact 在接口中 WxCpExternalContactService

参数:

externalUserid - the external userid

handOverUserid - the hand over userid

takeOverUserid - the take over userid

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

listGroupChat

public WxCpUserExternalGroupChatList listGroupChat(Integer pageIndex,
                                                   Integer pageSize,
                                                   int status,
                                                   String[] userIds,
                                                   String[] partyIds)
                                            throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 该接口用于获取配置过客户群管理的客户群列表。
 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
 暂不支持第三方调用。
 微信文档：https://work.weixin.qq.com/api/doc/90000/90135/92119

指定者:: listGroupChat 在接口中 WxCpExternalContactService
参数:: pageIndex - the page index; pageSize - the page size; status - the status; userIds - the user ids; partyIds - the party ids
返回:: the wx cp user external group chat list
抛出:: WxErrorException - the wx error exception

getGroupChat

public WxCpUserExternalGroupChatInfo getGroupChat(String chatId)
                                           throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 通过客户群ID，获取详情。包括群名、群成员列表、群成员入群时间、入群方式。（客户群是由具有客户群使用权限的成员创建的外部群）
 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
 暂不支持第三方调用。
 微信文档：https://work.weixin.qq.com/api/doc/90000/90135/92122

指定者:: getGroupChat 在接口中 WxCpExternalContactService
参数:: chatId - the chat id
返回:: group chat
抛出:: WxErrorException - the wx error exception

getUserBehaviorStatistic

public WxCpUserExternalUserBehaviorStatistic getUserBehaviorStatistic(Date startTime,
                                                                      Date endTime,
                                                                      String[] userIds,
                                                                      String[] partyIds)
                                                               throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 企业可通过此接口获取成员联系客户的数据，包括发起申请数、新增客户数、聊天数、发送消息数和删除/拉黑成员的客户数等指标。
 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
 第三方应用需拥有“企业客户”权限。
 第三方/自建应用调用时传入的userid和partyid要在应用的可见范围内;

指定者:: getUserBehaviorStatistic 在接口中 WxCpExternalContactService
参数:: startTime - the start time; endTime - the end time; userIds - the user ids; partyIds - the party ids
返回:: user behavior statistic
抛出:: WxErrorException - the wx error exception

getGroupChatStatistic

public WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime,
                                                                Integer orderBy,
                                                                Integer orderAsc,
                                                                Integer pageIndex,
                                                                Integer pageSize,
                                                                String[] userIds,
                                                                String[] partyIds)
                                                         throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 获取指定日期全天的统计数据。注意，企业微信仅存储60天的数据。
 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
 暂不支持第三方调用。

指定者:: getGroupChatStatistic 在接口中 WxCpExternalContactService
参数:: startTime - the start time; orderBy - the order by; orderAsc - the order asc; pageIndex - the page index; pageSize - the page size; userIds - the user ids; partyIds - the party ids
返回:: group chat statistic
抛出:: WxErrorException - the wx error exception

addMsgTemplate
```
public WxCpMsgTemplateAddResult addMsgTemplate(WxCpMsgTemplate wxCpMsgTemplate)
                                        throws WxErrorException
```
从接口复制的说明: WxCpExternalContactService

添加企业群发消息任务企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。（注：企业微信终端需升级到2.7.5版本及以上）注意：调用该接口并不会直接发送消息给客户/客户群，需要相关的客服人员操作以后才会实际发送（客服人员的企业微信需要升级到2.7.5及以上版本）同一个企业每个自然月内仅可针对一个客户/客户群发送4条消息，超过限制的用户将会被忽略。
请求方式: POST(HTTP)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_msg_template?access_token=ACCESS_TOKEN
文档地址：https://work.weixin.qq.com/api/doc/90000/90135/92135

指定者:

addMsgTemplate 在接口中 WxCpExternalContactService

参数:

wxCpMsgTemplate - the wx cp msg template

返回:

the wx cp msg template add result

抛出:

WxErrorException - the wx error exception

sendWelcomeMsg

public void sendWelcomeMsg(WxCpWelcomeMsg msg)
                    throws WxErrorException

从接口复制的说明: WxCpExternalContactService

发送新客户欢迎语

 企业微信在向企业推送添加外部联系人事件时，会额外返回一个welcome_code，企业以此为凭据调用接口，即可通过成员向新添加的客户发送个性化的欢迎语。
 为了保证用户体验以及避免滥用，企业仅可在收到相关事件后20秒内调用，且只可调用一次。
 如果企业已经在管理端为相关成员配置了可用的欢迎语，则推送添加外部联系人事件时不会返回welcome_code。
 每次添加新客户时可能有多个企业自建应用/第三方应用收到带有welcome_code的回调事件，但仅有最先调用的可以发送成功。后续调用将返回41051（externaluser has started chatting）错误，请用户根据实际使用需求，合理设置应用可见范围，避免冲突。
 请求方式: POST(HTTP)

 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/send_welcome_msg?access_token=ACCESS_TOKEN

 文档地址：https://work.weixin.qq.com/api/doc/90000/90135/92137

指定者:: sendWelcomeMsg 在接口中 WxCpExternalContactService
参数:: msg - .
抛出:: WxErrorException - .

getCorpTagList
```
public WxCpUserExternalTagGroupList getCorpTagList(String[] tagId)
                                            throws WxErrorException
```
从接口复制的说明: WxCpExternalContactService
```
 企业可通过此接口获取企业客户标签详情。
 
```
指定者:

getCorpTagList 在接口中 WxCpExternalContactService

参数:

tagId - the tag id

返回:

corp tag list

抛出:

WxErrorException - the wx error exception

addCorpTag

public WxCpUserExternalTagGroupInfo addCorpTag(WxCpUserExternalTagGroupInfo tagGroup)
                                        throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 企业可通过此接口向客户标签库中添加新的标签组和标签，每个企业最多可配置3000个企业标签。
 暂不支持第三方调用。

指定者:: addCorpTag 在接口中 WxCpExternalContactService
参数:: tagGroup - the tag group
返回:: wx cp user external tag group info
抛出:: WxErrorException - the wx error exception

editCorpTag

public WxCpBaseResp editCorpTag(String id,
                                String name,
                                Integer order)
                         throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 企业可通过此接口编辑客户标签/标签组的名称或次序值。
 暂不支持第三方调用。

指定者:: editCorpTag 在接口中 WxCpExternalContactService
参数:: id - the id; name - the name; order - the order
返回:: wx cp base resp
抛出:: WxErrorException - the wx error exception

delCorpTag

public WxCpBaseResp delCorpTag(String[] tagId,
                               String[] groupId)
                        throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 企业可通过此接口删除客户标签库中的标签，或删除整个标签组。
 暂不支持第三方调用。

指定者:: delCorpTag 在接口中 WxCpExternalContactService
参数:: tagId - the tag id; groupId - the group id
返回:: wx cp base resp
抛出:: WxErrorException - the wx error exception

markTag

public WxCpBaseResp markTag(String userid,
                            String externalUserid,
                            String[] addTag,
                            String[] removeTag)
                     throws WxErrorException

从接口复制的说明: WxCpExternalContactService

 企业可通过此接口为指定成员的客户添加上由企业统一配置的标签。
 https://work.weixin.qq.com/api/doc/90000/90135/92117

指定者:: markTag 在接口中 WxCpExternalContactService
参数:: userid - the userid; externalUserid - the external userid; addTag - the add tag; removeTag - the remove tag
返回:: wx cp base resp
抛出:: WxErrorException - the wx error exception

类 WxCpExternalContactServiceImpl

构造器概要

方法概要

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

构造器详细资料

WxCpExternalContactServiceImpl

方法详细资料

addContactWay

getContactWay

updateContactWay

deleteContactWay

closeTempChat

getExternalContact

getContactDetail

getContactDetailBatch

updateRemark

listExternalContacts

listFollowers

listUnassignedList

transferExternalContact

listGroupChat

getGroupChat

getUserBehaviorStatistic

getGroupChatStatistic

addMsgTemplate

sendWelcomeMsg

getCorpTagList

addCorpTag

editCorpTag

delCorpTag

markTag