@tnwx/wxcp/dist/QyAppChatApi.d.ts

TNWX 微信系开发脚手架之极速开发企业微信/企业号

import { QyTextMsg, QyImageMsg, QyVoiceMsg, QyVideoMsg, QyFileMsg, QyTextCardMsg, QyNewsMsg, QyMpNewsMsg, QyMarkDownMsg } from '.';
/**
 * @author Javen
 * @copyright javendev@126.com
 * @description 群聊
 */
export declare class QyAppChatApi {
    private static createUrl;
    /**
     * 创建群聊会话
     * @param userList 群成员id列表。至少2人，至多500人
     * @param owner 指定群主的id。如果不指定，系统会随机从userlist中选一人作为群主
     * @param name 群聊名，最多50个utf8字符，超过将截断
     * @param chatId 群聊的唯一标志，不能与已有的群重复；字符串类型，最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填，系统会随机生成群id
     */
    static create(userList: Array<string>, owner?: string, name?: string, chatId?: string): Promise<any>;
    private static updateUrl;
    /**
     * 修改群聊会话
     * @param chatId 群聊id
     * @param addUserList 添加成员的id列表
     * @param delUserList 踢出成员的id列表
     * @param owner 新群主的id
     * @param name 新的群聊名
     */
    static update(chatId: string, addUserList?: Array<string>, delUserList?: Array<string>, owner?: string, name?: string): Promise<any>;
    private static getUrl;
    /**
     * 获取群聊会话
     * @param chatId 群聊id
     */
    static get(chatId: string): Promise<any>;
    private static sendUrl;
    /**
     * 应用推送消息
     * @param jsonData 请求数据
     */
    static send(jsonData: string): Promise<any>;
    private static sendLinkedCorpUrl;
    /**
     * 互联企业消息推送
     * @param jsonData 请求数据
     */
    static sendLinkedCorpMsg(jsonData: string): Promise<any>;
    /**
     * 发送文本消息
     * @param {QyTextMsg} text
     */
    static sendTextMessage(text: QyTextMsg): Promise<any>;
    /**
     * 发送图片消息
     * @param {QyImageMsg} image
     */
    static sendImageMessage(image: QyImageMsg): Promise<any>;
    /**
     * 发送语音消息
     * @param voice
     */
    static sendVoiceMessage(voice: QyVoiceMsg): Promise<any>;
    /**
     * 发送视频消息
     * @param video
     */
    static sendVideoMessage(video: QyVideoMsg): Promise<any>;
    /**
     * 发送文件消息
     * @param file
     */
    static sendFileMessage(file: QyFileMsg): Promise<any>;
    /**
     * 文本卡片消息
     * @param textCard
     */
    static sendTextCardMessage(textCard: QyTextCardMsg): Promise<any>;
    /**
     * 图文消息
     * @param news
     */
    static sendNewsMessage(news: QyNewsMsg): Promise<any>;
    /**
     * 图文消息
     * @param mpnews
     */
    static sendMpNewsMessage(mpnews: QyMpNewsMsg): Promise<any>;
    /**
     * markdown 消息
     * @param markdown
     */
    static sendMarkDownMessage(markdown: QyMarkDownMsg): Promise<any>;
}