twilio-api-sdk 1.0.0

twilio api sdk

Getting Started with Twilio APIs

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install twilio-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/twilio-api-sdk/1.0.0

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
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 30
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
basic_auth_credentials	BasicAuthCredentials	The credential object for Basic Authentication

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from twilioapis.configuration import Environment
from twilioapis.http.auth.basic_auth import BasicAuthCredentials
from twilioapis.logging.configuration.api_logging_configuration import LoggingConfiguration
from twilioapis.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from twilioapis.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from twilioapis.twilioapis_client import TwilioapisClient

client = TwilioapisClient(
    basic_auth_credentials=BasicAuthCredentials(
        username='BasicAuthUserName',
        password='BasicAuthPassword'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from twilioapis.twilioapis_client import TwilioapisClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = TwilioapisClient.from_environment(dotenv_path='/path/to/.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

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime