Serendip Framework > Sms > SerendipSmsService
SerendipSmsService
⊕ new SerendipSmsService(): SerendipSmsService
Defined in src/sms/SerendipSmsService.ts:44
Returns: SerendipSmsService
● dependencies: string[] = ["DbService"]
Defined in src/sms/SerendipSmsService.ts:35
▸ credit(): Promise<number>
Defined in src/sms/SerendipSmsService.ts:96
Returns: Promise<number>
▸ getToken(): Promise<TokenModel>
Defined in src/sms/SerendipSmsService.ts:57
Returns: Promise<TokenModel>
▸ send(mobileNumbers: string[], message: string, model?: any, templateId?: string): Promise<Object>
Defined in src/sms/SerendipSmsService.ts:129
Parameters:
| Name | Type |
|---|---|
| mobileNumbers | string[] |
| message | string |
Optional model |
any |
Optional templateId |
string |
Returns: Promise<Object>
▸ sendAuthCode(mobileNumber: string, code: string, useragent?: string, ip?: string, templateId?: string): Promise<Object>
Defined in src/sms/SerendipSmsService.ts:117
Parameters:
| Name | Type |
|---|---|
| mobileNumber | string |
| code | string |
Optional useragent |
string |
Optional ip |
string |
Optional templateId |
string |
Returns: Promise<Object>
▸ start(): Promise<void>
Implementation of ServerServiceInterface.start
Defined in src/sms/SerendipSmsService.ts:163
Returns: Promise<void>
▸ configure(options: SerendipSmsService): void
Defined in src/sms/SerendipSmsService.ts:42
Parameters:
| Name | Type |
|---|---|
| options | SerendipSmsService |
Returns: void
options: object
Defined in src/sms/SerendipSmsService.ts:37
● password: string = ""
Defined in src/sms/SerendipSmsService.ts:39
● username: string = ""
Defined in src/sms/SerendipSmsService.ts:38