me.chanjar.weixin.cp.api

接口 WxCpExternalContactService

所有已知实现类:

WxCpExternalContactServiceImpl

public interface WxCpExternalContactService

 外部联系人管理接口，企业微信的外部联系人的接口和通讯录接口已经拆离
  Created by Joe Cao on 2019/6/14
 

作者:

JoeCao

方法概要

限定符和类型	方法和说明
WxCpContactWayResult	addContactWay(@NonNull WxCpContactWayInfo info) 配置客户联系「联系我」方式 企业可以在管理后台-客户联系中配置成员的「联系我」的二维码或者小程序按钮，客户通过扫描二维码或点击小程序上的按钮，即可获取成员联系方式，主动联系到成员。
WxCpUserExternalTagGroupInfo	addCorpTag(WxCpUserExternalTagGroupInfo tagGroup) 企业可通过此接口向客户标签库中添加新的标签组和标签，每个企业最多可配置3000个企业标签。
WxCpAddMomentResult	addMomentTask(WxCpAddMomentTask task) 企业和第三方应用可通过该接口创建客户朋友圈的发表任务。
WxCpMsgTemplateAddResult	addMsgTemplate(WxCpMsgTemplate wxCpMsgTemplate) 添加企业群发消息任务 企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。
WxCpBaseResp	closeTempChat(@NonNull String userId, @NonNull String externalUserId) 结束临时会话 将指定的企业成员和客户之前的临时会话断开，断开前会自动下发已配置的结束语。
String	convertToOpenid(String externalUserid) 企业和服务商可通过此接口，将微信外部联系人的userid转为微信openid，用于调用支付相关接口。
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[] userIdList, String cursor, Integer limit) 批量获取客户详情.
WxCpContactWayInfo	getContactWay(@NonNull String configId) 获取企业已配置的「联系我」方式 批量获取企业配置的「联系我」二维码和「联系我」小程序按钮。
WxCpUserExternalTagGroupList	getCorpTagList(String[] tagId) 企业可通过此接口获取企业客户标签详情。
WxCpUserExternalTagGroupList	getCorpTagList(String[] tagId, String[] groupId) 企业可通过此接口获取企业客户标签详情。
WxCpExternalContactInfo	getExternalContact(String userId) 已过时。 建议使用 getContactDetail(String)
WxCpUserExternalGroupChatInfo	getGroupChat(String chatId, Integer needName) 通过客户群ID，获取详情。
WxCpUserExternalGroupChatStatistic	getGroupChatStatistic(Date startTime, Integer orderBy, Integer orderAsc, Integer pageIndex, Integer pageSize, String[] userIds, String[] partyIds) 获取指定日期全天的统计数据。
WxCpGroupMsgListResult	getGroupMsgListV2(String chatType, @NonNull Date startTime, @NonNull Date endTime, String creator, Integer filterType, Integer limit, String cursor) 企业和第三方应用可通过此接口获取企业与成员的群发记录。
WxCpGroupMsgSendResult	getGroupMsgSendResult(String msgid, String userid, Integer limit, String cursor) 企业和第三方应用可通过此接口获取企业与成员的群发记录。
WxCpGroupMsgTaskResult	getGroupMsgTask(String msgid, Integer limit, String cursor) 获取群发成员发送任务列表。
WxCpGetMomentComments	getMomentComments(String momentId, String userId) 获取客户朋友圈全部的发表记录 获取客户朋友圈的互动数据 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
WxCpGetMomentCustomerList	getMomentCustomerList(String momentId, String userId, String cursor, Integer limit) 获取客户朋友圈全部的发表记录 获取客户朋友圈发表时选择的可见范围 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
WxCpGetMomentList	getMomentList(Long startTime, Long endTime, String creator, Integer filterType, String cursor, Integer limit) 获取客户朋友圈全部的发表记录 获取企业全部的发表列表 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
WxCpGetMomentSendResult	getMomentSendResult(String momentId, String userId, String cursor, Integer limit) 获取客户朋友圈全部的发表记录 获取客户朋友圈发表后的可见客户列表 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
WxCpGetMomentTask	getMomentTask(String momentId, String cursor, Integer limit) 获取客户朋友圈全部的发表记录 获取客户朋友圈企业发表的列表 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
WxCpGetMomentTaskResult	getMomentTaskResult(String jobId) 由于发表任务的创建是异步执行的，应用需要再调用该接口以获取创建的结果。
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) 已过时。 请使用 listGroupChat(Integer, String, int, String[])
WxCpUserExternalGroupChatList	listGroupChat(Integer limit, String cursor, int status, String[] userIds) 该接口用于获取配置过客户群管理的客户群列表。
WxCpUserExternalUnassignList	listUnassignedList(Integer page, Integer pageSize) 企业和第三方可通过此接口，获取所有离职成员的客户列表，并可进一步调用离职成员的外部联系人再分配接口将这些客户重新分配给其他企业成员。
WxCpBaseResp	markTag(String userid, String externalUserid, String[] addTag, String[] removeTag) 企业可通过此接口为指定成员的客户添加上由企业统一配置的标签。
WxCpUserTransferCustomerResp	resignedTransferCustomer(WxCpUserTransferCustomerReq req) 企业可通过此接口，分配离职成员的客户给其他成员。
WxCpUserTransferResultResp	resignedTransferResult(String handOverUserid, String takeOverUserid, String cursor) 企业和第三方可通过此接口查询离职成员的客户分配情况。
void	sendWelcomeMsg(WxCpWelcomeMsg msg) 发送新客户欢迎语 企业微信在向企业推送添加外部联系人事件时，会额外返回一个welcome_code，企业以此为凭据调用接口，即可通过成员向新添加的客户发送个性化的欢迎语。
WxCpUserTransferCustomerResp	transferCustomer(WxCpUserTransferCustomerReq req) 企业可通过此接口，转接在职成员的客户给其他成员。
WxCpBaseResp	transferExternalContact(String externalUserid, String handOverUserid, String takeOverUserid) 已过时。 此后续将不再更新维护, 建议使用 transferCustomer(WxCpUserTransferCustomerReq)
WxCpUserExternalGroupChatTransferResp	transferGroupChat(String[] chatIds, String newOwner) 企业可通过此接口，将已离职成员为群主的群，分配给另一个客服成员。
WxCpUserTransferResultResp	transferResult(String handOverUserid, String takeOverUserid, String cursor) 企业和第三方可通过此接口查询在职成员的客户转接情况。
String	unionidToExternalUserid(String unionid, String openid) 服务商为企业代开发微信小程序的场景，服务商可通过此接口，将微信客户的unionid转为external_userid。
WxCpBaseResp	updateContactWay(@NonNull WxCpContactWayInfo info) 更新企业已配置的「联系我」方式 更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息，如使用人员和备注等。
void	updateRemark(WxCpUpdateRemarkRequest request) 修改客户备注信息.

方法详细资料

addContactWay

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

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

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

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

参数:

info - 客户联系「联系我」方式

返回:

wx cp contact way result

抛出:

WxErrorException - the wx error exception

getContactWay

WxCpContactWayInfo getContactWay(@NonNull
                                 @NonNull String configId)
                          throws WxErrorException

获取企业已配置的「联系我」方式

 批量获取企业配置的「联系我」二维码和「联系我」小程序按钮。
 

参数:

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

返回:

contact way

抛出:

WxErrorException - the wx error exception

updateContactWay

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

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

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

参数:

info - 客户联系「联系我」方式

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

deleteContactWay

WxCpBaseResp deleteContactWay(@NonNull
                              @NonNull String configId)
                       throws WxErrorException

删除企业已配置的「联系我」方式

 删除一个已配置的「联系我」二维码或者「联系我」小程序按钮。
 

参数:

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

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

closeTempChat

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

结束临时会话

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

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

参数:

userId - the user id

externalUserId - the external user id

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

getExternalContact

@Deprecated
WxCpExternalContactInfo getExternalContact(String userId)
                                                 throws WxErrorException

已过时。 建议使用 getContactDetail(String)

获取外部联系人详情.

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

参数:

userId - 外部联系人的userid

返回:

. external contact

抛出:

WxErrorException - the wx error exception

getContactDetail

WxCpExternalContactInfo getContactDetail(String userId)
                                  throws WxErrorException

获取客户详情.

 企业可通过此接口，根据外部联系人的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仅包含应用可见范围之内的成员。
 

参数:

userId - 外部联系人的userid，注意不是企业成员的帐号

返回:

. contact detail

抛出:

WxErrorException - .

convertToOpenid

String convertToOpenid(String externalUserid)
                throws WxErrorException

企业和服务商可通过此接口，将微信外部联系人的userid转为微信openid，用于调用支付相关接口。暂不支持企业微信外部联系人（ExternalUserid为wo开头）的userid转openid。

参数:

externalUserid - 微信外部联系人的userid

返回:

该企业的外部联系人openid

抛出:

WxErrorException - .

unionidToExternalUserid

String unionidToExternalUserid(@NotNull
                               String unionid,
                               String openid)
                        throws WxErrorException

服务商为企业代开发微信小程序的场景，服务商可通过此接口，将微信客户的unionid转为external_userid。

 文档地址：https://work.weixin.qq.com/api/doc/90001/90143/93274

 服务商代开发小程序指企业使用的小程序为企业主体的，非服务商主体的小程序。
 场景：企业客户在微信端从企业主体的小程序（非服务商应用）登录，同时企业在企业微信安装了服务商的第三方应用，服务商可以调用该接口将登录用户的unionid转换为服务商全局唯一的外部联系人id

 权限说明：

 仅认证企业可调用
 unionid必须是企业主体下的unionid。即unionid的主体（为绑定了该小程序的微信开放平台账号主体）需与当前企业的主体一致。
 unionid的主体（即微信开放平台账号主体）需认证
 该客户的跟进人必须在应用的可见范围之内
 

参数:

unionid - 微信客户的unionid

返回:

该企业的外部联系人ID

抛出:

WxErrorException - .

getContactDetailBatch

WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList,
                                                   String cursor,
                                                   Integer limit)
                                            throws WxErrorException

批量获取客户详情.

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

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

 权限说明：

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

参数:

userIdList - 企业成员的userid列表，注意不是外部联系人的帐号

cursor - the cursor

limit - the limit

返回:

wx cp user external contact batch info

抛出:

WxErrorException - .

updateRemark

void updateRemark(WxCpUpdateRemarkRequest request)
           throws WxErrorException

修改客户备注信息.

 企业可通过此接口修改指定用户添加的客户的备注信息。
 请求方式: 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
 

参数:

request - 备注信息请求

抛出:

WxErrorException - .

listExternalContacts

List<String> listExternalContacts(String userId)
                           throws WxErrorException

获取客户列表.

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

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

 权限说明：

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

参数:

userId - 企业成员的userid

返回:

List of External wx id

抛出:

WxErrorException - .

listFollowers

List<String> listFollowers()
                    throws WxErrorException

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

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

返回:

List of CpUser id

抛出:

WxErrorException - .

listUnassignedList

WxCpUserExternalUnassignList listUnassignedList(Integer page,
                                                Integer pageSize)
                                         throws WxErrorException

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

参数:

page - the page

pageSize - the page size

返回:

wx cp user external unassign list

抛出:

WxErrorException - the wx error exception

transferExternalContact

@Deprecated
WxCpBaseResp transferExternalContact(String externalUserid,
                                                  String handOverUserid,
                                                  String takeOverUserid)
                                           throws WxErrorException

已过时。 此后续将不再更新维护, 建议使用 transferCustomer(WxCpUserTransferCustomerReq)

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

参数:

externalUserid - the external userid

handOverUserid - the hand over userid

takeOverUserid - the take over userid

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

transferCustomer

WxCpUserTransferCustomerResp transferCustomer(WxCpUserTransferCustomerReq req)
                                       throws WxErrorException

企业可通过此接口，转接在职成员的客户给其他成员。 external_userid必须是handover_userid的客户（即配置了客户联系功能的成员所添加的联系人）。 在职成员的每位客户最多被分配2次。客户被转接成功后，将有90个自然日的服务关系保护期，保护期内的客户无法再次被分配。

权限说明： * 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限 接替成员必须在此第三方应用或自建应用的可见范围内。 接替成员需要配置了客户联系功能。 接替成员需要在企业微信激活且已经过实名认证。

参数:

req - 转接在职成员的客户给其他成员请求实体

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

transferResult

WxCpUserTransferResultResp transferResult(@NotNull
                                          String handOverUserid,
                                          @NotNull
                                          String takeOverUserid,
                                          String cursor)
                                   throws WxErrorException

企业和第三方可通过此接口查询在职成员的客户转接情况。 权限说明：

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限 接替成员必须在此第三方应用或自建应用的可见范围内。

参数:

handOverUserid - 原添加成员的userid

takeOverUserid - 接替成员的userid

cursor - 分页查询的cursor，每个分页返回的数据不会超过1000条；不填或为空表示获取第一个分页；

返回:

客户转接接口实体

抛出:

WxErrorException - the wx error exception

resignedTransferCustomer

WxCpUserTransferCustomerResp resignedTransferCustomer(WxCpUserTransferCustomerReq req)
                                               throws WxErrorException

企业可通过此接口，分配离职成员的客户给其他成员。 handover_userid必须是已离职用户。 external_userid必须是handover_userid的客户（即配置了客户联系功能的成员所添加的联系人）。 在职成员的每位客户最多被分配2次。客户被转接成功后，将有90个自然日的服务关系保护期，保护期内的客户无法再次被分配。

权限说明：

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限 接替成员必须在此第三方应用或自建应用的可见范围内。 接替成员需要配置了客户联系功能。 接替成员需要在企业微信激活且已经过实名认证。

参数:

req - 转接在职成员的客户给其他成员请求实体

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

resignedTransferResult

WxCpUserTransferResultResp resignedTransferResult(@NotNull
                                                  String handOverUserid,
                                                  @NotNull
                                                  String takeOverUserid,
                                                  String cursor)
                                           throws WxErrorException

企业和第三方可通过此接口查询离职成员的客户分配情况。 权限说明：

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限 接替成员必须在此第三方应用或自建应用的可见范围内。

参数:

handOverUserid - 原添加成员的userid

takeOverUserid - 接替成员的userid

cursor - 分页查询的cursor，每个分页返回的数据不会超过1000条；不填或为空表示获取第一个分页；

返回:

客户转接接口实体

抛出:

WxErrorException - the wx error exception

listGroupChat

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

已过时。 请使用 listGroupChat(Integer, String, int, String[])

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

参数:

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

listGroupChat

WxCpUserExternalGroupChatList listGroupChat(Integer limit,
                                            String cursor,
                                            int status,
                                            String[] userIds)
                                     throws WxErrorException

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

参数:

limit - 分页，预期请求的数据量，取值范围 1 ~ 1000

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用不填

status - 客户群跟进状态过滤。0 - 所有列表(即不过滤) 1 - 离职待继承 2 - 离职继承中 3 - 离职继承完成 默认为0

userIds - 群主过滤。如果不填，表示获取应用可见范围内全部群主的数据（但是不建议这么用，如果可见范围人数超过1000人，为了防止数据包过大，会报错 81017）;用户ID列表。最多100个

返回:

the wx cp user external group chat list

抛出:

WxErrorException - the wx error exception

getGroupChat

WxCpUserExternalGroupChatInfo getGroupChat(String chatId,
                                           Integer needName)
                                    throws WxErrorException

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

参数:

chatId - the chat id

返回:

group chat

抛出:

WxErrorException - the wx error exception

transferGroupChat

WxCpUserExternalGroupChatTransferResp transferGroupChat(String[] chatIds,
                                                        String newOwner)
                                                 throws WxErrorException

企业可通过此接口，将已离职成员为群主的群，分配给另一个客服成员。 注意：：

群主离职了的客户群，才可继承 继承给的新群主，必须是配置了客户联系功能的成员 继承给的新群主，必须有设置实名 继承给的新群主，必须有激活企业微信 同一个人的群，限制每天最多分配300个给新群主

权限说明:

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限 对于第三方/自建应用，群主必须在应用的可见范围。

参数:

chatIds - 需要转群主的客户群ID列表。取值范围： 1 ~ 100

newOwner - 新群主ID

返回:

分配结果，主要是分配失败的群列表

抛出:

WxErrorException - the wx error exception

getUserBehaviorStatistic

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

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

参数:

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

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

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

参数:

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

WxCpMsgTemplateAddResult addMsgTemplate(WxCpMsgTemplate wxCpMsgTemplate)
                                 throws WxErrorException

添加企业群发消息任务 企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。（注：企业微信终端需升级到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

参数:

wxCpMsgTemplate - the wx cp msg template

返回:

the wx cp msg template add result

抛出:

WxErrorException - the wx error exception

sendWelcomeMsg

void sendWelcomeMsg(WxCpWelcomeMsg msg)
             throws WxErrorException

发送新客户欢迎语

 企业微信在向企业推送添加外部联系人事件时，会额外返回一个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
 

参数:

msg - .

抛出:

WxErrorException - .

getCorpTagList

WxCpUserExternalTagGroupList getCorpTagList(String[] tagId)
                                     throws WxErrorException

 企业可通过此接口获取企业客户标签详情。
 

参数:

tagId - the tag id

返回:

corp tag list

抛出:

WxErrorException - the wx error exception

getCorpTagList

WxCpUserExternalTagGroupList getCorpTagList(String[] tagId,
                                            String[] groupId)
                                     throws WxErrorException

 企业可通过此接口获取企业客户标签详情。
 若tag_id和group_id均为空，则返回所有标签。
 同时传递tag_id和group_id时，忽略tag_id，仅以group_id作为过滤条件。
 

参数:

tagId - the tag id

groupId - the tagGroup id

返回:

corp tag list

抛出:

WxErrorException - the wx error exception

addCorpTag

WxCpUserExternalTagGroupInfo addCorpTag(WxCpUserExternalTagGroupInfo tagGroup)
                                 throws WxErrorException

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

参数:

tagGroup - the tag group

返回:

wx cp user external tag group info

抛出:

WxErrorException - the wx error exception

editCorpTag

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

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

参数:

id - the id

name - the name

order - the order

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

delCorpTag

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

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

参数:

tagId - the tag id

groupId - the group id

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

markTag

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

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

参数:

userid - the userid

externalUserid - the external userid

addTag - the add tag

removeTag - the remove tag

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

addMomentTask

WxCpAddMomentResult addMomentTask(WxCpAddMomentTask task)
                           throws WxErrorException

   企业和第三方应用可通过该接口创建客户朋友圈的发表任务。
   https://open.work.weixin.qq.com/api/doc/90000/90135/95094
 

参数:

task -

返回:

wx cp add moment result

抛出:

WxErrorException - the wx error exception

getMomentTaskResult

WxCpGetMomentTaskResult getMomentTaskResult(String jobId)
                                     throws WxErrorException

 由于发表任务的创建是异步执行的，应用需要再调用该接口以获取创建的结果。
 https://open.work.weixin.qq.com/api/doc/90000/90135/95094
 

参数:

jobId - 异步任务id，最大长度为64字节，由创建发表内容到客户朋友圈任务接口获取

返回:

抛出:

WxErrorException

getMomentList

WxCpGetMomentList getMomentList(Long startTime,
                                Long endTime,
                                String creator,
                                Integer filterType,
                                String cursor,
                                Integer limit)
                         throws WxErrorException

 获取客户朋友圈全部的发表记录 获取企业全部的发表列表
 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
 

参数:

startTime - 朋友圈记录开始时间。Unix时间戳

endTime - 朋友圈记录结束时间。Unix时间戳

creator - 朋友圈创建人的userid

filterType - 朋友圈类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

limit - 返回的最大记录数，整型，最大值100，默认值100，超过最大值时取默认值

返回:

抛出:

WxErrorException

getMomentTask

WxCpGetMomentTask getMomentTask(String momentId,
                                String cursor,
                                Integer limit)
                         throws WxErrorException

 获取客户朋友圈全部的发表记录 获取客户朋友圈企业发表的列表
 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
 

参数:

momentId - 朋友圈id,仅支持企业发表的朋友圈id

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

limit - 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值

返回:

抛出:

WxErrorException

getMomentCustomerList

WxCpGetMomentCustomerList getMomentCustomerList(String momentId,
                                                String userId,
                                                String cursor,
                                                Integer limit)
                                         throws WxErrorException

 获取客户朋友圈全部的发表记录 获取客户朋友圈发表时选择的可见范围
 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
 

参数:

momentId - 朋友圈id

userId - 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的 列表获取已发表成员userid，如果是个人创建的朋友圈，创建人userid就是企业发表成员userid

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

limit - 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值

返回:

抛出:

WxErrorException

getMomentSendResult

WxCpGetMomentSendResult getMomentSendResult(String momentId,
                                            String userId,
                                            String cursor,
                                            Integer limit)
                                     throws WxErrorException

 获取客户朋友圈全部的发表记录 获取客户朋友圈发表后的可见客户列表
 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
 

参数:

momentId - 朋友圈id

userId - 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的列表获取已发表成员userid， 如果是个人创建的朋友圈，创建人userid就是企业发表成员userid

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

limit - 返回的最大记录数，整型，最大值5000，默认值3000，超过最大值时取默认值

返回:

抛出:

WxErrorException

getMomentComments

WxCpGetMomentComments getMomentComments(String momentId,
                                        String userId)
                                 throws WxErrorException

 获取客户朋友圈全部的发表记录 获取客户朋友圈的互动数据
 https://open.work.weixin.qq.com/api/doc/90000/90135/93333
 

参数:

momentId - 朋友圈id

userId - 企业发表成员userid，如果是企业创建的朋友圈，可以通过获取客户朋友圈企业发表的列表获取已发表成员userid， 如果是个人创建的朋友圈，创建人userid就是企业发表成员userid

返回:

抛出:

WxErrorException

getGroupMsgListV2

WxCpGroupMsgListResult getGroupMsgListV2(String chatType,
                                         @NonNull
                                         @NonNull Date startTime,
                                         @NonNull
                                         @NonNull Date endTime,
                                         String creator,
                                         Integer filterType,
                                         Integer limit,
                                         String cursor)
                                  throws WxErrorException

 企业和第三方应用可通过此接口获取企业与成员的群发记录。
 https://work.weixin.qq.com/api/doc/90000/90135/93338
 

参数:

chatType - 群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群

startTime - 群发任务记录开始时间

endTime - 群发任务记录结束时间

creator - 群发任务创建人企业账号id

filterType - 创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型

limit - 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

getGroupMsgSendResult

WxCpGroupMsgSendResult getGroupMsgSendResult(String msgid,
                                             String userid,
                                             Integer limit,
                                             String cursor)
                                      throws WxErrorException

 企业和第三方应用可通过此接口获取企业与成员的群发记录。
 https://work.weixin.qq.com/api/doc/90000/90135/93338#获取企业群发成员执行结果
 

参数:

msgid - 群发消息的id，通过获取群发记录列表接口返回

userid - 发送成员userid，通过获取群发成员发送任务列表接口返回

limit - 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception

getGroupMsgTask

WxCpGroupMsgTaskResult getGroupMsgTask(String msgid,
                                       Integer limit,
                                       String cursor)
                                throws WxErrorException

 获取群发成员发送任务列表。
 https://work.weixin.qq.com/api/doc/90000/90135/93338#获取群发成员发送任务列表
 

参数:

msgid - 群发消息的id，通过获取群发记录列表接口返回

limit - 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值

cursor - 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

返回:

wx cp base resp

抛出:

WxErrorException - the wx error exception