TwilioClientOpts
Defined in: lib/utils/twilio.interface.ts:38
Twilio SDK client configuration options.
Example
Section titled “Example”const options: TwilioClientOpts = { accountSid: 'ACxxxxxxx', authToken: 'auth_token_here', region: 'ie1', edge: 'sydney',};Extends
Section titled “Extends”ClientOpts
Extended by
Section titled “Extended by”Properties
Section titled “Properties”| Property | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
accountSid |
string |
Twilio Account SID. Required. | ClientOpts.accountSid |
- | lib/utils/twilio.interface.ts:42 |
apiKey? |
string |
Twilio API Key SID. Used in place of authToken for certain operations. | - | - | lib/utils/twilio.interface.ts:52 |
apiSecret? |
string |
Twilio API Key Secret. Required if apiKey is provided. | - | - | lib/utils/twilio.interface.ts:57 |
authToken? |
string |
Twilio Auth Token. Required when using auth-token authentication. | - | - | lib/utils/twilio.interface.ts:47 |
autoRetry? |
boolean |
- | - | ClientOpts.autoRetry |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:17 |
ca? |
string | Buffer<ArrayBufferLike> |
- | - | ClientOpts.ca |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:31 |
edge? |
string |
- | - | ClientOpts.edge |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:12 |
env? |
ProcessEnv |
- | - | ClientOpts.env |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:11 |
httpClient? |
RequestClient |
- | - | ClientOpts.httpClient |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:9 |
keepAlive? |
boolean |
- | - | ClientOpts.keepAlive |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:25 |
keepAliveMsecs? |
number |
- | - | ClientOpts.keepAliveMsecs |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:26 |
lazyLoading? |
boolean |
- | - | ClientOpts.lazyLoading |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:14 |
logLevel? |
string |
- | - | ClientOpts.logLevel |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:15 |
maxFreeSockets? |
number |
- | - | ClientOpts.maxFreeSockets |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:29 |
maxRetries? |
number |
- | - | ClientOpts.maxRetries |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:19 |
maxRetryDelay? |
number |
- | - | ClientOpts.maxRetryDelay |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:18 |
maxSockets? |
number |
- | - | ClientOpts.maxSockets |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:27 |
maxTotalSockets? |
number |
- | - | ClientOpts.maxTotalSockets |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:28 |
region? |
string |
- | - | ClientOpts.region |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:13 |
scheduling? |
"fifo" | "lifo" |
- | - | ClientOpts.scheduling |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:30 |
timeout? |
number |
https.Agent options | - | ClientOpts.timeout |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:24 |
userAgentExtensions? |
string[] |
- | - | ClientOpts.userAgentExtensions |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:16 |
validationClient? |
ValidationClientOptions |
- | - | ClientOpts.validationClient |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:20 |