Package com.bytedesk.wechat.work.assistant

Class CustomerAcquisitionController

java.lang.Object

com.bytedesk.wechat.work.assistant.CustomerAcquisitionController

@RestController
@RequestMapping("/api/v1/wechat/work/customer/acquisition")
public class CustomerAcquisitionController
extends Object

获客助手控制器 提供企业微信获客助手相关REST API接口

Field Summary

Fields

Modifier and Type	Field	Description
private CustomerAcquisitionService	customerAcquisitionService

Constructor Summary

Constructors

Constructor	Description
CustomerAcquisitionController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<LinkResponse>	createLink(String accessToken, LinkRequest request)	创建获客链接
org.springframework.http.ResponseEntity<LinkResponse>	deleteLink(String accessToken, String linkId)	删除获客链接
org.springframework.http.ResponseEntity<LinkResponse>	getChatInfo(String accessToken, String chatKey)	获取成员多次收消息详情
org.springframework.http.ResponseEntity<LinkResponse>	getCustomers(String accessToken, String linkId, Integer limit, String cursor)	获取获客客户列表
org.springframework.http.ResponseEntity<LinkResponse>	getLinkDetails(String accessToken, String linkId)	获取获客链接详情
org.springframework.http.ResponseEntity<LinkResponse>	getLinkStatistic(String accessToken, String linkId, Long startTime, Long endTime)	查询链接使用详情
org.springframework.http.ResponseEntity<LinkResponse>	getQuota(String accessToken)	查询剩余使用量
org.springframework.http.ResponseEntity<LinkResponse>	listLinks(String accessToken, Integer limit, String cursor)	获取获客链接列表
org.springframework.http.ResponseEntity<LinkResponse>	updateLink(String accessToken, LinkRequest request)	编辑获客链接

Methods inherited from class java.lang.Object

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

Field Details

customerAcquisitionService

@Autowired
private CustomerAcquisitionService customerAcquisitionService

Constructor Details

CustomerAcquisitionController

public CustomerAcquisitionController()

Method Details

listLinks

@GetMapping("/link/list")
public org.springframework.http.ResponseEntity<LinkResponse> listLinks(@RequestParam("access_token")
 String accessToken,
 @RequestParam(value="limit",required=false)
 Integer limit,
 @RequestParam(value="cursor",required=false)
 String cursor)

获取获客链接列表

Parameters:

accessToken - 访问令牌

limit - 返回的最大记录数，整型，最大值100

cursor - 用于分页查询的游标

Returns:

链接列表结果

getLinkDetails

@GetMapping("/link/detail")
public org.springframework.http.ResponseEntity<LinkResponse> getLinkDetails(@RequestParam("access_token")
 String accessToken,
 @RequestParam("link_id")
 String linkId)

获取获客链接详情

Parameters:

accessToken - 访问令牌

linkId - 获客链接id

Returns:

链接详情结果

createLink

@PostMapping("/link/create")
public org.springframework.http.ResponseEntity<LinkResponse> createLink(@RequestParam("access_token")
 String accessToken,
 @RequestBody
 LinkRequest request)

创建获客链接

Parameters:

accessToken - 访问令牌

request - 创建链接请求

Returns:

创建结果

updateLink

@PostMapping("/link/update")
public org.springframework.http.ResponseEntity<LinkResponse> updateLink(@RequestParam("access_token")
 String accessToken,
 @RequestBody
 LinkRequest request)

编辑获客链接

Parameters:

accessToken - 访问令牌

request - 更新链接请求

Returns:

更新结果

deleteLink

@PostMapping("/link/delete")
public org.springframework.http.ResponseEntity<LinkResponse> deleteLink(@RequestParam("access_token")
 String accessToken,
 @RequestParam("link_id")
 String linkId)

删除获客链接

Parameters:

accessToken - 访问令牌

linkId - 获客链接的id

Returns:

删除结果

getCustomers

@GetMapping("/customer/list")
public org.springframework.http.ResponseEntity<LinkResponse> getCustomers(@RequestParam("access_token")
 String accessToken,
 @RequestParam("link_id")
 String linkId,
 @RequestParam(value="limit",required=false)
 Integer limit,
 @RequestParam(value="cursor",required=false)
 String cursor)

获取获客客户列表

Parameters:

accessToken - 访问令牌

linkId - 获客链接id

limit - 返回的最大记录数，整型，最大值1000

cursor - 用于分页查询的游标

Returns:

客户列表结果

getQuota

@GetMapping("/quota")
public org.springframework.http.ResponseEntity<LinkResponse> getQuota(@RequestParam("access_token")
 String accessToken)

查询剩余使用量

Parameters:

accessToken - 访问令牌

Returns:

剩余使用量结果

getLinkStatistic

@GetMapping("/link/statistic")
public org.springframework.http.ResponseEntity<LinkResponse> getLinkStatistic(@RequestParam("access_token")
 String accessToken,
 @RequestParam("link_id")
 String linkId,
 @RequestParam("start_time")
 Long startTime,
 @RequestParam("end_time")
 Long endTime)

查询链接使用详情

Parameters:

accessToken - 访问令牌

linkId - 获客链接的id

startTime - 统计起始时间戳

endTime - 统计结束时间戳

Returns:

链接使用详情结果

getChatInfo

@GetMapping("/chat/info")
public org.springframework.http.ResponseEntity<LinkResponse> getChatInfo(@RequestParam("access_token")
 String accessToken,
 @RequestParam("chat_key")
 String chatKey)

获取成员多次收消息详情

Parameters:

accessToken - 访问令牌

chatKey - 成员多次收消息事件中回调的会话信息凭据ChatKey

Returns:

消息详情结果