bandwidth-sdk

![Deploy](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml)

| OS | Node |
|:------------:|:----------:|
| Windows 2022 | 18, 20, 22, 24 |
| Windows 2025 | 18, 20, 22, 24 |
| Ubuntu 22.04 | 18, 20, 22, 24 |
| Ubuntu 24.04 | 18, 20, 22, 24 |

#### Available on NPM
``npm install bandwidth-sdk`

#### To Run Unit Tests Locally

1. Install Prism`bash npm install -g @stoplight/prism-cli`2. Start Prism Mock Server with the OpenAPI Spec`bash prism mock bandwidth.yml`3. Run Tests`bash npm run test-unit`

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment * Node.js * Webpack * Browserify

Language level * ES5 - you must have a Promises/A+ library installed * ES6

Module system * CommonJS * ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

`$3`

To build and compile the typescript sources to javascript use:`npm install npm run build`

`$3`

First build the package then run npm publish

`$3`

navigate to the folder of your consuming project and run one of the following commands.

_published:_

`npm install bandwidth-sdk --save`

_unPublished (not recommended):_

`npm install PATH_TO_GENERATED_PACKAGE --save`

`$3`

The following is a simple example of how to use this module:

`javascript import { CallsApi, Configuration } from 'bandwidth-sdk';

const config = new Configuration({ clientId: BW_CLIENT_ID, clientSecret: BW_CLIENT_SECRET }); const callsApi = new CallsApi(config);

const body = { applicationId: BW_VOICE_APPLICATION_ID, to: TO_NUMBER, from: BW_NUMBER };

await callsApi.createCall(BW_ACCOUNT_ID, body);``

More samples can be found in the Bandwidth Samples GitHub Organization.

$3

All URIs are relative to http://localhost

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
CallsApi | createCall | POST /accounts/{accountId}/calls | Create Call
CallsApi | getCallState | GET /accounts/{accountId}/calls/{callId} | Get Call State Information
CallsApi | listCalls | GET /accounts/{accountId}/calls | Get Calls
CallsApi | updateCall | POST /accounts/{accountId}/calls/{callId} | Update Call
CallsApi | updateCallBxml | PUT /accounts/{accountId}/calls/{callId}/bxml | Update Call BXML
ConferencesApi | downloadConferenceRecording | GET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media | Download Conference Recording
ConferencesApi | getConference | GET /accounts/{accountId}/conferences/{conferenceId} | Get Conference Information
ConferencesApi | getConferenceMember | GET /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Get Conference Member
ConferencesApi | getConferenceRecording | GET /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId} | Get Conference Recording Information
ConferencesApi | listConferenceRecordings | GET /accounts/{accountId}/conferences/{conferenceId}/recordings | Get Conference Recordings
ConferencesApi | listConferences | GET /accounts/{accountId}/conferences | Get Conferences
ConferencesApi | updateConference | POST /accounts/{accountId}/conferences/{conferenceId} | Update Conference
ConferencesApi | updateConferenceBxml | PUT /accounts/{accountId}/conferences/{conferenceId}/bxml | Update Conference BXML
ConferencesApi | updateConferenceMember | PUT /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Update Conference Member
MFAApi | generateMessagingCode | POST /accounts/{accountId}/code/messaging | Messaging Authentication Code
MFAApi | generateVoiceCode | POST /accounts/{accountId}/code/voice | Voice Authentication Code
MFAApi | verifyCode | POST /accounts/{accountId}/code/verify | Verify Authentication Code
MediaApi | deleteMedia | DELETE /users/{accountId}/media/{mediaId} | Delete Media
MediaApi | getMedia | GET /users/{accountId}/media/{mediaId} | Get Media
MediaApi | listMedia | GET /users/{accountId}/media | List Media
MediaApi | uploadMedia | PUT /users/{accountId}/media/{mediaId} | Upload Media
MessagesApi | createMessage | POST /users/{accountId}/messages | Create Message
MessagesApi | listMessages | GET /users/{accountId}/messages | List Messages
MultiChannelApi | createMultiChannelMessage | POST /users/{accountId}/messages/multiChannel | Create Multi-Channel Message
PhoneNumberLookupApi | createAsyncBulkLookup | POST /accounts/{accountId}/phoneNumberLookup/bulk | Create Asynchronous Bulk Number Lookup
PhoneNumberLookupApi | createSyncLookup | POST /accounts/{accountId}/phoneNumberLookup | Create Synchronous Number Lookup
PhoneNumberLookupApi | getAsyncBulkLookup | GET /accounts/{accountId}/phoneNumberLookup/bulk/{requestId} | Get Asynchronous Bulk Number Lookup
RecordingsApi | deleteRecording | DELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording
RecordingsApi | deleteRecordingMedia | DELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media
RecordingsApi | deleteRecordingTranscription | DELETE /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription
RecordingsApi | downloadCallRecording | GET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording
RecordingsApi | getCallRecording | GET /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording
RecordingsApi | getRecordingTranscription | GET /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription
RecordingsApi | listAccountCallRecordings | GET /accounts/{accountId}/recordings | Get Call Recordings
RecordingsApi | listCallRecordings | GET /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings
RecordingsApi | transcribeCallRecording | POST /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request
RecordingsApi | updateCallRecordingState | PUT /accounts/{accountId}/calls/{callId}/recording | Update Recording
StatisticsApi | getStatistics | GET /accounts/{accountId}/statistics | Get Account Statistics
TollFreeVerificationApi | createWebhookSubscription | POST /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription
TollFreeVerificationApi | deleteVerificationRequest | DELETE /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Delete a Toll-Free Verification Submission
TollFreeVerificationApi | deleteWebhookSubscription | DELETE /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription
TollFreeVerificationApi | getTollFreeVerificationStatus | GET /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status
TollFreeVerificationApi | listTollFreeUseCases | GET /tollFreeVerification/useCases | List Toll-Free Use Cases
TollFreeVerificationApi | listWebhookSubscriptions | GET /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | List Webhook Subscriptions
TollFreeVerificationApi | requestTollFreeVerification | POST /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
TollFreeVerificationApi | updateTollFreeVerificationRequest | PUT /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request
TollFreeVerificationApi | updateWebhookSubscription | PUT /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
TranscriptionsApi | deleteRealTimeTranscription | DELETE /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
TranscriptionsApi | getRealTimeTranscription | GET /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
TranscriptionsApi | listRealTimeTranscriptions | GET /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions

$3

Documentation For Authorization

Authentication schemes defined for the API:

$3

- Type: HTTP basic authentication

$3

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

bandwidth-sdk

![Deploy](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml)

| OS | Node |
|:------------:|:----------:|
| Windows 2022 | 18, 20, 22, 24 |
| Windows 2025 | 18, 20, 22, 24 |
| Ubuntu 22.04 | 18, 20, 22, 24 |
| Ubuntu 24.04 | 18, 20, 22, 24 |

#### Available on NPM
``npm install bandwidth-sdk`

#### To Run Unit Tests Locally

1. Install Prism`bash npm install -g @stoplight/prism-cli`2. Start Prism Mock Server with the OpenAPI Spec`bash prism mock bandwidth.yml`3. Run Tests`bash npm run test-unit`

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment * Node.js * Webpack * Browserify

Language level * ES5 - you must have a Promises/A+ library installed * ES6

Module system * CommonJS * ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

`$3`

To build and compile the typescript sources to javascript use:`npm install npm run build`

`$3`

First build the package then run npm publish

`$3`

navigate to the folder of your consuming project and run one of the following commands.

_published:_

`npm install bandwidth-sdk --save`

_unPublished (not recommended):_

`npm install PATH_TO_GENERATED_PACKAGE --save`

`$3`

The following is a simple example of how to use this module:

`javascript import { CallsApi, Configuration } from 'bandwidth-sdk';

const config = new Configuration({ clientId: BW_CLIENT_ID, clientSecret: BW_CLIENT_SECRET }); const callsApi = new CallsApi(config);

const body = { applicationId: BW_VOICE_APPLICATION_ID, to: TO_NUMBER, from: BW_NUMBER };

await callsApi.createCall(BW_ACCOUNT_ID, body);``

More samples can be found in the Bandwidth Samples GitHub Organization.

$3

All URIs are relative to http://localhost

$3

Documentation For Authorization

Authentication schemes defined for the API:

$3

- Type: HTTP basic authentication

$3

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