Skip to content
Bandwidth
php-sdk
Public

About

Bandwidth PHP SDK

dev.bandwidth.com

Topics

sdksdlc-enforced

Resources

Readme
License
Activity
Custom properties

Stars

16 stars

Watchers

36 watching

Forks

10 forks
Report repository
BranchesTags

Repository files navigation

Bandwidth SDK

Bandwidth's Communication APIs

For more information, please visit https://dev.bandwidth.com.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, run:

composer require bandwidth/sdk

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Bandwidth SDK/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: Basic
$config = Bandwidth\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2
$config = Bandwidth\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Bandwidth\Api\CallsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$account_id = 9900000; // string | Your Bandwidth Account ID.
$create_call = new \Bandwidth\Model\CreateCall(); // \Bandwidth\Model\CreateCall | JSON object containing information to create an outbound call

try {
    $result = $apiInstance->createCall($account_id, $create_call);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallsApi->createCall: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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
EndpointsApi createEndpoint POST /accounts/{accountId}/endpoints Create Endpoint
EndpointsApi deleteEndpoint DELETE /accounts/{accountId}/endpoints/{endpointId} Delete Endpoint
EndpointsApi getEndpoint GET /accounts/{accountId}/endpoints/{endpointId} Get Endpoint
EndpointsApi listEndpoints GET /accounts/{accountId}/endpoints List Endpoints
EndpointsApi updateEndpointBxml PUT /accounts/{accountId}/endpoints/{endpointId}/bxml Update Endpoint BXML
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

Models

Authorization

Basic

  • Type: HTTP basic authentication

OAuth2

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

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

letstalk@bandwidth.com

About this package

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

  • API version: 1.0.0
    • Generator version: 7.25.0
  • Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen

About

Bandwidth PHP SDK

dev.bandwidth.com

Topics

sdksdlc-enforced

Resources

Readme
License
Activity
Custom properties

Stars

16 stars

Watchers

36 watching

Forks

10 forks
Report repository

Releases

Packages

Used by

Contributors

Languages