node-easywechat 2.7.0 → 2.8.1

package/dist/Work/ExternalContact/Client.d.ts

@@ -1,23 +1,211 @@
 import BaseClient from '../../Core/BaseClient';
 export default class ExternalContactClient extends BaseClient {
+    /**
+     * 获取配置了客户联系功能的成员列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91554
+     * @returns
+     */
     getFollowUsers(): Promise<any>;
+    /**
+     * 获取外部联系人列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91555
+     * @param userId
+     * @returns
+     */
     list(userId: string): Promise<any>;
+    /**
+     * 获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91556
+     * @param externalUserId
+     * @returns
+     */
     get(externalUserId: string): Promise<any>;
-    batchGet(userId: string, cursor?: string, limit?: number): Promise<any>;
-    batchGetByUser(userId: string, cursor?: string, limit?: number): Promise<any>;
+    /**
+     * 批量获取客户详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92994
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGet(userIdList: string[], cursor?: string, limit?: number): Promise<any>;
+    /**
+     * 批量获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93010
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGetByUser(userIdList: string[], cursor?: string, limit?: number): Promise<any>;
+    /**
+     * 修改客户备注信息
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92115
+     * @param data
+     * @returns
+     */
     remark(data: object): Promise<any>;
+    /**
+     * 获取离职成员的客户列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92124
+     * @param pageId
+     * @param pageSize
+     * @param cursor
+     * @returns
+     */
     getUnassigned(pageId?: number, pageSize?: number, cursor?: string): Promise<any>;
+    /**
+     * 离职成员的外部联系人再分配
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91564
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transfer(externalUserId: string, handoverUserId: string, takeoverUserId: string, transferSuccessMessage: string): Promise<any>;
+    /**
+     * 分配在职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92125
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transferCustomer(externalUserId: string, handoverUserId: string, takeoverUserId: string, transferSuccessMessage: string): Promise<any>;
+    /**
+     * 分配离职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94081
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     resignedTransferCustomer(externalUserId: string, handoverUserId: string, takeoverUserId: string): Promise<any>;
+    /**
+     * 离职成员的群再分配
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92127
+     * @param chatIds
+     * @param newOwner
+     * @returns
+     */
     transferGroupChat(chatIds: string[], newOwner: string): Promise<any>;
+    /**
+     * 查询客户接替状态
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94082
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param cursor
+     * @returns
+     */
     transferResult(handoverUserId: string, takeoverUserId: string, cursor?: string): Promise<any>;
+    /**
+     * 查询客户接替结果
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93009
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     getTransferResult(externalUserId: string, handoverUserId: string, takeoverUserId: string): Promise<any>;
+    /**
+     * 获取客户群列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92120
+     * @param data
+     * @returns
+     */
     getGroupChats(data: object): Promise<any>;
-    getGroupChat(chatId: string): Promise<any>;
+    /**
+     * 获取客户群详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92122
+     * @param chatId
+     * @param needName
+     * @returns
+     */
+    getGroupChat(chatId: string, needName?: number): Promise<any>;
+    /**
+     * 获取企业标签库
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#获取企业标签库
+     * @param tagIds
+     * @param groupIds
+     * @returns
+     */
     getCorpTags(tagIds: string[], groupIds: string[]): Promise<any>;
+    /**
+     * 添加企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#添加企业客户标签
+     * @param data
+     * @returns
+     */
     addCorpTag(data: object): Promise<any>;
+    /**
+     * 编辑企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#编辑企业客户标签
+     * @param id
+     * @param name
+     * @param order
+     * @returns
+     */
     updateCorpTag(id: string, name?: string, order?: number): Promise<any>;
+    /**
+     * 删除企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#删除企业客户标签
+     * @param tagId
+     * @param groupId
+     * @returns
+     */
     deleteCorpTag(tagId: string[], groupId: string[]): Promise<any>;
+    /**
+     * 编辑客户企业标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92118
+     * @param data
+     * @returns
+     */
     markTags(data: object): Promise<any>;
+    /**
+     * 外部联系人unionid转换
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93274
+     * @param unionid 微信客户的unionid
+     * @param openid 微信客户的openid
+     * @returns
+     */
+    unionidToExternalUserid(unionid?: string, openid?: string): Promise<any>;
+    /**
+     * 代开发应用external_userid转换
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/95195
+     * @param unionid 微信客户的unionid
+     * @returns
+     */
+    toServiceExternalUserid(externalUserid: string): Promise<any>;
+    /**
+     * 转换external_userid
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#%E8%BD%AC%E6%8D%A2external_userid
+     * @param externalUserIds
+     * @returns
+     */
+    getNewExternalUserid(externalUserIds: string[]): Promise<any>;
+    /**
+     * 设置迁移完成
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#%E8%AE%BE%E7%BD%AE%E8%BF%81%E7%A7%BB%E5%AE%8C%E6%88%90
+     * @param corpid
+     * @returns
+     */
+    finishExternalUseridMigration(corpid: string): Promise<any>;
+    /**
+     * unionid查询external_userid
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#4.2%20unionid%E6%9F%A5%E8%AF%A2external_userid
+     * @param unionid
+     * @param openid
+     * @param corpid
+     * @returns
+     */
+    unionidToexternalUserid3rd(unionid: string, openid: string, corpid?: string): Promise<any>;
+    /**
+     * 客户群opengid转换
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94822
+     * @param opengid
+     * @returns
+     */
+    opengidToChatid(opengid: string): Promise<any>;
 }

package/dist/Work/ExternalContact/Client.js

@@ -5,43 +5,105 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
 class ExternalContactClient extends BaseClient_1.default {
+    /**
+     * 获取配置了客户联系功能的成员列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91554
+     * @returns
+     */
     getFollowUsers() {
         return this.httpGet('cgi-bin/externalcontact/get_follow_user_list');
     }
+    /**
+     * 获取外部联系人列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91555
+     * @param userId
+     * @returns
+     */
     list(userId) {
         return this.httpGet('cgi-bin/externalcontact/list', {
             userid: userId,
         });
     }
+    /**
+     * 获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91556
+     * @param externalUserId
+     * @returns
+     */
     get(externalUserId) {
         return this.httpGet('cgi-bin/externalcontact/get', {
             external_userid: externalUserId,
         });
     }
-    batchGet(userId, cursor = '', limit = 1) {
+    /**
+     * 批量获取客户详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92994
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGet(userIdList, cursor = '', limit = 1) {
         return this.httpPostJson('cgi-bin/externalcontact/batch/get_by_user', {
-            userid: userId,
+            userid_list: userIdList,
             cursor,
             limit,
         });
     }
-    batchGetByUser(userId, cursor = '', limit = 1) {
+    /**
+     * 批量获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93010
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGetByUser(userIdList, cursor = '', limit = 1) {
         return this.httpPostJson('cgi-bin/externalcontact/batch/get_by_user', {
-            userid: userId,
+            userid_list: userIdList,
             cursor,
             limit,
         });
     }
+    /**
+     * 修改客户备注信息
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92115
+     * @param data
+     * @returns
+     */
     remark(data) {
         return this.httpPostJson('cgi-bin/externalcontact/remark', data);
     }
+    /**
+     * 获取离职成员的客户列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92124
+     * @param pageId
+     * @param pageSize
+     * @param cursor
+     * @returns
+     */
     getUnassigned(pageId = 0, pageSize = 1000, cursor = null) {
-        return this.httpPostJson('cgi-bin/externalcontact/get_unassigned_list', {
+        let params = {
             page_id: pageId,
             page_size: pageSize,
             cursor,
+        };
+        Object.keys(params).map(key => {
+            if (params[key] === null || params[key] === undefined) {
+                delete params[key];
+            }
         });
+        return this.httpPostJson('cgi-bin/externalcontact/get_unassigned_list', params);
     }
+    /**
+     * 离职成员的外部联系人再分配
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91564
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transfer(externalUserId, handoverUserId, takeoverUserId, transferSuccessMessage) {
         return this.httpPostJson('cgi-bin/externalcontact/transfer', {
             external_userid: externalUserId,
@@ -50,6 +112,15 @@ class ExternalContactClient extends BaseClient_1.default {
             transfer_success_msg: transferSuccessMessage,
         });
     }
+    /**
+     * 分配在职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92125
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transferCustomer(externalUserId, handoverUserId, takeoverUserId, transferSuccessMessage) {
         return this.httpPostJson('cgi-bin/externalcontact/transfer_customer', {
             external_userid: externalUserId,
@@ -58,6 +129,14 @@ class ExternalContactClient extends BaseClient_1.default {
             transfer_success_msg: transferSuccessMessage,
         });
     }
+    /**
+     * 分配离职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94081
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     resignedTransferCustomer(externalUserId, handoverUserId, takeoverUserId) {
         return this.httpPostJson('cgi-bin/externalcontact/resigned/transfer_customer', {
             external_userid: externalUserId,
@@ -65,12 +144,27 @@ class ExternalContactClient extends BaseClient_1.default {
             takeover_userid: takeoverUserId,
         });
     }
+    /**
+     * 离职成员的群再分配
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92127
+     * @param chatIds
+     * @param newOwner
+     * @returns
+     */
     transferGroupChat(chatIds, newOwner) {
         return this.httpPostJson('cgi-bin/externalcontact/groupchat/transfer', {
             chat_id_list: chatIds,
             new_owner: newOwner,
         });
     }
+    /**
+     * 查询客户接替状态
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94082
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param cursor
+     * @returns
+     */
     transferResult(handoverUserId, takeoverUserId, cursor = null) {
         return this.httpPostJson('cgi-bin/externalcontact/resigned/transfer_result', {
             handover_userid: handoverUserId,
@@ -78,6 +172,14 @@ class ExternalContactClient extends BaseClient_1.default {
             cursor,
         });
     }
+    /**
+     * 查询客户接替结果
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93009
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     getTransferResult(externalUserId, handoverUserId, takeoverUserId) {
         return this.httpPostJson('cgi-bin/externalcontact/get_transfer_result', {
             external_userid: externalUserId,
@@ -85,23 +187,58 @@ class ExternalContactClient extends BaseClient_1.default {
             takeover_userid: takeoverUserId,
         });
     }
+    /**
+     * 获取客户群列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92120
+     * @param data
+     * @returns
+     */
     getGroupChats(data) {
         return this.httpPostJson('cgi-bin/externalcontact/groupchat/list', data);
     }
-    getGroupChat(chatId) {
+    /**
+     * 获取客户群详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92122
+     * @param chatId
+     * @param needName
+     * @returns
+     */
+    getGroupChat(chatId, needName = 0) {
         return this.httpPostJson('cgi-bin/externalcontact/groupchat/get', {
             chat_id: chatId,
+            need_name: needName,
         });
     }
+    /**
+     * 获取企业标签库
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#获取企业标签库
+     * @param tagIds
+     * @param groupIds
+     * @returns
+     */
     getCorpTags(tagIds, groupIds) {
         return this.httpPostJson('cgi-bin/externalcontact/get_corp_tag_list', {
             tag_id: tagIds,
             group_id: groupIds,
         });
     }
+    /**
+     * 添加企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#添加企业客户标签
+     * @param data
+     * @returns
+     */
     addCorpTag(data) {
         return this.httpPostJson('cgi-bin/externalcontact/add_corp_tag', data);
     }
+    /**
+     * 编辑企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#编辑企业客户标签
+     * @param id
+     * @param name
+     * @param order
+     * @returns
+     */
     updateCorpTag(id, name = null, order = null) {
         let params = {
             id,
@@ -114,14 +251,99 @@ class ExternalContactClient extends BaseClient_1.default {
         }
         return this.httpPostJson('cgi-bin/externalcontact/edit_corp_tag', params);
     }
+    /**
+     * 删除企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#删除企业客户标签
+     * @param tagId
+     * @param groupId
+     * @returns
+     */
     deleteCorpTag(tagId, groupId) {
         return this.httpPostJson('cgi-bin/externalcontact/del_corp_tag', {
             tag_id: tagId,
             group_id: groupId,
         });
     }
+    /**
+     * 编辑客户企业标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92118
+     * @param data
+     * @returns
+     */
     markTags(data) {
         return this.httpPostJson('cgi-bin/externalcontact/mark_tag', data);
     }
+    /**
+     * 外部联系人unionid转换
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93274
+     * @param unionid 微信客户的unionid
+     * @param openid 微信客户的openid
+     * @returns
+     */
+    unionidToExternalUserid(unionid = null, openid = null) {
+        return this.httpPostJson('cgi-bin/externalcontact/unionid_to_external_userid', {
+            unionid,
+            openid,
+        });
+    }
+    /**
+     * 代开发应用external_userid转换
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/95195
+     * @param unionid 微信客户的unionid
+     * @returns
+     */
+    toServiceExternalUserid(externalUserid) {
+        return this.httpPostJson('cgi-bin/externalcontact/to_service_external_userid', {
+            external_userid: externalUserid,
+        });
+    }
+    /**
+     * 转换external_userid
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#%E8%BD%AC%E6%8D%A2external_userid
+     * @param externalUserIds
+     * @returns
+     */
+    getNewExternalUserid(externalUserIds) {
+        return this.httpPostJson('cgi-bin/externalcontact/get_new_external_userid', {
+            external_userid_list: externalUserIds,
+        });
+    }
+    /**
+     * 设置迁移完成
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#%E8%AE%BE%E7%BD%AE%E8%BF%81%E7%A7%BB%E5%AE%8C%E6%88%90
+     * @param corpid
+     * @returns
+     */
+    finishExternalUseridMigration(corpid) {
+        return this.httpPostJson('cgi-bin/externalcontact/finish_external_userid_migration', {
+            corpid,
+        });
+    }
+    /**
+     * unionid查询external_userid
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#4.2%20unionid%E6%9F%A5%E8%AF%A2external_userid
+     * @param unionid
+     * @param openid
+     * @param corpid
+     * @returns
+     */
+    unionidToexternalUserid3rd(unionid, openid, corpid = '') {
+        return this.httpPostJson('cgi-bin/externalcontact/unionid_to_external_userid_3rd', {
+            unionid,
+            openid,
+            corpid,
+        });
+    }
+    /**
+     * 客户群opengid转换
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94822
+     * @param opengid
+     * @returns
+     */
+    opengidToChatid(opengid) {
+        return this.httpPostJson('cgi-bin/externalcontact/opengid_to_chatid', {
+            opengid,
+        });
+    }
 }
 exports.default = ExternalContactClient;

package/dist/Work/ExternalContact/ContactWayClient.js

@@ -7,7 +7,7 @@ const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
 const Utils_1 = require("../../Core/Utils");
 class ContactWayClient extends BaseClient_1.default {
     create(type, scene, config) {
-        let params = Utils_1.merge({
+        let params = (0, Utils_1.merge)({
             type,
             scene,
         }, config);
@@ -19,7 +19,7 @@ class ContactWayClient extends BaseClient_1.default {
         });
     }
     update(configId, config) {
-        let params = Utils_1.merge({
+        let params = (0, Utils_1.merge)({
             config_id: configId,
         }, config);
         return this.httpPostJson('cgi-bin/externalcontact/update_contact_way', params);

package/dist/Work/ExternalContact/MessageClient.d.ts

@@ -5,8 +5,53 @@ export default class MessageClient extends BaseClient {
     protected imageMessage: object;
     protected linkMessage: object;
     protected miniprogramMessage: object;
+    /**
+     * 添加企业群发消息模板
+     * @param msg
+     * @returns
+     */
     submit(msg: object): Promise<any>;
+    /**
+     * 获取企业群发消息发送结果
+     * @param msgId
+     * @returns
+     */
     get(msgId: string): Promise<any>;
+    /**
+     * 获取群发记录列表
+     * @param chatType 群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群
+     * @param startTime 群发任务记录开始时间
+     * @param endTime 群发任务记录结束时间
+     * @param creator 群发任务创建人企业账号id
+     * @param filterType 创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型
+     * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值
+     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
+     * @returns
+     */
+    getGroupmsgListV2(chatType: string, startTime: number, endTime: number, creator?: string, filterType?: number, limit?: number, cursor?: string): Promise<any>;
+    /**
+     * 获取群发成员发送任务列表
+     * @param msgId 群发消息的id，通过获取群发记录列表接口返回
+     * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值
+     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
+     * @returns
+     */
+    getGroupmsgTask(msgId: string, limit?: number, cursor?: string): Promise<any>;
+    /**
+     * 获取企业群发成员执行结果
+     * @param msgId 群发消息的id，通过获取群发记录列表接口返回
+     * @param userId 发送成员userid，通过获取群发成员发送任务列表接口返回
+     * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值
+     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
+     * @returns
+     */
+    getGroupmsgSendResult(msgId: string, userId: string, limit?: number, cursor?: string): Promise<any>;
+    /**
+     * 发送新客户欢迎语
+     * @param welcomeCode
+     * @param msg
+     * @returns
+     */
     sendWelcome(welcomeCode: string, msg: object): Promise<any>;
     protected formatMessage(data: object): object;
     protected formatFields(data: object, defaults: object): object;