@tnwx/commons/dist/api/ComSubscribeMsgApi.d.ts

TTNWX 微信系开发脚手架之公共模块

/**
 * @author Javen
 * @copyright javendev@126.com
 * @description 订阅通知接口
 */
export declare class ComSubscribeMsgApi {
    private static addTemplateUrl;
    private static delTemplateUrl;
    private static getCategoryUrl;
    private static getPubTemplateKeyWordsUrl;
    private static getPubTemplateTitlesUrl;
    private static getTemplateUrl;
    private static sendMessageUrl;
    /**
     * 组合模板并添加至帐号下的个人模板库
     * @param tid 模板标题 id
     * @param kidList 开发者自行组合好的模板关键词列表，最多支持5个，最少2个关键词组合
     * @param sceneDesc 服务场景描述，15个字以内
     */
    static addTemplate(tid: string, kidList: Array<Number>, sceneDesc?: string): Promise<any>;
    /**
     * 删除帐号下的个人模板
     * @param priTmplId 要删除的模板id
     */
    static delTemplate(priTmplId: string): Promise<any>;
    /**
     * 获取公众号类目
     */
    static getCategory(): Promise<any>;
    /**
     * 获取模板中的关键词
     * @param tid 模板标题 id
     */
    static getPubTemplateKeyWords(tid: string): Promise<any>;
    /**
     * 获取类目下的公共模板
     * @param ids 类目 id
     * @param start 用于分页，表示从 start 开始。从 0 开始计数。
     * @param limit 用于分页，表示拉取 limit 条记录。最大为 30。
     */
    static getPubTemplateTitles(ids: Array<Number>, start?: number, limit?: number): Promise<any>;
    /**
     * 获取私有模板列表
     */
    static getTemplate(): Promise<any>;
    /**
     * 发送订阅通知
     * @param touser 接收者（用户）的 openid
     * @param templateId 所需下发的订阅模板id
     * @param data 模板内容，格式形如 { "key1": { "value": any }, "key2": { "value": any } }
     * @param page 点击模板卡片后的跳转页面
     * @param miniprogram 跳转小程序时填写，格式如{ "appid": "pagepath": { "value": any } }
     */
    static sendSubMessage(touser: string, templateId: string, data: any, page?: string, miniprogram?: any): Promise<any>;
}