bandwidth/iris

Bandwidth's Iris SDK for PHP

Maintainers

Details

github.com/Bandwidth/php-bandwidth-iris

Homepage

Source

Issues

Installs: 462 234

Dependents: 1

Suggesters: 0

Security: 0

Stars: 11

Watchers: 14

Forks: 19

Open Issues: 1

v4.3.1 2024-08-19 13:24 UTC

Requires

Requires (Dev)

MIT 0e77d4272e2a15ec1ec0720175ce4bdee9f0280b

phpsdkiris

This package is auto-updated.

Last update: 2024-10-21 19:40:28 UTC

README

Build Status

Supported PHP Versions

Install

Run

composer require bandwidth/iris

Usage

$client = new \Iris\Client($login, $password, ['url' => 'https://dashboard.bandwidth.com/api/']);

Run tests

composer install
php ./bin/phpunit --bootstrap ./vendor/autoload.php 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:

$ cd examples
$ composer install
$ cp config.php.example config.php

Edit the config.php to match your IRIS credentials and run the examples individually. e.g.

php availableNumbers-sample.php

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 = new \Iris\Account($your_account_id, $client);

Account has related entities such Orders, Sites, etc.

Example:

$sites = $account->sites();

To get stored Sites you should create $sites object and execute get() method.

$items = $sites->getList(); // Array(Site1, Site2)

To reflect object structure:

echo json_encode($site->to_array());

Available Numbers

$account->availableNumbers([ "areaCode" => "818" ]);

Available NpaNxx

$account->availableNpaNxx(["state" => "CA"]);

Cities

$cities = new \Iris\Cities($client);
$items = $cities->getList(["state" => "NC"]);

Covered Rate Centers

$rcs = new Iris\CoveredRateCenters($client);
$rateCenters = $rcs->getList(["page" => 1, "size" => 10 ]);

Disconnected Numbers

$account->disnumbers(["areaCode" => "919"]);

Disconnect Numbers

The Disconnect object is used to disconnect numbers from an account. Creates a disconnect order that can be tracked

Create Disconnect

$disconnect = $account->disconnects()->create([
    "name" => "test disconnect order 4",
    "CustomerOrderId" => "Disconnect1234",
    "DisconnectTelephoneNumberOrderType" => [
        "TelephoneNumberList" => [
            "TelephoneNumber" => [ "9192755378", "9192755703" ]
        ]
    ]
]);

Get Disconnect

$disconnect = $account->disconnects()->disconnect("b902dee1-0585-4258-becd-5c7e51ccf5e1", true); // tnDetails: true

Add Note to Disconnect

$disconnect->notes()->create([ "UserId" => "byo_dev", "Description" => "Test Note"]);

Get Notes for Disconnect

$items = $disconnect->notes()->getList();

Dlda

Create Ddla

$order_data = [
    "CustomerOrderId" => "123",
    "DldaTnGroups" => [
        "DldaTnGroup" => [
            [
                "TelephoneNumbers" => [
                    "TelephoneNumber" => "4352154856"
                ],
                "AccountType" => "RESIDENTIAL",
                "ListingType" => "LISTED",
                "ListAddress" => "true",
                "ListingName" => [
                    "FirstName" => "FirstName",
                    "FirstName2" => "FirstName2",
                    "LastName" => "LastName",
                    "Designation" => "Designation",
                    "TitleOfLineage" => "TitleOfLineage",
                    "TitleOfAddress" => "TitleOfAddress",
                    "TitleOfAddress2" => "TitleOfAddress2",
                    "TitleOfLineageName2" => "TitleOfLineageName2",
                    "TitleOfAddressName2" => "TitleOfAddressName2",
                    "TitleOfAddress2Name2" => "TitleOfAddress2Name2",
                    "PlaceListingAs" => "PlaceListingAs",
                ],
                "Address" => [
                    "HousePrefix" => "HousePrefix",
                    "HouseNumber" => "915",
                    "HouseSuffix" => "HouseSuffix",
                    "PreDirectional" => "PreDirectional",
                    "StreetName" => "StreetName",
                    "StreetSuffix" => "StreetSuffix",
                    "PostDirectional" => "PostDirectional",
                    "AddressLine2" => "AddressLine2",
                    "City" => "City",
                    "StateCode" => "StateCode",
                    "Zip" => "Zip",
                    "PlusFour" => "PlusFour",
                    "Country" => "Country",
                    "AddressType" => "AddressType"
                ]
            ]
        ]
    ]
];

$dlda = $account->dldas()->create($order_data);

Get Dlda

$dlda = $account->dldas()->dlda("7802373f-4f52-4387-bdd1-c5b74833d6e2");

Get Dlda History

$dlda->history();

List Dldas

$account->dldas()->getList(["telephoneNumber" => "9195551212"]);

In Service Numbers

List InService Numbers

$account->inserviceNumbers(["areaCode" => "919"]);

Lidb

Create

$order_data = [
    "LidbTnGroups" => [
        "LidbTnGroup" => [
            [
                "TelephoneNumbers" => [
                    "TelephoneNumber" => "4352154856"
                ],
                "SubscriberInformation" => "Steve",
                "UseType" => "RESIDENTIAL",
                "Visibility" => "PUBLIC"
            ],
            [
                "TelephoneNumbers" => [
                    "TelephoneNumber" => "4352154855"
                ],
                "SubscriberInformation" => "Steve",
                "UseType" => "RESIDENTIAL",
                "Visibility" => "PUBLIC"
            ]
        ]
    ]
];

$lidb = $account->lidbs()->create($order_data);

Get Lidb

$lidb = $account->lidbs()->lidb("7802373f-4f52-4387-bdd1-c5b74833d6e2");

List Lidbs

$lidbs = $account->lidbs()->getList(["lastModifiedAfter" => "mm-dd-yy", "telephoneNumber"=> "888"]);

LNP Checker

Check LNP

$account->lnpChecker(["4109255199", "9196190594"], "true");

Orders

Create Order

$order = $account->orders()->create([
    "Name" => "Available Telephone Number order",
    "SiteId" => "2297",
    "CustomerOrderId" => "123456789",
    "ExistingTelephoneNumberOrderType" => [
        "TelephoneNumberList" => [
            "TelephoneNumber" => [ "9193752369", "9193752720", "9193752648"]
        ]
    ]
]);

Get Order

$response = $account->orders()->order("f30a31a1-1de4-4939-b094-4521bbe5c8df", true); // tndetail=true
$order = $response->Order;

List Orders

$items = $account->orders()->getList();

Add note to order

$order->notes()->create([ "UserId" => "byo_dev", "Description" => "Test Note"]);

Get all Tns for an order

$order->tns()->getList();

Port Ins

Create PortIn

$portin = $account->portins()->create(array(
    "BillingTelephoneNumber" => "6882015002",
    "Subscriber" => array(
        "SubscriberType" => "BUSINESS",
        "BusinessName" => "Acme Corporation",
        "ServiceAddress" => array(
            "HouseNumber" => "1623",
            "StreetName" => "Brockton Ave",
            "City" => "Los Angeles",
            "StateCode" => "CA",
            "Zip" => "90025",
            "Country" => "USA"
        )
    ),
    "LoaAuthorizingPerson" => "John Doe",
    "ListOfPhoneNumbers" => array(
        "PhoneNumber" => array("9882015025", "9882015026")
    ),
    "SiteId" => "365",
    "Triggered" => "false"
));

Get PortIn

$portin = $account->portins()->portin("d28b36f7-fa96-49eb-9556-a40fca49f7c6"));

List PortIns

$portins = $account->portins()->getList(["pon" => "a pon" ]);

PortIn Instance methods

$portin->update();
$portin->delete();
$portin->get_activation_status();
$status = $portin->set_activation_status([
    "AutoActivationDate" => "2014-08-30T18:30:00+03:00"
]);
$portin->history();
$portin->totals();
$portin->notes()->getList();

PortIn File Management

$portin->list_loas(true); // metadata = true
$portin->loas_send("./1.txt");
$portin->loas_update("./1.txt", "1.txt");
$portin->loas_delete("1.txt");
$portin->get_metadata("1.txt");
$meta_new = array(
    "DocumentName" => "text.txt",
    "DocumentType" => "INVOICE"
);
$portin->set_metadata('test.txt', $meta_new);
$portin->delete_metadata('test.txt');

PortIn File Management: Grab filename

$response = $portin->loas_send('./hello.txt', array("Content-Type" => "text/plain"));
$tmp = explode("/", $response);
$id = end($tmp);
print_r($id);

Rate Centers

List Ratecenters

$rc = new \Iris\RateCenter($client);
$cities = $rc->getList(["state" => "CA", "available" => "true"]);

SIP Peers

Create SIP Peer

$sippeer = $account->sippeers()->create(array(
        "PeerName" => "Test5 Peer",
        "IsDefaultPeer" => false,
        "ShortMessagingProtocol" => "SMPP",
        "VoiceHosts" => array(
            "Host" => array(
                "HostName" => "192.168.181.90"
            )
        ),
        "SmsHosts" => array(
            "Host" => array(
                "HostName" => "192.168.181.90"
            )
        ),
        "TerminationHosts" => array(
            "TerminationHost" => array(
                "HostName" => "192.168.181.90",
                "Port" => 0,
                "CustomerTrafficAllowed" => "DOMESTIC",
                "DataAllowed" => true
            )
        )
));

Get SIP Peer

$sippeer = $account->sippeers->sippeer("500651");

List SIP Peers

$sippeers = $account->sippeers()->getList();

Delete SIP Peer

$sippeer->delete();

Move TNs

$sippeer->movetns([ "FullNumber" => [ "9192000046", "9192000047", "9192000048" ]]);

Get TNs

$tns = $sippeer->tns()->getList();

Get TN

$tn = $sippeer->tns()->tn("8183386251");

Total TNs

$count = $sippeer->totaltns();

Set TN Options

$sippeer->tns()->tn("8183386251")->set_tn_options([
    "FullNumber" => "8183386251",
    "CallForward" => "9194394706",
    "RewriteUser" => "JohnDoe",
    "NumberFormat" => "10digit",
    "RPIDFormat" => "e164"
]);

Sites

Create A Site

$site = $account->sites()->create(
    array("Name" => "Test Site",
        "Address" => array(
            "City" => "Raleigh",
            "AddressType" => "Service",
            "HouseNumber" => "1",
            "StreetName" => "Avenue",
            "StateCode" => "NC"
    )));

Updating a Site

$site->Name = "New Name";
$site->update();

Deleting a Site

$site->delete();

Listing All Sites

$sites = $account->sites()->getList();

Orders of a site

$site->orders()->getList(["status" => "disabled"]);

Total TNs of a site

$site->totaltns();

Portins of a site

$site->portins()->getList(["status" => "disabled" ]);

Sippeers

$site->sippeers()->create([...])

[see SIP Peers]

Subscriptions

Create Subscription

$subscription = $account->subscriptions()->create([
    "OrderType" => "portins",
    "OrderId" => "98939562-90b0-40e9-8335-5526432d9741",
    "EmailSubscription" => [
        "Email" => "test@test.com",
        "DigestRequested" => "DAILY"
    ]
]);

Get Subscription

$subscription = $account->subscriptions()->subscription($id);

List Subscriptions

$account->subscriptions()->getList(["orderType" => "portins"]);

Update

$subscription->OrderType = "portins";
$subscription->update();

DELETE

$subscription->delete();

TNs

Get TN

$tns = new Iris\Tns(null, $client);
$tn = $tns->tn($id);

List TNs

$tns = new Iris\Tns(null, $client);
$tns_items = $tns->getList(["page" => 1, "size" => 10 ]);

TN Instance Methods

$tn = $tns->tn("7576768750");
$site = $tn->site();
$sippeer = $tn->sippeer();
$tnreservation = $tn->tnreservation();
$tn->tndetails();
$rc = $tn->ratecenter();
$lata = $tn->lata();
$lca = $tn->lca();

TN Reservation

Create TN Reservation

$resertation = $account->tnsreservations()->create(["ReservedTn" => "2512027430"]);

Get TN Reservation

$resertation = $account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");

Delete TN Reservation

$resertation = $account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");
$resertation->delete();

Billing reports

Listing all Billing Report instances

$billingReports = $account->billingreports()->getList();

Request new billing report

$billingReport = $account->billingreports()->request(
    array("Type" => "bdr",
        "DateRange" => array(
            "StartDate" => "2018-02-05",
            "EndDate" => "2018-02-06",
    )));

Checking status of the billing report

$billingReport = $account->billingreports()->billingreport('a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2');

Download zip with content of the billing report

$zipStream = $billingReport->file();

Download zip with content of the billing report and save to file

$outFile = '/tmp/report.zip';
$billingReport->file(['stream' => true, 'sink' => $outFile]);

TN Options

Get TN Option Orders

$tnoptions = $account->tnoptions();
$response = $tnoptions->getList();
print_r($response[0]->OrderId);

GET TN Option Order

$tnoptions = $account->tnoptions();
$response = $tnoptions->tnoption("order_id");
print_r($response->OrderCreateDate);

Get TN Option Order (error)

$tnoptions = $account->tnoptions();
$response = $tnoptions->tnoption("error_order_id");
print_r($response->ErrorList->Error->Description); //note: Error could be an array or a single object
//depending on how many errors are returned

Create Portout Passcode

$tnoptions = $account->tnoptions();
$data = array(
    "TnOptionGroups" => array(
        "TnOptionGroup" => array(
            "PortOutPasscode" => "12abd38",
            "TelephoneNumbers" => array(
                "TelephoneNumber" => "2018551020"
            )
        ),
    )
);
$response = $tnoptions->create($data);
print_r($response->OrderCreateDate);

Create Call Forward Number

$tnoptions = $account->tnoptions();
$data = array(
    "TnOptionGroups" => array(
        "TnOptionGroup" => array(
            "CallForward" => "2018551022",
            "TelephoneNumbers" => array(
                "TelephoneNumber" => "2018551020"
            )
        ),
    )
);
$response = $tnoptions->create($data);
print_r($response->OrderCreateDate);

Enable SMS

$tnoptions = $account->tnoptions();
$data = array(
    "TnOptionGroups" => array(
        "TnOptionGroup" => array(
            "Sms" => "on",
            "TelephoneNumbers" => array(
                "TelephoneNumber" => "2018551020"
            )
        ),
    )
);
$response = $tnoptions->create($data);
print_r($response->OrderCreateDate);

Hosted Messaging Functions

Get Import TN Orders

$resp = $account->getImportTnOrders(array(
    "createdDateFrom" => "2013-10-22T00:00:00.000Z",
    "createdDateTo" => "2013-10-25T00:00:00.000Z"
));

print_r($resp->ImportTnOrderSummary[0]->OrderId);

Create Import TN Order

$importTnOrder = new \Iris\ImportTnOrder(array(
    "CustomerOrderId" => "id",
    "TelephoneNumbers" => array(
        "TelephoneNumber" => array("5554443333")
    ),
    "SiteId" => "12345",
    "Subscriber" => array(
        "Name" => "Company INC",
        "ServiceAddress" => array(
            "HouseNumber" => "1",
            "StreetName" => "Street",
            "City" => "City",
            "StateCode" => "XY",
            "Zip" => "54345",
            "County" => "County"
        )
    ),
    "LoaAuthorizingPerson" => "Test Person"
));

print_r($account->createImportTnOrder($importTnOrder)->ImportTnOrder->OrderId);

Get Import TN Order By ID

print_r($account->getImportTnOrder("some_id_value")->ProcessingStatus);

Get Import TN Order History

print_r($account->getImportTnOrderHistory("some_id_value")->OrderHistory[0]->Status);

Get Import TN Order LOAs

$response = $account->getImportTnOrderLoas("order_id");
print_r($response->resultMessage);
echo "\n";
print_r($response->fileNames); //this can be a single string (if there's 1 file) or an array of strings (if there's multiple files)

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

$account->uploadImportTnOrderLoaFile("order_id", "binary_file_contents", "mime_type");
$filename = "loa.pdf";
$file = fopen($filename, "rb") or die("Unable to open file");
$file_contents = fread($file, filesize($filename));
$account->uploadImportTnOrderLoaFile("order_id", $file_contents, "application/pdf");
fclose($file);

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

$response = $account->downloadImportTnOrderLoaFile("order_id", "file_id");
$file = fopen("write.pdf", "wb") or die("Unable to open file");
fwrite($file, $response);
fclose($file);

Replace LOA file for an Import TN Order

$account->replaceImportTnOrderLoaFile("order_id", "file_id", "binary_file_contents", "mime_type");

Delete LOA file for an Import TN Order

$account->deleteImportTnOrderLoaFile("order_id", "file_id");

Get LOA file metadata for an Import TN Order

$response = $account->getImportTnOrderLoaFileMetadata("order_id", "file_id");
print_r($response->DocumentName);
echo "\n";
print_r($response->DocumentType);

Update LOA file metadata for an Import TN Order

$file_metadata = new \Iris\FileMetaData(array(
    "DocumentName" => "Updated",
    "DocumentType" => "LOA"
));
$account->updateImportTnOrderLoaFileMetadata("order_id", "file_id", $file_metadata);

Delete LOA file metadata for an Import TN Order

$account->deleteImportTnOrderLoaFileMetadata("order_id", "file_id");

Check TNs Portability

print_r($account->checkTnsPortability(array("5554443333", "5553334444"))->ImportTnCheckerPayload);

Get In Service Numbers

print_r($account->getInserviceNumbers(array("areacode" => "919"))->TelephoneNumbers->Count);

Check In Service Number

print_r($account->checkInserviceNumber("5554443333"));

Get Remove Imported TN Orders

$resp = $account->getRemoveImportedTnOrders(array(
    "createdDateFrom" => "2013-10-22T00:00:00.000Z",
    "createdDateTo" => "2013-10-25T00:00:00.000Z"
));

print_r($resp->RemoveImportedTnOrderSummary[0]->OrderStatus);

Create A Remove Imported TN Order

$removeImportedTnOrder = new \Iris\RemoveImportedTnOrder(array(
    "CustomerOrderId" => "custom string",
    "TelephoneNumbers" => array(
        "TelephoneNumber" => array("5554443333", "5553332222")
    )
));

print_r($account->createRemoveImportedTnOrder($removeImportedTnOrder)->Location);

Get Removed Imported TN Order

print_r($account->getRemoveImportedTnOrder("some_id_value")->ProcessingStatus);

Get Removed Imported TN Order History

print_r($account->getRemoveImportedTnOrderHistory("some_id_value")->OrderHistory[0]->Status);

CSR

Create CSR Order

$csrOrder = new \Iris\Csr(array(
    "CustomerOrderId" => "order id",
    "WorkingOrBillingTelephoneNumber" => "5554443333"
));

$response = $account->createCsrOrder($csrOrder);
print_r($response->OrderId);

Replace CSR Order

$csrOrder = new \Iris\Csr(array(
    "CustomerOrderId" => "order id",
    "WorkingOrBillingTelephoneNumber" => "5554443333"
));

$response = $account->replaceCsrOrder("order_id", $csrOrder);
print_r($response->OrderId);

Get CSR Order

$response = $account->getCsrOrder("order_id");
print_r($response->OrderId);

Get CSR Order Notes

$response = $account->getCsrOrderNotes("order_id");
print_r($response->Note[0]->Description);

Add CSR Order Note

$note = new \Iris\CsrNote(array(
    "UserId" => "id",
    "Description" => "description"
));

$account->addNoteToCsr("order_id", $note);

Update CSR Order Note

$note = new \Iris\CsrNote(array(
    "UserId" => "id",
    "Description" => "description"
));

$account->updateCsrOrderNote("order_id", "note_id", $note);

Emergency Notification Recipients

Create Emergency Notification Recipient

$data = array(
  "Description" => "Email to Bldg. 3 Front Desk",
  "Type" => "EMAIL",
  "EmailAddress" => "foo@bar.com"
);
$response = $account->createEmergencyNotificationRecipient($data);

Get Emergency Notification Recipients

$response = $account->getEmergencyNotificationRecipients();

Get Emergency Notification Recipient

$response = $account->getEmergencyNotificationRecipient("id");

Replace Emergency Notification Recipient

$data = array(
  "Description" => "Email to Bldg. 3 Front Desk",
  "Type" => "EMAIL",
  "EmailAddress" => "foo@bar.com"
);
$response = $account->replaceEmergencyNotificationRecipient("id", $data);

Delete Emergency Notification Recipient

$account->deleteEmergencyNotificationRecipient("id");

Emergeny Notification Group

Create Emergency Notification Group Order

$data = array(
  "CustomerOrderId" => "value",
  "AddedEmergenyNotificationGroup" => array(
    "EmergencyNotificationRecipient" => array(
      "Identifier" => "123"
    )
  )
);
$response = $account->createEmergencyNotificationGroupOrder($data);

Get Emergency Notification Group Orders

$response = $account->getEmergencyNotificationGroupOrders();

Get Emergency Notification Group Order

$response = $account->getEmergencyNotificationGroupOrder("id");

Get Emergency Notification Groups

$response = $account->getEmergencyNotificationGroups();

Get Emergency Notification Group

$response = $account->getEmergencyNotificationGroup("id");

Emergency Notification Endpoint

Create Emergency Notification Endpoint Order

$data = array(
  "CustomerOrderId" => "123",
  "EmergencyNotificationEndpointAssociations" => array(
    "EmergenyNotificationGroup" => array(
      "Identifier" => "456"
    )
  )
);
$response = $account->createEmergencyNotificationEndpointOrder($data);

Get Emergency Notification Endpoint Orders

$response = $account->getEmergencyNotificationEndpointOrders();

Get Emergency Notification Endpoint Order

$response = $account->getEmergencyNotificationEndpointOrder("id");

Alternate End User Identiy

Get Alternate End User Information

$response = $account->getAlternateEndUserInformation();

Get Alternate Caller Information

$response = $account->getAlternateCallerInformation("id");

Application Management

Get Applications

$response = $account->getApplications();
print_r($response);

Get Application

$response = $account->getApplication("id");
print_r($response);

Create Application

$data = array(
    'ServiceType' => 'Messaging-V2',
    'AppName' => 'sample',
    'MsgCallbackUrl' => 'https://test.com'
);
$response = $account->createApplication($data);
print_r($response);

Update Application

$data = array(
    'ServiceType' => 'Messaging-V2',
    'AppName' => 'sample',
    'MsgCallbackUrl' => 'https://test2.com'
);
$response = $account->updateApplication("id", $data);
print_r($response);

Delete Application

$account->deleteApplication("id");

Get Application SipPeers

$response = $account->getApplicationSippeers("id");
print_r($response);