This commit is contained in:
2026-01-12 18:01:04 +08:00
commit 94784ee1ec
39 changed files with 2847 additions and 0 deletions
+93
View File
@@ -0,0 +1,93 @@
import type { GetExternalContactResponse, GetExternalContactListResponse, GetFollowUserListResponse, BatchGetExternalContactResponse, ExternalContact, AddContactWayRequest, AddContactWayResponse, GetContactWayRequest, GetContactWayResponse, UpdateContactWayRequest, UpdateContactWayResponse, DeleteContactWayRequest, DeleteContactWayResponse } from './types/wechat.js';
/**
* 企业微信API客户端配置
*/
export interface WeChatClientConfig {
/** 企业ID */
corpId: string;
/** 应用的secret */
corpSecret: string;
/** API基础URL */
baseUrl?: string;
}
/**
* 企业微信API客户端
*/
export declare class WeChatClient {
private config;
private accessToken;
private tokenExpireTime;
constructor(config: WeChatClientConfig);
/**
* 获取access_token
* @returns access_token
*/
getAccessToken(): Promise<string>;
/**
* 获取客户详情
* @param externalUserId 外部联系人的userid
* @param cursor 上次请求返回的next_cursor,用于分页
* @returns 客户详情
*/
getExternalContact(externalUserId: string, cursor?: string): Promise<GetExternalContactResponse>;
/**
* 获取客户详情(支持分页,自动获取所有跟进人)
* @param externalUserId 外部联系人的userid
* @returns 客户详情(包含所有跟进人)
*/
getExternalContactFull(externalUserId: string): Promise<GetExternalContactResponse>;
/**
* 获取配置了客户联系功能的成员列表
* @returns 配置了客户联系功能的成员userid列表
*/
getFollowUserList(): Promise<GetFollowUserListResponse>;
/**
* 获取客户列表
* @param userId 企业成员的userid
* @returns 外部联系人的userid列表
*/
getExternalContactList(userId: string): Promise<GetExternalContactListResponse>;
/**
* 批量获取客户详情
* @param userId 企业成员的userid
* @param cursor 上次请求返回的next_cursor,用于分页
* @param limit 返回的最大记录数,整型,最大值1000,默认值为100
* @returns 客户详情列表
*/
batchGetExternalContact(userId: string, cursor?: string, limit?: number): Promise<BatchGetExternalContactResponse>;
/**
* 批量获取客户详情(自动分页,获取所有客户)
* @param userId 企业成员的userid
* @returns 所有客户详情列表
*/
batchGetExternalContactFull(userId: string): Promise<ExternalContact[]>;
/**
* 添加「联系我」方式
* @param params 联系方式配置参数
* @returns 联系方式配置信息(包含config_id和qr_code)
*/
addContactWay(params: AddContactWayRequest): Promise<AddContactWayResponse>;
/**
* 获取「联系我」方式
* @param params 查询参数(包含config_id)
* @returns 联系方式配置信息
*/
getContactWay(params: GetContactWayRequest): Promise<GetContactWayResponse>;
/**
* 更新「联系我」方式
* @param params 更新参数(包含config_id和要更新的字段)
* @returns 更新结果
*/
updateContactWay(params: UpdateContactWayRequest): Promise<UpdateContactWayResponse>;
/**
* 删除「联系我」方式
* @param params 删除参数(包含config_id)
* @returns 删除结果
*/
deleteContactWay(params: DeleteContactWayRequest): Promise<DeleteContactWayResponse>;
/**
* 重置access_token(强制重新获取)
*/
resetAccessToken(): void;
}
//# sourceMappingURL=wechat-client.d.ts.map