Bandwidth's Communication APIs
This Python package is automatically generated by the OpenAPI Generator project:
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import bandwidth
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
Execute pytest to run the tests.
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"]
)
# 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)
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 |
| 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 |
| PhoneNumberLookupApi | create_lookup | POST /accounts/{accountId}/tnlookup | Create Lookup |
| PhoneNumberLookupApi | get_lookup_status | GET /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status |
| 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 |
| TranscriptionsApi | delete_real_time_transcription | DELETE /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
| TranscriptionsApi | get_real_time_transcription | GET /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
| TranscriptionsApi | list_real_time_transcriptions | GET /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
Authentication schemes defined for the API:
FAQs
Bandwidth
We found that bandwidth-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.