Download the PHP package bandwidth/iris without Composer
On this page you can find all versions of the php package bandwidth/iris. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bandwidth/iris
More information about bandwidth/iris
Files in bandwidth/iris
Package iris
Short Description Bandwidth's Iris SDK for PHP
License MIT
Homepage http://dev.bandwidth.com
Informations about the package iris
PHP Client library for Bandwidth's Phone Number Dashboard (AKA: Dashboard, Iris)
Supported PHP Versions
Version | Support Level |
---|---|
8.0 | Supported |
8.1 | Supported |
8.2 | Supported |
8.3 | Supported |
Install
Run
Usage
Run tests
=======
Examples
There is an 'examples' folder in the source tree that shows how each of the API objects work with simple example code. To run the examples:
Edit the config.php to match your IRIS credentials and run the examples individually. e.g.
If the examples take command line parameters, you will get the usage by just executing the individual script.
API Objects
General principles
In most cases you should use Account object as start point.
Account has related entities such Orders, Sites, etc.
Example:
To get stored Sites you should create $sites object and execute get() method.
To reflect object structure:
Available Numbers
Available NpaNxx
Cities
Covered Rate Centers
Disconnected Numbers
Disconnect Numbers
The Disconnect object is used to disconnect numbers from an account. Creates a disconnect order that can be tracked
Create Disconnect
Get Disconnect
Add Note to Disconnect
Get Notes for Disconnect
Dlda
Create Ddla
Get Dlda
Get Dlda History
List Dldas
In Service Numbers
List InService Numbers
Lidb
Create
Get Lidb
List Lidbs
LNP Checker
Check LNP
Orders
Create Order
Get Order
List Orders
Add note to order
Get all Tns for an order
Port Ins
Create PortIn
Get PortIn
List PortIns
PortIn Instance methods
PortIn File Management
PortIn File Management: Grab filename
Rate Centers
List Ratecenters
SIP Peers
Create SIP Peer
Get SIP Peer
List SIP Peers
Delete SIP Peer
Move TNs
Get TNs
Get TN
Total TNs
Set TN Options
Sites
Create A Site
Updating a Site
Deleting a Site
Listing All Sites
Orders of a site
Total TNs of a site
Portins of a site
Sippeers
[see SIP Peers]
Subscriptions
Create Subscription
Get Subscription
List Subscriptions
Update
DELETE
TNs
Get TN
List TNs
TN Instance Methods
TN Reservation
Create TN Reservation
Get TN Reservation
Delete TN Reservation
Billing reports
Listing all Billing Report instances
Request new billing report
Checking status of the billing report
Download zip with content of the billing report
Download zip with content of the billing report and save to file
TN Options
Get TN Option Orders
GET TN Option Order
Get TN Option Order (error)
Create Portout Passcode
Create Call Forward Number
Enable SMS
Hosted Messaging Functions
Get Import TN Orders
Create Import TN Order
Get Import TN Order By ID
Get Import TN Order History
Get Import TN Order LOAs
Upload LOA file for an Import TN Order
Valid mime_types
can be found on the Dashboard API Reference under /accounts /{accountId} /importTnOrders /{orderid} /loas
Mime types are expected to be in the format x/y
, such as application/pdf
or text/plain
Download LOA file for an Import TN Order (bonked. come back to this)
Note: Make sure to grab the desired file ID from the response of $account->getImportTnOrderLoas($order_id)
in the field $response->fileNames