oak-general-business/es/types/Sms.d.ts

33 lines
805 B
TypeScript

import { EntityDict } from '../oak-app-domain';
import { BRC } from '../types/RuntimeCxt';
/**
* 短信发送及模板同步
*/
export default interface Sms<ED extends EntityDict> {
name: string;
/**
* 是否支持模板同步
*/
syncTemplate(options: {
systemId: string;
pageIndex?: number;
pageSize?: number;
international?: 0 | 1;
}, context: BRC<ED>): Promise<{
templateName: string;
templateCode: string;
templateContent: string;
}[]>;
/**
* 短信发送
*/
sendSms(params: {
mobile: string;
templateParam?: Record<string, any>;
smsTemplate: Partial<ED['smsTemplate']['Schema']>;
}, context: BRC<ED>): Promise<{
success: boolean;
res: any;
}>;
}