cn.felord.reactive.api

Interface ExternalContactUserApi

public interface ExternalContactUserApi

客户管理

Since:

2021 /9/8 19:05

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<ExternalUserListDetailResponse>	batchByUserIds(ExternalUserListDetailRequest request) 批量获取客户详情
io.reactivex.rxjava3.core.Single<ContractListResponse>	contactList(PageRequest request) 获取已服务的外部联系人
io.reactivex.rxjava3.core.Single<GenericResponse<String>>	convertToOpenid(ExternalUserId externalUserId) 家校沟通-外部联系人openid转换
io.reactivex.rxjava3.core.Single<GenericResponse<Integer>>	createCustomerStrategy(CustomerStrategyRequest request) 创建新的规则组
io.reactivex.rxjava3.core.Single<StrategyListResponse>	customerStrategyList(PageRequest request) 获取规则组列表
io.reactivex.rxjava3.core.Single<WeComResponse>	delCustomerStrategy(StrategyId strategyId) 删除规则组
io.reactivex.rxjava3.core.Single<WeComResponse>	editCustomerStrategy(MutableCustomerStrategy request) 编辑规则组及其管理范围
io.reactivex.rxjava3.core.Single<ExternalUserDetailResponse>	getByExUserId(String externalUserid, String cursor) 获取客户详情
io.reactivex.rxjava3.core.Single<CustomerStrategyDetailResponse>	getCustomerStrategy(StrategyId strategyId) 获取规则组详情
io.reactivex.rxjava3.core.Single<StrategyRangeResponse>	getCustomerStrategyRange(StrategyRangeRequest request) 获取规则组管理范围
io.reactivex.rxjava3.core.Single<GenericResponse<List<String>>>	listByUserId(String userId) 获取客户列表
io.reactivex.rxjava3.core.Single<WeComResponse>	remark(CustomerRemarkRequest request) 修改客户备注信息

Method Detail

listByUserId

@GET(value="externalcontact/list")
io.reactivex.rxjava3.core.Single<GenericResponse<List<String>>> listByUserId(@Query(value="userid")
                                                                                                                String userId)

获取客户列表

Parameters:

userId - the user id

Returns:

the follow user list

getByExUserId

@GET(value="externalcontact/get")
io.reactivex.rxjava3.core.Single<ExternalUserDetailResponse> getByExUserId(@Query(value="external_userid")
                                                                                                             String externalUserid,
                                                                                                             @Query(value="cursor")
                                                                                                             String cursor)

获取客户详情

Parameters:

externalUserid - the external userid

cursor - the cursor

Returns:

the by user id

batchByUserIds

@POST(value="externalcontact/batch/get_by_user")
io.reactivex.rxjava3.core.Single<ExternalUserListDetailResponse> batchByUserIds(@Body
                                                                                                                                 ExternalUserListDetailRequest request)

批量获取客户详情

Parameters:

request - the request

Returns:

the by user id

remark

@POST(value="externalcontact/remark")
io.reactivex.rxjava3.core.Single<WeComResponse> remark(@Body
                                                                                             CustomerRemarkRequest request)

修改客户备注信息

Parameters:

request - the request

Returns:

the external user list detail response

customerStrategyList

@POST(value="externalcontact/customer_strategy/list")
io.reactivex.rxjava3.core.Single<StrategyListResponse> customerStrategyList(@Body
                                                                                                                                  PageRequest request)

获取规则组列表

Parameters:

request - the request

Returns:

the external user list detail response

getCustomerStrategy

@POST(value="externalcontact/customer_strategy/get")
io.reactivex.rxjava3.core.Single<CustomerStrategyDetailResponse> getCustomerStrategy(@Body
                                                                                                                                          StrategyId strategyId)

获取规则组详情

Parameters:

strategyId - the strategy id

Returns:

the external user list detail response

getCustomerStrategyRange

@POST(value="externalcontact/customer_strategy/get_range")
io.reactivex.rxjava3.core.Single<StrategyRangeResponse> getCustomerStrategyRange(@Body
                                                                                                                                            StrategyRangeRequest request)

获取规则组管理范围

Parameters:

request - the request

Returns:

the external user list detail response

createCustomerStrategy

@POST(value="externalcontact/customer_strategy/create")
io.reactivex.rxjava3.core.Single<GenericResponse<Integer>> createCustomerStrategy(@Body
                                                                                                                                          CustomerStrategyRequest request)

创建新的规则组

Parameters:

request - the request

Returns:

the customer strategy range response

editCustomerStrategy

@POST(value="externalcontact/customer_strategy/edit")
io.reactivex.rxjava3.core.Single<WeComResponse> editCustomerStrategy(@Body
                                                                                                                           MutableCustomerStrategy request)

编辑规则组及其管理范围

Parameters:

request - the request

Returns:

the customer strategy range response

delCustomerStrategy

@POST(value="externalcontact/customer_strategy/del")
io.reactivex.rxjava3.core.Single<WeComResponse> delCustomerStrategy(@Body
                                                                                                                         StrategyId strategyId)

删除规则组

Parameters:

strategyId - the strategy id

Returns:

the customer strategy range response

convertToOpenid

@POST(value="externalcontact/convert_to_openid")
io.reactivex.rxjava3.core.Single<GenericResponse<String>> convertToOpenid(@Body
                                                                                                                           ExternalUserId externalUserId)

家校沟通-外部联系人openid转换

企业和服务商可通过此接口，将微信外部联系人的userid（如何获取?）转为微信openid，用于调用支付相关接口。 暂不支持企业微信外部联系人（ExternalUserid为wo开头）的userid转openid。

Parameters:

externalUserId - the external user id

Returns:

the generic response

contactList

@POST(value="externalcontact/contact_list")
io.reactivex.rxjava3.core.Single<ContractListResponse> contactList(@Body
                                                                                                               PageRequest request)

获取已服务的外部联系人

企业可通过此接口获取所有已服务的外部联系人，及其添加人和加入的群聊。 外部联系人分为客户和其他外部联系人，如果是客户，接口将返回外部联系人临时ID和externaluserid； 如果是其他外部联系人，接口将只返回外部联系人临时ID。

企业可通过外部联系人临时ID排除重复数据，外部联系人临时ID有效期为4小时。

Parameters:

request - cursor具有有效期，请勿缓存后使用

Returns:

generic response

Throws:

WeComException - the we com exception