bandwidth_sdk

Bandwidth's Communication APIs

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://dev.bandwidth.com

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bandwidth/python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bandwidth/python-sdk.git)

Then import the package:

import bandwidth

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import bandwidth

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import bandwidth
from bandwidth.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = bandwidth.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = bandwidth.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure your client ID and secret for OAuth
configuration = bandwidth.Configuration(
    client_id = os.environ["CLIENT_ID"],
    client_secret = os.environ["CLIENT_SECRET"]
)


# Enter a context with an instance of the API client
with bandwidth.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bandwidth.CallsApi(api_client)
    account_id = '9900000' # str | Your Bandwidth Account ID.
    create_call = bandwidth.CreateCall() # CreateCall | JSON object containing information to create an outbound call

    try:
        # Create Call
        api_response = api_instance.create_call(account_id, create_call)
        print("The response of CallsApi->create_call:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CallsApi->create_call: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CallsApi	create_call	POST /accounts/{accountId}/calls	Create Call
CallsApi	get_call_state	GET /accounts/{accountId}/calls/{callId}	Get Call State Information
CallsApi	list_calls	GET /accounts/{accountId}/calls	Get Calls
CallsApi	update_call	POST /accounts/{accountId}/calls/{callId}	Update Call
CallsApi	update_call_bxml	PUT /accounts/{accountId}/calls/{callId}/bxml	Update Call BXML
ConferencesApi	download_conference_recording	GET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media	Download Conference Recording
ConferencesApi	get_conference	GET /accounts/{accountId}/conferences/{conferenceId}	Get Conference Information
ConferencesApi	get_conference_member	GET /accounts/{accountId}/conferences/{conferenceId}/members/{memberId}	Get Conference Member
ConferencesApi	get_conference_recording	GET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}	Get Conference Recording Information
ConferencesApi	list_conference_recordings	GET /accounts/{accountId}/conferences/{conferenceId}/recordings	Get Conference Recordings
ConferencesApi	list_conferences	GET /accounts/{accountId}/conferences	Get Conferences
ConferencesApi	update_conference	POST /accounts/{accountId}/conferences/{conferenceId}	Update Conference
ConferencesApi	update_conference_bxml	PUT /accounts/{accountId}/conferences/{conferenceId}/bxml	Update Conference BXML
ConferencesApi	update_conference_member	PUT /accounts/{accountId}/conferences/{conferenceId}/members/{memberId}	Update Conference Member
EndpointsApi	create_endpoint	POST /accounts/{accountId}/endpoints	Create Endpoint
EndpointsApi	delete_endpoint	DELETE /accounts/{accountId}/endpoints/{endpointId}	Delete Endpoint
EndpointsApi	get_endpoint	GET /accounts/{accountId}/endpoints/{endpointId}	Get Endpoint
EndpointsApi	list_endpoints	GET /accounts/{accountId}/endpoints	List Endpoints
EndpointsApi	update_endpoint_bxml	PUT /accounts/{accountId}/endpoints/{endpointId}/bxml	Update Endpoint BXML
MFAApi	generate_messaging_code	POST /accounts/{accountId}/code/messaging	Messaging Authentication Code
MFAApi	generate_voice_code	POST /accounts/{accountId}/code/voice	Voice Authentication Code
MFAApi	verify_code	POST /accounts/{accountId}/code/verify	Verify Authentication Code
MediaApi	delete_media	DELETE /users/{accountId}/media/{mediaId}	Delete Media
MediaApi	get_media	GET /users/{accountId}/media/{mediaId}	Get Media
MediaApi	list_media	GET /users/{accountId}/media	List Media
MediaApi	upload_media	PUT /users/{accountId}/media/{mediaId}	Upload Media
MessagesApi	create_message	POST /users/{accountId}/messages	Create Message
MessagesApi	list_messages	GET /users/{accountId}/messages	List Messages
MultiChannelApi	create_multi_channel_message	POST /users/{accountId}/messages/multiChannel	Create Multi-Channel Message
PhoneNumberLookupApi	create_async_bulk_lookup	POST /accounts/{accountId}/phoneNumberLookup/bulk	Create Asynchronous Bulk Number Lookup
PhoneNumberLookupApi	create_sync_lookup	POST /accounts/{accountId}/phoneNumberLookup	Create Synchronous Number Lookup
PhoneNumberLookupApi	get_async_bulk_lookup	GET /accounts/{accountId}/phoneNumberLookup/bulk/{requestId}	Get Asynchronous Bulk Number Lookup
RecordingsApi	delete_recording	DELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}	Delete Recording
RecordingsApi	delete_recording_media	DELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media	Delete Recording Media
RecordingsApi	delete_recording_transcription	DELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription	Delete Transcription
RecordingsApi	download_call_recording	GET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media	Download Recording
RecordingsApi	get_call_recording	GET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}	Get Call Recording
RecordingsApi	get_recording_transcription	GET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription	Get Transcription
RecordingsApi	list_account_call_recordings	GET /accounts/{accountId}/recordings	Get Call Recordings
RecordingsApi	list_call_recordings	GET /accounts/{accountId}/calls/{callId}/recordings	List Call Recordings
RecordingsApi	transcribe_call_recording	POST /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription	Create Transcription Request
RecordingsApi	update_call_recording_state	PUT /accounts/{accountId}/calls/{callId}/recording	Update Recording
StatisticsApi	get_statistics	GET /accounts/{accountId}/statistics	Get Account Statistics
TollFreeVerificationApi	create_webhook_subscription	POST /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions	Create Webhook Subscription
TollFreeVerificationApi	delete_verification_request	DELETE /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification	Delete a Toll-Free Verification Submission
TollFreeVerificationApi	delete_webhook_subscription	DELETE /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}	Delete Webhook Subscription
TollFreeVerificationApi	get_toll_free_verification_status	GET /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification	Get Toll-Free Verification Status
TollFreeVerificationApi	list_toll_free_use_cases	GET /tollFreeVerification/useCases	List Toll-Free Use Cases
TollFreeVerificationApi	list_webhook_subscriptions	GET /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions	List Webhook Subscriptions
TollFreeVerificationApi	request_toll_free_verification	POST /accounts/{accountId}/tollFreeVerification	Request Toll-Free Verification
TollFreeVerificationApi	update_toll_free_verification_request	PUT /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification	Update Toll-Free Verification Request
TollFreeVerificationApi	update_webhook_subscription	PUT /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}	Update Webhook Subscription
TranscriptionsApi	delete_real_time_transcription	DELETE /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}	Delete Real-time Transcription
TranscriptionsApi	get_real_time_transcription	GET /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}	Get Real-time Transcription
TranscriptionsApi	list_real_time_transcriptions	GET /accounts/{accountId}/calls/{callId}/transcriptions	List Real-time Transcriptions

Documentation For Models

• AccountStatistics
• AdditionalDenialReason
• Address
• AnswerCallback
• AsyncLookupRequest
• BlockedWebhook
• BridgeCompleteCallback
• BridgeTargetCompleteCallback
• BusinessEntityTypeEnum
• BusinessRegistrationTypeEnum
• CallDirectionEnum
• CallRecordingMetadata
• CallState
• CallStateEnum
• CallTranscription
• CallTranscriptionDetectedLanguageEnum
• CallTranscriptionMetadata
• CallTranscriptionResponse
• CallTranscriptionTrackEnum
• Callback
• CallbackMethodEnum
• CardWidthEnum
• CodeRequest
• CompletedLookupStatusEnum
• Conference
• ConferenceCompletedCallback
• ConferenceCreatedCallback
• ConferenceMember
• ConferenceMemberExitCallback
• ConferenceMemberJoinCallback
• ConferenceRecordingAvailableCallback
• ConferenceRecordingMetadata
• ConferenceRedirectCallback
• ConferenceStateEnum
• Contact
• CreateAsyncBulkLookupResponse
• CreateAsyncBulkLookupResponseData
• CreateCall
• CreateCallResponse
• CreateEndpointRequestBase
• CreateEndpointResponse
• CreateEndpointResponseData
• CreateMessageRequestError
• CreateMultiChannelMessageResponse
• CreateSyncLookupResponse
• CreateSyncLookupResponseData
• CreateWebRtcConnectionRequest
• DeactivationEventEnum
• Device
• DeviceStatusEnum
• DisconnectCallback
• Diversion
• DtmfCallback
• Endpoint
• EndpointDirectionEnum
• EndpointEvent
• EndpointEventTypeEnum
• EndpointResponse
• EndpointStatusEnum
• EndpointTypeEnum
• Endpoints
• Error
• ErrorObject
• ErrorResponse
• ErrorSource
• FailureWebhook
• FieldError
• FileFormatEnum
• GatherCallback
• GetAsyncBulkLookupResponse
• GetAsyncBulkLookupResponseData
• InProgressLookupStatusEnum
• InboundCallback
• InboundCallbackMessage
• InboundCallbackTypeEnum
• InitiateCallback
• LatestMessageDeliveryStatusEnum
• LineTypeEnum
• Link
• LinkSchema
• LinksObject
• ListEndpointsResponse
• ListMessageDirectionEnum
• ListMessageItem
• LookupErrorResponse
• LookupErrorSchema
• LookupErrorSchemaMeta
• LookupResult
• MachineDetectionCompleteCallback
• MachineDetectionConfiguration
• MachineDetectionModeEnum
• MachineDetectionResult
• Media
• Message
• MessageDirectionEnum
• MessageRequest
• MessageStatusEnum
• MessageTypeEnum
• MessagesList
• MessagingCodeResponse
• MessagingRequestError
• MfaForbiddenRequestError
• MfaRequestError
• MfaUnauthorizedRequestError
• MmsMessageContent
• MmsMessageContentFile
• MultiChannelAction
• MultiChannelActionCalendarEvent
• MultiChannelChannelListMMSObject
• MultiChannelChannelListMMSResponseObject
• MultiChannelChannelListObjectBase
• MultiChannelChannelListOwnerObject
• MultiChannelChannelListRBMObject
• MultiChannelChannelListRBMObjectAllOfContent
• MultiChannelChannelListRBMResponseObject
• MultiChannelChannelListRequestObject
• MultiChannelChannelListResponseObject
• MultiChannelChannelListSMSObject
• MultiChannelChannelListSMSResponseObject
• MultiChannelError
• MultiChannelMessageChannelEnum
• MultiChannelMessageContent
• MultiChannelMessageRequest
• MultiChannelMessageResponseData
• OptInWorkflow
• Page
• PageInfo
• PriorityEnum
• ProductTypeEnum
• RbmActionBase
• RbmActionDial
• RbmActionOpenUrl
• RbmActionTypeEnum
• RbmActionViewLocation
• RbmCardContent
• RbmCardContentMedia
• RbmLocationResponse
• RbmMediaHeightEnum
• RbmMessageCarouselCard
• RbmMessageContentFile
• RbmMessageContentRichCard
• RbmMessageContentText
• RbmMessageMedia
• RbmOpenUrlEnum
• RbmStandaloneCard
• RbmSuggestionResponse
• RbmWebViewEnum
• RecordingAvailableCallback
• RecordingCompleteCallback
• RecordingStateEnum
• RecordingTranscriptionMetadata
• RecordingTranscriptions
• RedirectCallback
• RedirectMethodEnum
• SipConnectionMetadata
• SipCredentials
• SmsMessageContent
• StandaloneCardOrientationEnum
• StatusCallback
• StatusCallbackMessage
• StatusCallbackTypeEnum
• StirShaken
• SyncLookupRequest
• TelephoneNumber
• TfvBasicAuthentication
• TfvCallbackStatusEnum
• TfvError
• TfvStatus
• TfvStatusEnum
• TfvSubmissionInfo
• TfvSubmissionWrapper
• ThumbnailAlignmentEnum
• TranscribeRecording
• Transcription
• TranscriptionAvailableCallback
• TransferAnswerCallback
• TransferCompleteCallback
• TransferDisconnectCallback
• UpdateCall
• UpdateCallRecording
• UpdateConference
• UpdateConferenceMember
• VerificationDenialWebhook
• VerificationRequest
• VerificationUpdateRequest
• VerificationWebhook
• VerifyCodeRequest
• VerifyCodeResponse
• VoiceApiError
• VoiceCodeResponse
• WebhookSubscription
• WebhookSubscriptionBasicAuthentication
• WebhookSubscriptionRequestSchema
• WebhookSubscriptionTypeEnum
• WebhookSubscriptionsListBody

Documentation For Authorization

Authentication schemes defined for the API:

Basic

• Type: HTTP basic authentication

OAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Author

letstalk@bandwidth.com