📅 You're Invited: Meet the Socket team at RSAC (April 28 – May 1).RSVP →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

bandwidth-sdk

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bandwidth-sdk

14.1.3
Rubygems
Version published
Maintainers
1
Created
Source

bandwidth-sdk

Gem Version Tests Ruby Style Guide

OSRuby
Windows 20193.0, 3.1, 3.2, 3.3
Windows 20223.0, 3.1, 3.2, 3.3
Ubuntu 22.043.0, 3.1, 3.2, 3.3
Ubuntu 24.043.0, 3.1, 3.2, 3.3

Bandwidth - the Ruby gem for the Bandwidth SDK

Generated with the command:

openapi-generator generate -g ruby -i bandwidth.yml -c openapi-config.yml -o ./

Bandwidth's Communication APIs

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Install from RubyGems

gem install bandwidth-sdk

Build a gem

To build the Ruby code into a gem:

gem build bandwidth-sdk.gemspec

Then either install the gem locally:

gem install ./bandwidth-sdk-1.0.0.gem

(for development, run gem install --dev ./bandwidth-sdk-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'bandwidth-sdk', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'bandwidth-sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'bandwidth-sdk'

# Setup authorization
Bandwidth.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = Bandwidth::CallsApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+15555551212', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.example/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call

begin
  #Create Call
  result = api_instance.create_call(account_id, create_call)
  p result
rescue Bandwidth::ApiError => e
  puts "Exception when calling CallsApi->create_call: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
Bandwidth::CallsApicreate_callPOST /accounts/{accountId}/callsCreate Call
Bandwidth::CallsApiget_call_stateGET /accounts/{accountId}/calls/{callId}Get Call State Information
Bandwidth::CallsApilist_callsGET /accounts/{accountId}/callsGet Calls
Bandwidth::CallsApiupdate_callPOST /accounts/{accountId}/calls/{callId}Update Call
Bandwidth::CallsApiupdate_call_bxmlPUT /accounts/{accountId}/calls/{callId}/bxmlUpdate Call BXML
Bandwidth::ConferencesApidownload_conference_recordingGET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/mediaDownload Conference Recording
Bandwidth::ConferencesApiget_conferenceGET /accounts/{accountId}/conferences/{conferenceId}Get Conference Information
Bandwidth::ConferencesApiget_conference_memberGET /accounts/{accountId}/conferences/{conferenceId}/members/{memberId}Get Conference Member
Bandwidth::ConferencesApiget_conference_recordingGET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}Get Conference Recording Information
Bandwidth::ConferencesApilist_conference_recordingsGET /accounts/{accountId}/conferences/{conferenceId}/recordingsGet Conference Recordings
Bandwidth::ConferencesApilist_conferencesGET /accounts/{accountId}/conferencesGet Conferences
Bandwidth::ConferencesApiupdate_conferencePOST /accounts/{accountId}/conferences/{conferenceId}Update Conference
Bandwidth::ConferencesApiupdate_conference_bxmlPUT /accounts/{accountId}/conferences/{conferenceId}/bxmlUpdate Conference BXML
Bandwidth::ConferencesApiupdate_conference_memberPUT /accounts/{accountId}/conferences/{conferenceId}/members/{memberId}Update Conference Member
Bandwidth::MFAApigenerate_messaging_codePOST /accounts/{accountId}/code/messagingMessaging Authentication Code
Bandwidth::MFAApigenerate_voice_codePOST /accounts/{accountId}/code/voiceVoice Authentication Code
Bandwidth::MFAApiverify_codePOST /accounts/{accountId}/code/verifyVerify Authentication Code
Bandwidth::MediaApidelete_mediaDELETE /users/{accountId}/media/{mediaId}Delete Media
Bandwidth::MediaApiget_mediaGET /users/{accountId}/media/{mediaId}Get Media
Bandwidth::MediaApilist_mediaGET /users/{accountId}/mediaList Media
Bandwidth::MediaApiupload_mediaPUT /users/{accountId}/media/{mediaId}Upload Media
Bandwidth::MessagesApicreate_messagePOST /users/{accountId}/messagesCreate Message
Bandwidth::MessagesApilist_messagesGET /users/{accountId}/messagesList Messages
Bandwidth::PhoneNumberLookupApicreate_lookupPOST /accounts/{accountId}/tnlookupCreate Lookup
Bandwidth::PhoneNumberLookupApiget_lookup_statusGET /accounts/{accountId}/tnlookup/{requestId}Get Lookup Request Status
Bandwidth::RecordingsApidelete_recordingDELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}Delete Recording
Bandwidth::RecordingsApidelete_recording_mediaDELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/mediaDelete Recording Media
Bandwidth::RecordingsApidelete_recording_transcriptionDELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcriptionDelete Transcription
Bandwidth::RecordingsApidownload_call_recordingGET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/mediaDownload Recording
Bandwidth::RecordingsApiget_call_recordingGET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}Get Call Recording
Bandwidth::RecordingsApiget_recording_transcriptionGET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcriptionGet Transcription
Bandwidth::RecordingsApilist_account_call_recordingsGET /accounts/{accountId}/recordingsGet Call Recordings
Bandwidth::RecordingsApilist_call_recordingsGET /accounts/{accountId}/calls/{callId}/recordingsList Call Recordings
Bandwidth::RecordingsApitranscribe_call_recordingPOST /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcriptionCreate Transcription Request
Bandwidth::RecordingsApiupdate_call_recording_statePUT /accounts/{accountId}/calls/{callId}/recordingUpdate Recording
Bandwidth::StatisticsApiget_statisticsGET /accounts/{accountId}/statisticsGet Account Statistics
Bandwidth::TollFreeVerificationApicreate_webhook_subscriptionPOST /accounts/{accountId}/tollFreeVerification/webhooks/subscriptionsCreate Webhook Subscription
Bandwidth::TollFreeVerificationApidelete_webhook_subscriptionDELETE /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}Delete Webhook Subscription
Bandwidth::TollFreeVerificationApiget_toll_free_verification_statusGET /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerificationGet Toll-Free Verification Status
Bandwidth::TollFreeVerificationApilist_toll_free_use_casesGET /tollFreeVerification/useCasesList Toll-Free Use Cases
Bandwidth::TollFreeVerificationApilist_webhook_subscriptionsGET /accounts/{accountId}/tollFreeVerification/webhooks/subscriptionsList Webhook Subscriptions
Bandwidth::TollFreeVerificationApirequest_toll_free_verificationPOST /accounts/{accountId}/tollFreeVerificationRequest Toll-Free Verification
Bandwidth::TollFreeVerificationApiupdate_toll_free_verification_requestPUT /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerificationUpdate Toll-Free Verification Request
Bandwidth::TollFreeVerificationApiupdate_webhook_subscriptionPUT /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}Update Webhook Subscription
Bandwidth::TranscriptionsApidelete_real_time_transcriptionDELETE /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}Delete a specific transcription
Bandwidth::TranscriptionsApiget_real_time_transcriptionGET /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}Retrieve a specific transcription
Bandwidth::TranscriptionsApilist_real_time_transcriptionsGET /accounts/{accountId}/calls/{callId}/transcriptionsEnumerate transcriptions made with StartTranscription

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Basic

  • Type: HTTP basic authentication

FAQs

Package last updated on 08 Apr 2025

Did you know?

Socket

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.

Install

Related posts