cn.felord.reactive.api

Interface CustomerAcquisitionApi

public interface CustomerAcquisitionApi

获客助手

Since:

2023 /5/30 21:28

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<GenericResponse<AcquisitionLink>>	createLink(AcquisitionLinkCreateRequest request) 创建获客链接
io.reactivex.rxjava3.core.Single<LinkCustomersResponse>	customer(LinkPageRequest request) 获取由获客链接添加的客户信息
io.reactivex.rxjava3.core.Single<AcquisitionQuotaResponse>	customerAcquisitionQuota() 查询获客链接剩余使用量
io.reactivex.rxjava3.core.Single<WeComResponse>	deleteLink(LinkId linkId) 删除获客链接
io.reactivex.rxjava3.core.Single<LinkDetailResponse>	get(LinkId linkId) 获取获客链接详情
io.reactivex.rxjava3.core.Single<LinksResponse>	listLink(PageRequest request) 获取获客链接列表
io.reactivex.rxjava3.core.Single<LinkStatisticResponse>	queryCustomerAcquisitionQuotas(String linkId, Instant startTime, Instant endTime) 查询链接使用详情
io.reactivex.rxjava3.core.Single<WeComResponse>	updateLink(AcquisitionLinkUpdateRequest request) 编辑获客链接

Method Detail

listLink

@POST(value="externalcontact/customer_acquisition/list_link")
io.reactivex.rxjava3.core.Single<LinksResponse> listLink(@Body
                                                                                                                       PageRequest request)

获取获客链接列表

Parameters:

request - the request

Returns:

the follow user list

get

@POST(value="externalcontact/customer_acquisition/get")
io.reactivex.rxjava3.core.Single<LinkDetailResponse> get(@Body
                                                                                                                 LinkId linkId)

获取获客链接详情

Parameters:

linkId - the link id

Returns:

the we com response

createLink

@POST(value="externalcontact/customer_acquisition/create_link")
io.reactivex.rxjava3.core.Single<GenericResponse<AcquisitionLink>> createLink(@Body
                                                                                                                                              AcquisitionLinkCreateRequest request)

创建获客链接

Parameters:

request - the request

Returns:

the we com response

updateLink

@POST(value="externalcontact/customer_acquisition/update_link")
io.reactivex.rxjava3.core.Single<WeComResponse> updateLink(@Body
                                                                                                                           AcquisitionLinkUpdateRequest request)

编辑获客链接

Parameters:

request - the request

Returns:

the we com response

deleteLink

@POST(value="externalcontact/customer_acquisition/delete_link")
io.reactivex.rxjava3.core.Single<WeComResponse> deleteLink(@Body
                                                                                                                           LinkId linkId)

删除获客链接

Parameters:

linkId - the link id

Returns:

the we com response

customer

@POST(value="externalcontact/customer_acquisition/customer")
io.reactivex.rxjava3.core.Single<LinkCustomersResponse> customer(@Body
                                                                                                                              LinkPageRequest request)

获取由获客链接添加的客户信息

Parameters:

request - the request

Returns:

the we com response

customerAcquisitionQuota

@GET(value="externalcontact/customer_acquisition_quota")
io.reactivex.rxjava3.core.Single<AcquisitionQuotaResponse> customerAcquisitionQuota()

查询获客链接剩余使用量

Returns:

the we com response

queryCustomerAcquisitionQuotas

@GET(value="externalcontact/customer_acquisition/statistic")
io.reactivex.rxjava3.core.Single<LinkStatisticResponse> queryCustomerAcquisitionQuotas(@Query(value="link_id")
                                                                                                                                                    String linkId,
                                                                                                                                                    @Query(value="start_time")
                                                                                                                                                    Instant startTime,
                                                                                                                                                    @Query(value="end_time")
                                                                                                                                                    Instant endTime)
                                                                                                                                             throws WeComException

查询链接使用详情

企业可通过此接口查询指定获客链接在指定时间范围内的访问情况。

Parameters:

linkId - the link id

startTime - the start time

endTime - the end time

Returns:

the link statistic response

Throws:

WeComException - the we com exception