Class SmsService

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

Readonlybatches

ReadonlydeliveryReports

Readonlygroups

Readonlyinbounds

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