Sinch Node.js SDK - v1.0.0
    Preparing search index...

    Interface SinchClientParameters

    Global object that holds the API configuration. Be careful to follow the guidelines defined by the API Services about which parameters are required for each API. Not all of them use the same authentication mechanism:

    • OAuth2: Conversation, Fax, Numbers and SMS (US and EU regions only)
    • API Token: SMS on all regions
    • Application Signed: Verification and Voice
    interface SinchClientParameters {
        apiToken?: string;
        applicationKey?: string;
        applicationSecret?: string;
        authHostname?: string;
        conversationHostname?: string;
        conversationRegion?: string;
        conversationTemplatesHostname?: string;
        faxHostname?: string;
        faxRegion?: string;
        forceOAuth2ForSmsApi?: boolean;
        forceServicePlanIdUsageForSmsApi?: boolean;
        keyId?: string;
        keySecret?: string;
        numbersHostname?: string;
        projectId?: string;
        requestPlugins?: RequestPlugin[];
        responsePlugins?: ResponsePlugin<any, { [key: string]: any }>[];
        servicePlanId?: string;
        smsHostname?: string;
        smsRegion?: string;
        verificationHostname?: string;
        voiceApplicationManagementHostname?: string;
        voiceHostname?: string;
        voiceRegion?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiToken? applicationKey? applicationSecret? authHostname? conversationHostname? conversationRegion? conversationTemplatesHostname? faxHostname? faxRegion? forceOAuth2ForSmsApi? forceServicePlanIdUsageForSmsApi? keyId? keySecret? numbersHostname? projectId? requestPlugins? responsePlugins? servicePlanId? smsHostname? smsRegion? verificationHostname? voiceApplicationManagementHostname? voiceHostname? voiceRegion?

    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

    authHostname?: string

    Override the hostname for the OAuth2 authentication API

    conversationHostname?: string

    Override the hostname for the Conversation API (not Conversation Templates) - Note the regions become ineffective

    conversationRegion?: string

    The region for the Conversation API. Default region is US

    conversationTemplatesHostname?: string

    Override the hostname for the Conversation Templates API - Note the regions become ineffective

    faxHostname?: string

    Override the hostname for the Fax API - Note the regions become ineffective

    faxRegion?: string

    The region for the Fax API. Default is auto-routing

    forceOAuth2ForSmsApi?: boolean

    boolean to force the usage of the OAuth2 authentication for the SMS API - to be used when a region other of US and EU supports OAuth2 but the SDK doesn't by default

    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.

    numbersHostname?: string

    Override the hostname for the Numbers API

    projectId?: string

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

    requestPlugins?: RequestPlugin[]

    Add more plugins to action on the request before it is sent

    responsePlugins?: ResponsePlugin<any, { [key: string]: any }>[]

    Add more plugins to action on the server response before it is returned in the Promise

    servicePlanId?: string

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

    smsHostname?: string

    Override the hostname for the SMS API - Note the regions become ineffective

    smsRegion?: string

    The region for the SMS API. Default region is US

    verificationHostname?: string

    Override the hostname for the Verification API

    voiceApplicationManagementHostname?: string

    Override the hostname for the Voice Application Management API

    voiceHostname?: string

    Override the hostname for the Voice API (not Voice Application Management) - Note the regions become ineffective

    voiceRegion?: string

    The region for the Voice API. Default is empty

    Settings

    Member Visibility

    On This Page

    Properties