Python SDK

The Python SDK(s) are available via PyPi & Github

Links Description Github
bandwidth-sdk Manage Phone Calls with BXML, Create outbound calls, SMS messages, MMS messages
Code Examples Python code examples

Release Notes

Version Notes
6.0.0 Removed all messaging exceptions and normalized them under MessagingException
6.1.0 Updated Pause and SendDtmf BXML attributes
6.2.0 Added MFA functions
6.3.0 Added support for multi nested verbs in Gathers
6.4.0 Added support for Conference BXMl, Conference API Endpoints, and WebRTC
6.5.0 Updated WebRTC Permissions schema
6.6.0 Updated MFA schema to include digits and expirationTimeInMinutes
6.7.0 Added BXML Bridge verb
6.8.0 Updated WebRTC base URL
6.9.0 Added get conference endpoint
6.10.0 Added conference management endpoints

Download & Install

ℹ️ Note that bandwidth-sdk v5.x.x and greater will only support Bandwidth's v2 APIs. Please contact support to learn how to migrate to v2. For v1 installation instructions, please see old.dev.bandwidth.com.

pip install bandwidth-sdk

Initialize Bandwidth Client

from bandwidth.bandwidth_client import BandwidthClient
from bandwidth.configuration import Environment #Optional - Used for custom base URLs

from bandwidth.messaging.models.message_request import MessageRequest
from bandwidth.messaging.exceptions.messaging_exception import MessagingException

from bandwidth.voice.models.api_create_call_request import ApiCreateCallRequest
from bandwidth.voice.models.modify_call_recording_state import ModifyCallRecordingState
from bandwidth.voice.exceptions.api_error_response_exception import ApiErrorResponseException
from bandwidth.voice.bxml.response import Response
from bandwidth.voice.bxml.verbs import *

from bandwidth.twofactorauth.models.two_factor_code_request_schema import TwoFactorCodeRequestSchema
from bandwidth.twofactorauth.models.two_factor_verify_request_schema import TwoFactorVerifyRequestSchema

##Initialize client
voice_basic_auth_user_name = 'username'
voice_basic_auth_password = 'password'
messaging_basic_auth_user_name = 'token'
messaging_basic_auth_password = 'secret'
two_factor_auth_basic_auth_user_name = 'username'
two_factor_auth_basic_auth_password = 'password'

bandwidth_client = BandwidthClient(
    voice_basic_auth_user_name=voice_basic_auth_user_name,
    voice_basic_auth_password=voice_basic_auth_password,
    messaging_basic_auth_user_name=messaging_basic_auth_user_name,
    messaging_basic_auth_password=messaging_basic_auth_password,
    two_factor_auth_basic_auth_user_name=two_factor_auth_basic_auth_user_name,
    two_factor_auth_basic_auth_password=two_factor_auth_basic_auth_password,
    environment=Environment.CUSTOM, #Optional - Used for custom base URLs
    base_url="https://test.com" #Optional - Custom base URL set here
)

Create Phone Call

voice_client = bandwidth_client.voice_client.client
account_id = "1"

##Create phone call
body = ApiCreateCallRequest()
body.mfrom = "+17777777777"
body.to = "+16666666666"
body.application_id = "3-d-4-b-5"
body.answer_url = "https://test.com"

try:
    response = voice_client.create_call(account_id, body=body)
    print(response.body.call_id) #c-3f758f24-a59bb21e-4f23-4d62-afe9-53o2ls3o4saio4l
    print(response.status_code) #201
except ApiErrorResponseException as e:
    print(e.description) #Invalid from: must be an E164 telephone number
    print(e.response_code) #400

Generate BXML

response = Response()
speak_sentence = SpeakSentence(
    sentence="Test",
    voice="susan",
    locale="en_US",
    gender="female"
)

response.add_verb(speak_sentence)
print(response.to_bxml())

Send Text Message

messaging_client = bandwidth_client.messaging_client.client
account_id = "1"

body = MessageRequest()
body.application_id = "1-d-b"
body.to = ["+17777777777"]
body.mfrom = "+18888888888"
body.text = "Greetings!"

try:
    response = messaging_client.create_message(account_id, body=body)
    print(response.body.id) #1570819529611mexbyfr7ugrouuxy
    print(response.status_code) #202
except MessagingException as e:
    print(e.description) #Your request could not be accepted.
    print(e.response_code) #400

Order Phone Number

Coming soon

Perform A 2FA Request

auth_client = bandwidth_client.two_factor_auth_client.client
account_id = "1"

from_phone = "+18888888888"
to_phone = "+17777777777"
messaging_application_id = "1-d-b"
scope = "scope"
digits = 6

body = TwoFactorCodeRequestSchema(
    mfrom = from_phone,
    to = to_phone,
    application_id = messaging_application_id,
    scope = scope,
    digits = digits,
    message = "Your temporary {NAME} {SCOPE} code is {CODE}"
)
auth_client.create_messaging_two_factor(account_id, body)

code = "123456" #This is the user input to validate

body = TwoFactorVerifyRequestSchema(
    mfrom = from_phone,
    to = to_phone,
    application_id = application_id,
    scope = scope,
    code = code,
    digits = digits,
    expiration_time_in_minutes = 3
)
response = auth_client.create_verify_two_factor(account_id, body)
print("Auth status: " + str(response.body.valid))

Error Handling

All SDK methods can raise 2 types of exceptions based on the API response received.

The first type of exceptions are expected endpoint responses. The exception throw varies on each method and the corresponding http status code.

The second type of exceptions are unexpected endpoint responses. The exception throw will always be an APIException.

Error Handling Example: Messaging

<Other SDK import statements>
from bandwidth.messaging.exceptions.messaging_exception import MessagingException
from bandwidth.exceptions.api_exception import APIException

<client initialization code>

try:
    response = messaging_client.create_message(account_id, body=body)
except MessagingException as e:
    print(e.response_code) #http status code
    print(e.response.text) #raw response from api
except APIException as e:
    print(e.response_code) #http status code
    print(e.response.text) #raw response from api

results matching ""

    No results matching ""