Class SmsService

The SMS Service exposes the following APIs:

groups
batches
inbounds
deliveryReports

Index

Constructors

Properties

batches deliveryReports groups inbounds lazyClient

Methods

setApiClientConfig setCredentials setHostname setRegion

Constructors

constructor

new SmsService(params: SinchClientParameters): SmsService
Create a new SmsService instance with its configuration. This service can be instantiated with 2 different authentication mechanisms:
- OAuth2: the required properties are projectId, keyId and keySecret
- API Token: the required properties are servicePlanId and apiToken
Other supported properties:
- smsRegion
- smsHostname
- forceOAuth2ForSmsApi
- forceServicePlanIdUsageForSmsApi
Parameters
- params: SinchClientParameters
  an Object containing the necessary properties to initialize the service
Returns SmsService

Properties

`Readonly`batches

batches: BatchesApi

`Readonly`deliveryReports

deliveryReports: DeliveryReportsApi

`Readonly`groups

groups: GroupsApi

`Readonly`inbounds

inbounds: InboundsApi

`Readonly`lazyClient

lazyClient: LazySmsApiClient

Methods

setApiClientConfig

setApiClientConfig(newParams: SinchClientParameters): void
Parameters
- newParams: SinchClientParameters
Returns void

setCredentials

setCredentials(credentials: Partial<UnifiedCredentials>): void
Parameters
- credentials: Partial<UnifiedCredentials>
Returns void

setHostname

setHostname(hostname: string): void
Update the default hostname for each API
Parameters
- hostname: string
  The new hostname to use for all the APIs.
Returns void

setRegion

setRegion(region: string): void
Update the current region for each API
Parameters
- region: string
  The new region to use in the production URL
Returns void