Download the PHP package kureikain/bandwidth-alpaca without Composer
On this page you can find all versions of the php package kureikain/bandwidth-alpaca. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package bandwidth-alpaca
bandwidth-php
Bandwidth API library client for PHP
This library is generated by alpaca
Installation
Make sure you have composer installed.
Add the following to your composer.json
Update your dependencies
This package follows the
PSR-0convention names for its classes, which means you can easily integrate these classes loading in your own autoloader.
Versions
Works with [ 5.4 / 5.5 ]
Usage
Build a client
Using this api without authentication gives an error
Basic authentication
Authorization header token
Client Options
The following options are available while instantiating a client:
- base: Base url for the api
- __api_version__: Default version of the api (to be used in url)
- __user_agent__: Default user-agent for all requests
- headers: Default headers for all requests
- __request_type__: Default format of the request body
Response information
All the callbacks provided to an api call will receive the response as shown below
JSON response
When the response sent by server is json, it is decoded into an array
Method Options
The following options are available while calling a method of an api:
- __api_version__: Version of the api (to be used in url)
- headers: Headers for the request
- query: Query parameters for the url
- body: Body of the request
- __request_type__: Format of the request body
Request body information
Set __request_type__ in options to modify the body accordingly
RAW request
When the value is set to raw, don't modify the body at all.
FORM request
When the value is set to form, urlencode the body.
JSON request
When the value is set to json, JSON encode the body.
account information api
Retrieve current balance, transaction list, account type and all elements related to your platform account.
The following arguments are required:
- __user_id__: user_id of account which is doing API call
Get information about your account (GET /users/:user_id/account)
Get information about your account: balance, accountType.
Get a list of the transactions made to your account (GET /users/:user_id/account/transactions)
Get the transactions from the user's Account..
message resources api
Lets you send SMS text messages and view messages that were previously sent or received
The following arguments are required:
- __user_id__: user_id of account which is doing API call
Get a list of previous messages that were sent or received (GET /users/:user_id/messages)
Get a list of previous messages that were sent or received
Send text messages (POST /users/:user_id/messages)
Send text messages
Read a message (GET /users/:user_id/messages/:id)
Get information about a message that was sent or received
The following arguments are required:
- id: message id
This resource provides a CNAM number info api
CNAM is an acronym which stands for Caller ID Name. CNAM can be used to display the calling party's name alongside the phone number, to help users easily identify a caller. CNAM API allows the user to get the CNAM information of a particular number
The following arguments are required:
- number: phone number to get the info
Get the CNAM of the number (GET /phoneNumbers/numberInfo/:number)
Get the CNAM of the number
User Errors api
The User Errors resource lets you see information about errors that happened in your API calls and during applications callbacks. This error information can be very helpful when you're debugging an application. Because error information can be large, and errors in the distant past are less useful than new ones, Bandwidth API limits the number of user errors it keeps.
Gets information about one user error (GET /users/:user_id/errors/:error_id)
Gets information about one user error
The following arguments are required:
- __error_id__: Error ID
Gets all the user errors for a user (GET /users/:user_id/errors)
Gets all the user errors for a user
Find and Buy available numbers api
The Available Numbers resource lets you search for numbers that are available for use with your application.
Search an available local number (GET /availableNumbers/local)
Search and available local number that we can buy
The following arguments are required:
Buy a local number (POST /availableNumbers/local)
Search and order available local numbers
The following arguments are required:
Search for available toll free numbers (GET /availableNumbers/tollFree)
Search for available toll free numbers
Search and order available toll free numbers (POST /availableNumbers/tollFree)
Search and order available toll free numbers
Manipulation calls api
The Calls resource lets you make phone calls and view information about previous inbound and outbound calls.
The following arguments are required:
- __user_id__: user_id of account which is doing API call
Send DTMF (POST /users/:user_id/calls/:call_id/dtmf)
Send DTMF to a call
The following arguments are required:
- __call_id__: call id
Retrieve all recordings related to the call (GET /users/:user_id/calls/:call_id/recordings)
Retrieve all recordings related to the call
The following arguments are required:
- __call_id__: call id
Update the gather DTMF (Stop Gather) (POST /users/:user_id/calls/:call_id/gather/:gather_id)
Update the gather DTMF (Stop Gather)
The following arguments are required:
- __call_id__: call id
- __gather_id__: gather id
Gets a list of active and historic calls you made or received (GET /users/:user_id/calls)
Gets a list of active and historic calls you made or received
Makes a phone call. (POST /users/:user_id/calls)
Makes a phone call.
The following arguments are required:
- to: number which we call to
- from: number which we call from
Gets information about an active or completed call (GET /users/:user_id/calls/:call_id)
Gets information about an active or completed call. No query parameters are supported
The following arguments are required:
- __call_id__: call id
Changes properties of an active phone call (POST /users/:user_id/calls/:call_id)
Changes properties of an active phone call
The following arguments are required:
- __call_id__: call id
Play an audio or speak a sentence in a call (POST /users/:user_id/calls/:call_id/audio)
Play an audio or speak a sentence in a call
The following arguments are required:
- __call_id__: call id
Gather the DTMF digits pressed (POST /users/:user_id/calls/:call_id/gather)
Gather the DTMF digits pressed by the user.
The following arguments are required:
- __call_id__: call id
Get the gather DTMF parameters and results (GET /users/:user_id/calls/:call_id/gather/:gather_id)
Get the gather DTMF parameters and results
The following arguments are required:
- __call_id__: call id
- __gather_id__: gather id
The Phone Numbers resource lets you get phone numbers for use with your programs and manage numbers you already have api
The Phone Numbers resource lets you get phone numbers for use with your programs and manage numbers you already have
The following arguments are required:
- __user_id__: user_id of account which is doing API call
Gets a list of your numbers. (GET /users/:user_id/phoneNumbers)
Gets a list of your numbers.
Allocates a number so you can use it to make and receive calls and send and receive messages (POST /users/:user_id/phoneNumbers)
Allocates a number so you can use it to make and receive calls and send and receive messages
The following arguments are required:
- number: An available telephone number you want to use (must be in E.164 format, like +19195551212)
Gets information about one of your numbers using the number's ID (GET /users/:user_id/phoneNumbers/:number_id)
Gets information about one of your numbers using the number's ID
The following arguments are required:
- __number_id__: Number ID inside Bandwidth system
Gets information about one of your numbers using the number itself (GET /users/:user_id/phoneNumbers/:number)
Gets information about one of your numbers using the E.164 number string, like +19195551212. Remember to URL encode the plus sign prefix
The following arguments are required:
- number: phone number
Make changes to a number you have (POST /users/:user_id/phoneNumbers/:number_id)
Makes changes to a number you have. POST a new JSON representation with the property values you desire to the URL that you got back in the "Location" header when you first allocated it. Properties you don't send will remain unchanged.
The following arguments are required:
- __number_id__: id of phone number in twilio system. The ID of a number can be found by showByNumber
Remove a number from your account (DELETE /users/:user_id/phoneNumbers/:number_id)
emoves a number from your account so you can no longer make or receive calls, or send or receive messages with it. When you remove a number from your account, it will not immediately become available for re-use, so be careful.
The following arguments are required:
- __number_id__: id of phone number in twilio system. The ID of a number can be found by showByNumber
Conference resouce api
The Conference resource allows you create conferences, add members to it, play audio, speak text, mute/unmute members, hold/unhold members and other things related to conferencing.
The following arguments are required:
- __user_id__: user_id of account which is doing API call
Create a conference. (POST /users/:user_id/conferences)
Creates a conference.
The following arguments are required:
- from: the phone number which conferences will be created on it
Add a member to a conference. (POST /users/:user_id/conferences/:conference_id/members)
Add a member to a conference.
The following arguments are required:
- __conference_id__: Conference ID
- callId: Call ID to join into conference
Play an audio/speak a sentence in the conference. (POST /users/:user_id/conferences/:conference_id/audio)
Play an audio/speak a sentence in the conference.
The following arguments are required:
- __conference_id__: Conference ID
Bridges resource api
Bridges resource. Bridge two calls allowing two way audio between them.
The following arguments are required:
- __user_id__: user_id of account which is doing API call
Create a bridge (POST /users/:user_id/bridges)
Create a bridge
The following arguments are required:
Play an audio or speak a sentence in a bridge (POST /users/:user_id/bridges/:bridge_id/audio)
Play an audio or speak a sentence in a bridge
The following arguments are required:
- __bridge_id__: Bridge ID
Get the list of calls that are on the bridge (GET /users/:user_id/bridges/:bridge_id/calls)
Get the list of calls that are on the bridge
The following arguments are required:
- __bridge_id__: Bridge ID
Change calls in a bridge and bridge/unbridge the audio (POST /users/:user_id/bridges/:bridge_id)
Change calls in a bridge and bridge/unbridge the audio
The following arguments are required:
- __bridge_id__: Bridge ID
Retrieve call recordings, filtering by Id, user and/or calls api
Retrieve call recordings, filtering by Id, user and/or calls. Learn how record a Call The recording information retrieved by GET method contains only textual data related to call recording as described on Properties section. To properly work with recorded media content such as download and removal of media file, please access Media documentation
Retrieve a specific call recording information, identified by recordingId (GET /users/:user_id/recordings/:recording_id)
Retrieve a specific call recording information, identified by recordingId
The following arguments are required:
- __recording_id__: Recording ID
List a user's call recordings (GET /users/:user_id/recordings)
List a user's call recordings
Contributors
Here is a list of Contributors
TODO
License
MIT
Bug Reports
Report here.
Contact
kureikain ([email protected])
