Bandwidth
- API version: 1.0.0
- Generator version: 7.17.0
Bandwidth's Communication APIs
For more information, please visit https://dev.bandwidth.com
Automatically generated by the OpenAPI Generator
Building the API client library requires:
- Java 1.8+
- Maven (3.8.3+)/Gradle (7.2+)
To install the API client library to your local Maven repository, simply execute:
mvn clean installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deployRefer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency> <groupId>com.bandwidth.sdk</groupId> <artifactId>bandwidth-sdk</artifactId> <version>1.0.0</version> <scope>compile</scope> </dependency>Add this dependency to your project's build file:
repositories{mavenCentral() // Needed if the 'bandwidth-sdk' jar has been published to maven central. mavenLocal() // Needed if the 'bandwidth-sdk' jar has been published to the local maven repo. } dependencies{implementation "com.bandwidth.sdk:bandwidth-sdk:1.0.0" }At first generate the JAR by executing:
mvn clean packageThen manually install the following JARs:
target/bandwidth-sdk-1.0.0.jartarget/lib/*.jar
Please follow the installation instruction and execute the following Java code:
// Import classes:importcom.bandwidth.sdk.ApiClient; importcom.bandwidth.sdk.ApiException; importcom.bandwidth.sdk.Configuration; importcom.bandwidth.sdk.auth.*; importcom.bandwidth.sdk.model.*; importcom.bandwidth.sdk.api.CallsApi; publicclassExample{publicstaticvoidmain(String[] args){ApiClientdefaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost"); // Configure HTTP basic authorization: BasicHttpBasicAuthBasic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); Basic.setUsername("YOUR USERNAME"); Basic.setPassword("YOUR PASSWORD"); // Configure OAuth2 access token for authorization: OAuth2OAuthOAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2"); OAuth2.setAccessToken("YOUR ACCESS TOKEN"); CallsApiapiInstance = newCallsApi(defaultClient); // Or create the instance with a your clientId and clientSecret (for OAuth2):// CallsApi apiInstance = new CallsApi("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", null);StringaccountId = "9900000"; // String | Your Bandwidth Account ID.CreateCallcreateCall = newCreateCall(); // CreateCall | JSON object containing information to create an outbound calltry{CreateCallResponseresult = apiInstance.createCall(accountId, createCall); System.out.println(result)} catch (ApiExceptione){System.err.println("Exception when calling CallsApi#createCall"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace()} } }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 |
| 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 |
| 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 |
| 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 |
- 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
- CreateMessageRequestError
- CreateMultiChannelMessageResponse
- CreateSyncLookupResponse
- CreateSyncLookupResponseData
- DeactivationEventEnum
- DisconnectCallback
- Diversion
- DtmfCallback
- Error
- ErrorObject
- ErrorSource
- FailureWebhook
- FieldError
- FileFormatEnum
- GatherCallback
- GetAsyncBulkLookupResponse
- GetAsyncBulkLookupResponseData
- InProgressLookupStatusEnum
- InboundCallback
- InboundCallbackMessage
- InboundCallbackTypeEnum
- InitiateCallback
- LatestMessageDeliveryStatusEnum
- LineTypeEnum
- Link
- LinkSchema
- LinksObject
- 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
- 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
- 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
Authentication schemes defined for the API:
- Type: HTTP basic authentication
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.