Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SmsService

短信服务

Hierarchy

  • InvisibleBase
    • SmsService

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • config: any

    Returns SmsService

Properties

className

className: string

后台短信实现类名

signName

signName: string

签名

templateId

templateId: string

模板ID

Methods

getAttrEditors

  • getAttrEditors(): AttributeEditorBase[]

  • Returns AttributeEditorBase[]

smsSend

  • 发送单个短信消息

    Parameters

    • msg: ISmsMessage

      ISmsMessage消息内容

    • callback: SmsSendCallbackHandle

      短信发送完成回调 参数err非空出现错误

    • Optional vcodekey: string

      可选参数 图形验证码唯一key

    • Optional vcode: string

      可选参数 图形验证码字符串

    Returns void

smsSendTemplateA

  • smsSendTemplateA(phone: string, tempParam: object, callback: SmsSendCallbackHandle, vcodekey?: string, vcode?: string): void

  • 发送模板消息

    Parameters

    • phone: string

      电话号码

    • tempParam: object

      模板变量

    • callback: SmsSendCallbackHandle

      短信发送完成回调 参数err非空出现错误

    • Optional vcodekey: string

      可选参数 图形验证码唯一key

    • Optional vcode: string

      可选参数 图形验证码字符串

    Returns void

smsSendTemplateB

  • smsSendTemplateB(phone: string, signName: string, tempId: string, tempParam: object, callback: SmsSendCallbackHandle, vcodekey?: string, vcode?: string): void

  • 发送模板消息

    Parameters

    • phone: string

      电话号码

    • signName: string

      签名

    • tempId: string

      模板id

    • tempParam: object

      模板变量

    • callback: SmsSendCallbackHandle

      短信发送完成回调 参数err非空出现错误

    • Optional vcodekey: string

      可选参数 图形验证码唯一key

    • Optional vcode: string

      可选参数 图形验证码字符串

    Returns void

smsSends

  • 发送短信消息数组 注意:如果 ISmsMessage消息的三大参数(signName,templateId,className)的为空时候的默认值 分别对应(this.signName,this.templateId,this.className)

    Parameters

    • msgs: ISmsMessage[]

      ISmsMessage消息数组

    • callback: SmsSendCallbackHandle

      短信发送完成回调 参数err非空出现错误

    • Optional vcodekey: string

      可选参数 图形验证码唯一key

    • Optional vcode: string

      可选参数 图形验证码字符串

    Returns void

Generated using TypeDoc