cn.felord.api

Interface ExternalContactUserApi

public interface ExternalContactUserApi

客户管理

Since:

2021 /9/8 19:05

Author:

dax

Method Summary

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

Method Detail

listByUserId

@GET(value="externalcontact/list")
GenericResponse<List<String>> listByUserId(@Query(value="userid")
                                                                              String userId)
                                                                       throws WeComException

获取客户列表

Parameters:

userId - the user id

Returns:

the follow user list

Throws:

WeComException - the weComException

getByExUserId

@GET(value="externalcontact/get")
ExternalUserDetailResponse getByExUserId(@Query(value="external_userid")
                                                                           String externalUserid,
                                                                           @Query(value="cursor")
                                                                           String cursor)
                                                                    throws WeComException

获取客户详情

Parameters:

externalUserid - the external userid

cursor - the cursor

Returns:

the by user id

Throws:

WeComException - the weComException

batchByUserIds

@POST(value="externalcontact/batch/get_by_user")
ExternalUserListDetailResponse batchByUserIds(@Body
                                                                                               ExternalUserListDetailRequest request)
                                                                                        throws WeComException

批量获取客户详情

Parameters:

request - the request

Returns:

the by user id

Throws:

WeComException - the weComException

remark

@POST(value="externalcontact/remark")
WeComResponse remark(@Body
                                                           CustomerRemarkRequest request)
                                                    throws WeComException

修改客户备注信息

Parameters:

request - the request

Returns:

the external user list detail response

Throws:

WeComException - the weComException

customerStrategyList

@POST(value="externalcontact/customer_strategy/list")
StrategyListResponse customerStrategyList(@Body
                                                                                                PageRequest request)
                                                                                         throws WeComException

获取规则组列表

Parameters:

request - the request

Returns:

the external user list detail response

Throws:

WeComException - the weComException

getCustomerStrategy

@POST(value="externalcontact/customer_strategy/get")
CustomerStrategyDetailResponse getCustomerStrategy(@Body
                                                                                                        StrategyId strategyId)
                                                                                                 throws WeComException

获取规则组详情

Parameters:

strategyId - the strategy id

Returns:

the external user list detail response

Throws:

WeComException - the weComException

getCustomerStrategyRange

@POST(value="externalcontact/customer_strategy/get_range")
StrategyRangeResponse getCustomerStrategyRange(@Body
                                                                                                          StrategyRangeRequest request)
                                                                                                   throws WeComException

获取规则组管理范围

Parameters:

request - the request

Returns:

the external user list detail response

Throws:

WeComException - the weComException

createCustomerStrategy

@POST(value="externalcontact/customer_strategy/create")
GenericResponse<Integer> createCustomerStrategy(@Body
                                                                                                        CustomerStrategyRequest request)
                                                                                                 throws WeComException

创建新的规则组

Parameters:

request - the request

Returns:

the customer strategy range response

Throws:

WeComException - the weComException

editCustomerStrategy

@POST(value="externalcontact/customer_strategy/edit")
WeComResponse editCustomerStrategy(@Body
                                                                                         MutableCustomerStrategy request)
                                                                                  throws WeComException

编辑规则组及其管理范围

Parameters:

request - the request

Returns:

the customer strategy range response

Throws:

WeComException - the weComException

delCustomerStrategy

@POST(value="externalcontact/customer_strategy/del")
WeComResponse delCustomerStrategy(@Body
                                                                                       StrategyId strategyId)
                                                                                throws WeComException

删除规则组

Parameters:

strategyId - the strategy id

Returns:

the customer strategy range response

Throws:

WeComException - the weComException

convertToOpenid

@POST(value="externalcontact/convert_to_openid")
GenericResponse<String> convertToOpenid(@Body
                                                                                         ExternalUserId externalUserId)
                                                                                  throws WeComException

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

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

Parameters:

externalUserId - the external user id

Returns:

the generic response

Throws:

WeComException - the weComException

contactList

@POST(value="externalcontact/contact_list")
ContractListResponse contactList(@Body
                                                                             PageRequest request)
                                                                      throws WeComException

获取已服务的外部联系人

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

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

Parameters:

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

Returns:

generic response

Throws:

WeComException - the we com exception