Class CustomerAcquisitionService
java.lang.Object
com.bytedesk.wechat.work.assistant.CustomerAcquisitionService
企业微信获客助手服务
提供获客链接相关的API功能实现
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private org.springframework.web.client.RestTemplate
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateLink
(String accessToken, String linkName, String[] userList, Integer[] departmentList, Boolean skipVerify, Integer priorityType, String[] priorityUserIdList) 创建获客链接 企业可通过此接口创建新的获客链接deleteLink
(String accessToken, String linkId) 删除获客链接 企业可通过此接口删除获客链接,删除后的获客链接将无法继续使用getChatInfo
(String accessToken, String chatKey) 获取成员多次收消息详情 企业和服务商可通过此接口获取成员多次收消息情况,如次数、客户id等信息getCustomers
(String accessToken, String linkId, Integer limit, String cursor) 获取获客客户列表 企业可通过此接口获取到由指定的获客链接添加的客户列表getLinkDetails
(String accessToken, String linkId) 获取获客链接详情 企业可通过此接口根据获客链接id获取链接配置详情getLinkStatistic
(String accessToken, String linkId, long startTime, long endTime) 查询链接使用详情 企业可通过此接口查询指定获客链接在指定时间范围内的访问情况查询剩余使用量 企业可通过此接口查询当前剩余的使用量获取获客链接列表 企业可通过此接口获取当前仍然有效的获客链接updateLink
(String accessToken, String linkId, String linkName, String[] userList, Integer[] departmentList, Boolean skipVerify, Integer priorityType, String[] priorityUserIdList) 编辑获客链接 企业可通过此接口编辑获客链接,修改获客链接的关联范围或修改获客链接的名称
-
Field Details
-
BASE_URL
- See Also:
-
restTemplate
@Autowired private org.springframework.web.client.RestTemplate restTemplate
-
-
Constructor Details
-
CustomerAcquisitionService
public CustomerAcquisitionService()
-
-
Method Details
-
listLinks
获取获客链接列表 企业可通过此接口获取当前仍然有效的获客链接- Parameters:
accessToken
- 访问令牌limit
- 返回的最大记录数,整型,最大值100cursor
- 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填- Returns:
- 链接列表结果
-
getLinkDetails
获取获客链接详情 企业可通过此接口根据获客链接id获取链接配置详情- Parameters:
accessToken
- 访问令牌linkId
- 获客链接id- Returns:
- 链接详情结果
-
createLink
public LinkResponse createLink(String accessToken, String linkName, String[] userList, Integer[] departmentList, Boolean skipVerify, Integer priorityType, String[] priorityUserIdList) 创建获客链接 企业可通过此接口创建新的获客链接- Parameters:
accessToken
- 访问令牌linkName
- 链接名称userList
- 此获客链接关联的userid列表departmentList
- 此获客链接关联的部门id列表skipVerify
- 是否无需验证,默认为truepriorityType
- 客户与成员关系绑定类型priorityUserIdList
- 指定成员列表- Returns:
- 创建结果
-
updateLink
public LinkResponse updateLink(String accessToken, String linkId, String linkName, String[] userList, Integer[] departmentList, Boolean skipVerify, Integer priorityType, String[] priorityUserIdList) 编辑获客链接 企业可通过此接口编辑获客链接,修改获客链接的关联范围或修改获客链接的名称- Parameters:
accessToken
- 访问令牌linkId
- 获客链接的idlinkName
- 更新的链接名称userList
- 此获客链接关联的userid列表departmentList
- 此获客链接关联的部门id列表skipVerify
- 是否无需验证priorityType
- 客户与成员关系绑定类型priorityUserIdList
- 指定成员列表- Returns:
- 更新结果
-
deleteLink
删除获客链接 企业可通过此接口删除获客链接,删除后的获客链接将无法继续使用- Parameters:
accessToken
- 访问令牌linkId
- 获客链接的id- Returns:
- 删除结果
-
getCustomers
获取获客客户列表 企业可通过此接口获取到由指定的获客链接添加的客户列表- Parameters:
accessToken
- 访问令牌linkId
- 获客链接idlimit
- 返回的最大记录数,整型,最大值1000cursor
- 用于分页查询的游标- Returns:
- 客户列表结果
-
getQuota
查询剩余使用量 企业可通过此接口查询当前剩余的使用量- Parameters:
accessToken
- 访问令牌- Returns:
- 剩余使用量结果
-
getLinkStatistic
public LinkResponse getLinkStatistic(String accessToken, String linkId, long startTime, long endTime) 查询链接使用详情 企业可通过此接口查询指定获客链接在指定时间范围内的访问情况- Parameters:
accessToken
- 访问令牌linkId
- 获客链接的idstartTime
- 统计起始时间戳endTime
- 统计结束时间戳- Returns:
- 链接使用详情结果
-
getChatInfo
获取成员多次收消息详情 企业和服务商可通过此接口获取成员多次收消息情况,如次数、客户id等信息- Parameters:
accessToken
- 访问令牌chatKey
- 成员多次收消息事件中回调的会话信息凭据ChatKey,回调后30分钟内有效- Returns:
- 消息详情结果
-