Package com.bytedesk.wechat.work.customer

Class WeChatWorkCustomerRestController

java.lang.Object

com.bytedesk.core.base.BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

com.bytedesk.wechat.work.customer.WeChatWorkCustomerRestController

@RestController
@RequestMapping("/api/v1/wechat/work/customer")
public class WeChatWorkCustomerRestController
extends BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

企业微信-客户联系功能接口

Author:

kefux.com

Field Summary

Fields

Modifier and Type	Field	Description
private final WeChatWorkCustomerService	weChatWorkCustomerService

Constructor Summary

Constructors

Constructor	Description
WeChatWorkCustomerRestController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<?>	batchGetExternalUserDetail(WeChatWorkCustomerRequest request)	批量获取客户详情
org.springframework.http.ResponseEntity<?>	checkFollowUser(WeChatWorkCustomerRequest request)	检查用户是否具备客户联系功能
org.springframework.http.ResponseEntity<?>	create(WeChatWorkCustomerRequest request)	通用的create实现 减少子类重复代码
org.springframework.http.ResponseEntity<?>	delete(WeChatWorkCustomerRequest request)	通用的delete实现 减少子类重复代码
org.springframework.http.ResponseEntity<?>	deleteCustomerStrategy(String corpId, String appSecret, Integer strategyId)	删除规则组
Object	export(WeChatWorkCustomerRequest request, jakarta.servlet.http.HttpServletResponse response)	export
org.springframework.http.ResponseEntity<?>	getCustomerStrategy(String corpId, String appSecret, Integer strategyId)	获取规则组详情
org.springframework.http.ResponseEntity<?>	getCustomerStrategyList(String corpId, String appSecret, String cursor, Integer limit)	获取规则组列表
org.springframework.http.ResponseEntity<?>	getCustomerStrategyRange(String corpId, String appSecret, Integer strategyId, String cursor, Integer limit)	获取规则组管理范围
org.springframework.http.ResponseEntity<?>	getExternalUserDetail(String corpId, String appSecret, String externalUserId, String cursor)	获取客户详情
org.springframework.http.ResponseEntity<?>	getExternalUserList(String corpId, String appSecret, String userId)	获取客户列表
org.springframework.http.ResponseEntity<?>	getFollowUserList(String corpId, String appSecret)	获取配置了客户联系功能的成员列表
org.springframework.http.ResponseEntity<?>	queryByOrg(WeChatWorkCustomerRequest request)	通用的queryByOrg实现 减少子类重复代码
org.springframework.http.ResponseEntity<?>	queryByUid(WeChatWorkCustomerRequest request)	通用的queryByUid实现 减少子类重复代码
org.springframework.http.ResponseEntity<?>	queryByUser(WeChatWorkCustomerRequest request)	通用的queryByUser实现 减少子类重复代码
org.springframework.http.ResponseEntity<?>	update(WeChatWorkCustomerRequest request)	通用的update实现 减少子类重复代码
org.springframework.http.ResponseEntity<?>	updateExternalUserRemark(WeChatWorkCustomerRequest request)	修改客户备注信息

Methods inherited from class com.bytedesk.core.base.BaseRestController

deleteByOrgUid, exportTemplate, getService

Methods inherited from class java.lang.Object

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

Field Details

weChatWorkCustomerService

private final WeChatWorkCustomerService weChatWorkCustomerService

Constructor Details

WeChatWorkCustomerRestController

public WeChatWorkCustomerRestController()

Method Details

getFollowUserList

@GetMapping("/follow_user_list")
public org.springframework.http.ResponseEntity<?> getFollowUserList(@RequestParam
 String corpId,
 @RequestParam
 String appSecret)

获取配置了客户联系功能的成员列表

Parameters:

corpId - 企业ID

appSecret - 应用密钥

Returns:

成员列表

checkFollowUser

@PostMapping("/check_follow_user")
public org.springframework.http.ResponseEntity<?> checkFollowUser(@RequestBody
 WeChatWorkCustomerRequest request)

检查用户是否具备客户联系功能

Parameters:

request - 请求对象

Returns:

检查结果

getExternalUserList

@GetMapping("/list")
public org.springframework.http.ResponseEntity<?> getExternalUserList(@RequestParam
 String corpId,
 @RequestParam
 String appSecret,
 @RequestParam
 String userId)

获取客户列表

Parameters:

corpId - 企业ID

appSecret - 应用密钥

userId - 企业成员的userid

Returns:

客户列表

getExternalUserDetail

@GetMapping("/get")
public org.springframework.http.ResponseEntity<?> getExternalUserDetail(@RequestParam
 String corpId,
 @RequestParam
 String appSecret,
 @RequestParam
 String externalUserId,
 @RequestParam(required=false)
 String cursor)

获取客户详情

Parameters:

corpId - 企业ID

appSecret - 应用密钥

externalUserId - 外部联系人的userid

cursor - 分页游标

Returns:

客户详情

batchGetExternalUserDetail

@PostMapping("/batch_get")
public org.springframework.http.ResponseEntity<?> batchGetExternalUserDetail(@RequestBody
 WeChatWorkCustomerRequest request)

批量获取客户详情

Parameters:

request - 请求对象

Returns:

客户详情列表

updateExternalUserRemark

@PostMapping("/remark")
public org.springframework.http.ResponseEntity<?> updateExternalUserRemark(@RequestBody
 WeChatWorkCustomerRequest request)

修改客户备注信息

Parameters:

request - 请求对象

Returns:

修改结果

getCustomerStrategyList

@GetMapping("/strategy/list")
public org.springframework.http.ResponseEntity<?> getCustomerStrategyList(@RequestParam
 String corpId,
 @RequestParam
 String appSecret,
 @RequestParam(required=false)
 String cursor,
 @RequestParam(required=false)
 Integer limit)

获取规则组列表

Parameters:

corpId - 企业ID

appSecret - 应用密钥

cursor - 分页游标，首次调用可不填

limit - 分页大小，默认为1000，最大不超过1000

Returns:

规则组列表

getCustomerStrategy

@GetMapping("/strategy/get")
public org.springframework.http.ResponseEntity<?> getCustomerStrategy(@RequestParam
 String corpId,
 @RequestParam
 String appSecret,
 @RequestParam
 Integer strategyId)

获取规则组详情

Parameters:

corpId - 企业ID

appSecret - 应用密钥

strategyId - 规则组id

Returns:

规则组详情

getCustomerStrategyRange

@GetMapping("/strategy/range")
public org.springframework.http.ResponseEntity<?> getCustomerStrategyRange(@RequestParam
 String corpId,
 @RequestParam
 String appSecret,
 @RequestParam
 Integer strategyId,
 @RequestParam(required=false)
 String cursor,
 @RequestParam(required=false)
 Integer limit)

获取规则组管理范围

Parameters:

corpId - 企业ID

appSecret - 应用密钥

strategyId - 规则组id

cursor - 分页游标

limit - 分页大小，默认为1000，最大不超过1000

Returns:

规则组管理范围

deleteCustomerStrategy

@GetMapping("/strategy/delete")
public org.springframework.http.ResponseEntity<?> deleteCustomerStrategy(@RequestParam
 String corpId,
 @RequestParam
 String appSecret,
 @RequestParam
 Integer strategyId)

删除规则组

Parameters:

corpId - 企业ID

appSecret - 应用密钥

strategyId - 规则组id

Returns:

删除结果

queryByOrg

public org.springframework.http.ResponseEntity<?> queryByOrg(WeChatWorkCustomerRequest request)

Description copied from class: BaseRestController

通用的queryByOrg实现 减少子类重复代码

Overrides:

queryByOrg in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

queryByUser

public org.springframework.http.ResponseEntity<?> queryByUser(WeChatWorkCustomerRequest request)

Description copied from class: BaseRestController

通用的queryByUser实现 减少子类重复代码

Overrides:

queryByUser in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

queryByUid

public org.springframework.http.ResponseEntity<?> queryByUid(WeChatWorkCustomerRequest request)

Description copied from class: BaseRestController

通用的queryByUid实现 减少子类重复代码

Overrides:

queryByUid in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

create

public org.springframework.http.ResponseEntity<?> create(WeChatWorkCustomerRequest request)

Description copied from class: BaseRestController

通用的create实现 减少子类重复代码

Overrides:

create in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

update

public org.springframework.http.ResponseEntity<?> update(WeChatWorkCustomerRequest request)

Description copied from class: BaseRestController

通用的update实现 减少子类重复代码

Overrides:

update in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

delete

public org.springframework.http.ResponseEntity<?> delete(WeChatWorkCustomerRequest request)

Description copied from class: BaseRestController

通用的delete实现 减少子类重复代码

Overrides:

delete in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

export

public Object export(WeChatWorkCustomerRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Description copied from class: BaseRestController

export

Overrides:

export in class BaseRestController<WeChatWorkCustomerRequest,WeChatWorkCustomerRestService>

Parameters:

request - role

Returns:

json