Sinch Node.js SDK - v0.0.1
    Preparing search index...

    Interface SinchClientParameters

    interface SinchClientParameters {
        apiToken?: string;
        applicationKey?: string;
        applicationSecret?: string;
        forceServicePlanIdUsageForSmsApi?: boolean;
        keyId?: string;
        keySecret?: string;
        projectId?: string;
        region?: Region;
        servicePlanId?: string;
        voiceRegion?: VoiceRegion;
    }

    Hierarchy

    Index

    Properties

    apiToken?: string

    Your API token. You can find this on your Dashboard.

    applicationKey?: string

    Your Application key. You can find this on your Dashboard

    applicationSecret?: string

    Your Application secret. You can find this on your Dashboard

    forceServicePlanIdUsageForSmsApi?: boolean

    boolean to force the usage of the service plan Id + API token as credentials for the SMS API

    keyId?: string

    The client ID used for authentication. You can find this on your Dashboard.

    keySecret?: string

    The client secret used for authentication. You can find this ONLY when creating a new key.

    projectId?: string

    The project ID associated with the API Client. You can find this on your Dashboard.

    region?: Region

    The region for the SMS API. Default region is US

    servicePlanId?: string

    Your service plan ID. You can find this on your Dashboard.

    voiceRegion?: VoiceRegion

    The region for the Voice API. Default is empty