Getting Started with Twilio APIs

Introduction

This is the public Twilio REST API.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 30000 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | basicAuthCredentials | BasicAuthCredentials | The credential object for basicAuth |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client, Environment, LogLevel } from 'twilio-api-sdk';

const client = new Client({
  basicAuthCredentials: {
    username: 'BasicAuthUserName',
    password: 'BasicAuthPassword'
  },
  timeout: 30000,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'twilio-api-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'twilio-api-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

| Name | Description | | --- | --- | | Production | Default |

Authorization

This API uses the following authentication schemes.

• accountSid_authToken (Basic Authentication)

List of APIs

• Accounts V1 Auth Token Promotion
• Accounts V1 Aws
• Accounts V1 Bulk Consents
• Accounts V1 Bulk Contacts
• Accounts V1 Messaging Geopermissions
• Accounts V1 Public Key
• Accounts V1 Safelist
• Accounts V1 Secondary Auth Token
• Chat V3 Channel
• Conversations V1 Address Configuration
• Conversations V1 Binding
• Conversations V1 Configuration
• Conversations V1 Conversation
• Conversations V1 Conversation with Participants
• Conversations V1 Credential
• Conversations V1 Delivery Receipt
• Conversations V1 Message
• Conversations V1 Notification
• Conversations V1 Participant
• Conversations V1 Participant Conversation
• Conversations V1 Role
• Conversations V1 Service
• Conversations V1 User
• Conversations V1 User Conversation
• Conversations V1 Webhook
• Notify V1 Binding
• Notify V1 Credential
• Notify V1 Notification
• Notify V1 Service
• Taskrouter V1 Activity
• Taskrouter V1 Event
• Taskrouter V1 Task
• Taskrouter V1 Task Channel
• Taskrouter V1 Task Queue
• Taskrouter V1 Task Queue Bulk Real Time Statistics
• Taskrouter V1 Task Queue Cumulative Statistics
• Taskrouter V1 Task Queue Real Time Statistics
• Taskrouter V1 Task Queue Statistics
• Taskrouter V1 Task Queues Statistics
• Taskrouter V1 Task Reservation
• Taskrouter V1 Worker
• Taskrouter V1 Worker Channel
• Taskrouter V1 Worker Reservation
• Taskrouter V1 Worker Statistics
• Taskrouter V1 Workers Cumulative Statistics
• Taskrouter V1 Workers Real Time Statistics
• Taskrouter V1 Workers Statistics
• Taskrouter V1 Workflow
• Taskrouter V1 Workflow Cumulative Statistics
• Taskrouter V1 Workflow Real Time Statistics
• Taskrouter V1 Workflow Statistics
• Taskrouter V1 Workspace
• Taskrouter V1 Workspace Cumulative Statistics
• Taskrouter V1 Workspace Real Time Statistics
• Taskrouter V1 Workspace Statistics
• Verify V2 Service
• Verify V2 Verification
• Verify V2 Verification Check
• SMS

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError