me.chanjar.weixin.cp.api.WxCpExternalContactService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weixin-java-cp Show documentation

微信企业号/企业微信 Java SDK

There is a newer version: 4.6.7.B

package me.chanjar.weixin.cp.api;

import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.cp.bean.WxCpUserExternalContactInfo;

import java.util.List;

/**
 *  * 外部联系人管理接口，企业微信的外部联系人的接口和通讯录接口已经拆离
 *  Created by Joe Cao on 2019/6/14
 * 
 *
 * @author JoeCao
 */
public interface WxCpExternalContactService {
  /**
   * 获取外部联系人详情.
   *    *   企业可通过此接口，根据外部联系人的userid，拉取外部联系人详情。权限说明：
   * 企业需要使用外部联系人管理secret所获取的accesstoken来调用
   * 第三方应用需拥有“企业客户”权限。
   * 第三方应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。
   * 
   *
   * @param userId 外部联系人的userid
   */
  WxCpUserExternalContactInfo getExternalContact(String userId) throws WxErrorException;

  /**
   * 获取外部联系人列表.
   *    *   企业可通过此接口获取指定成员添加的客户列表。
   *   客户是指配置了客户联系功能的成员所添加的外部联系人。
   *   没有配置客户联系功能的成员，所添加的外部联系人将不会作为客户返回。
   * 第三方应用需拥有“企业客户”权限。
   * 第三方应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。
   * 
   *
   * @param userId 外部联系人的userid
   * @return List of External wx id
   */
  List listExternalContacts(String userId) throws WxErrorException;


  /**
   * 企业和第三方服务商可通过此接口获取配置了客户联系功能的成员(Customer Contact)列表。
   *    *   企业需要使用外部联系人管理secret所获取的accesstoken来调用（accesstoken如何获取？）；
   *   第三方应用需拥有“企业客户”权限。
   *   第三方应用只能获取到可见范围内的配置了客户联系功能的成员
   * 
   *
   * @return List of CpUser id
   */
  List listFollowUser() throws WxErrorException;

}