Class Sms

Hierarchy

UrlSection
- Sms

Index

Constructors

constructor

Methods

Constructors

constructor

new Sms(prv: PathSegment, id?: string, service?: any): Sms

Overrides UrlSection.constructor
- Defined in paths/Sms.ts:6
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Sms

Methods

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

post

post(body: CreateSmsMessage): Promise<GetMessageInfoResponse>

- Defined in paths/Sms.ts:14
Since 1.0.2
Creates and sends new SMS message. Sending SMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications.
Required Permissions
Permission Description
SMS Sending and receiving SMS (text) messages
ReadMessages Viewing user messages
Usage Plan Group
Medium

Parameters
- body: CreateSmsMessage
Returns Promise<GetMessageInfoResponse>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc