PHP code example of bandwidth / iris
1. Go to this page and download the library: Download bandwidth/iris library . Choose the download type require .
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
bandwidth / iris example snippets
$client = new \Iris\Client($login, $password, ['url' => 'https://dashboard.bandwidth.com/api/']);
$account = new \Iris\Account($your_account_id, $client);
$sites = $account->sites();
$items = $sites->getList(); // Array(Site1, Site2)
echo json_encode($site->to_array());
$account->availableNumbers([ "areaCode" => "818" ]);
$account->availableNpaNxx(["state" => "CA"]);
$cities = new \Iris\Cities($client);
$items = $cities->getList(["state" => "NC"]);
$rcs = new Iris\CoveredRateCenters($client);
$rateCenters = $rcs->getList(["page" => 1, "size" => 10 ]);
$account->disnumbers(["areaCode" => "919"]);
$disconnect = $account->disconnects()->create([
"name" => "test disconnect order 4",
"CustomerOrderId" => "Disconnect1234",
"DisconnectTelephoneNumberOrderType" => [
"TelephoneNumberList" => [
"TelephoneNumber" => [ "9192755378", "9192755703" ]
]
]
]);
$disconnect = $account->disconnects()->disconnect("b902dee1-0585-4258-becd-5c7e51ccf5e1", true); // tnDetails: true
$disconnect->notes()->create([ "UserId" => "byo_dev", "Description" => "Test Note"]);
$items = $disconnect->notes()->getList();
$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);
$dlda = $account->dldas()->dlda("7802373f-4f52-4387-bdd1-c5b74833d6e2");
$dlda->history();
$account->dldas()->getList(["telephoneNumber" => "9195551212"]);
$account->inserviceNumbers(["areaCode" => "919"]);
$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);
$lidb = $account->lidbs()->lidb("7802373f-4f52-4387-bdd1-c5b74833d6e2");
$lidbs = $account->lidbs()->getList(["lastModifiedAfter" => "mm-dd-yy", "telephoneNumber"=> "888"]);
$account->lnpChecker(["4109255199", "9196190594"], "true");
$order = $account->orders()->create([
"Name" => "Available Telephone Number order",
"SiteId" => "2297",
"CustomerOrderId" => "123456789",
"ExistingTelephoneNumberOrderType" => [
"TelephoneNumberList" => [
"TelephoneNumber" => [ "9193752369", "9193752720", "9193752648"]
]
]
]);
$response = $account->orders()->order("f30a31a1-1de4-4939-b094-4521bbe5c8df", true); // tndetail=true
$order = $response->Order;
$items = $account->orders()->getList();
$order->notes()->create([ "UserId" => "byo_dev", "Description" => "Test Note"]);
$order->tns()->getList();
$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"
));
$portin = $account->portins()->portin("d28b36f7-fa96-49eb-9556-a40fca49f7c6"));
$portins = $account->portins()->getList(["pon" => "a pon" ]);
$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->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');
$response = $portin->loas_send('./hello.txt', array("Content-Type" => "text/plain"));
$tmp = explode("/", $response);
$id = end($tmp);
print_r($id);
$rc = new \Iris\RateCenter($client);
$cities = $rc->getList(["state" => "CA", "available" => "true"]);
$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
)
)
));
$sippeer = $account->sippeers->sippeer("500651");
$sippeers = $account->sippeers()->getList();
$sippeer->delete();
$sippeer->movetns([ "FullNumber" => [ "9192000046", "9192000047", "9192000048" ]]);
$tns = $sippeer->tns()->getList();
$tn = $sippeer->tns()->tn("8183386251");
$count = $sippeer->totaltns();
$sippeer->tns()->tn("8183386251")->set_tn_options([
"FullNumber" => "8183386251",
"CallForward" => "9194394706",
"RewriteUser" => "JohnDoe",
"NumberFormat" => "10digit",
"RPIDFormat" => "e164"
]);
$site = $account->sites()->create(
array("Name" => "Test Site",
"Address" => array(
"City" => "Raleigh",
"AddressType" => "Service",
"HouseNumber" => "1",
"StreetName" => "Avenue",
"StateCode" => "NC"
)));
$site->Name = "New Name";
$site->update();
$site->delete();
$sites = $account->sites()->getList();
$site->orders()->getList(["status" => "disabled"]);
$site->totaltns();
$site->portins()->getList(["status" => "disabled" ]);
$site->sippeers()->create([...])
$subscription = $account->subscriptions()->create([
"OrderType" => "portins",
"OrderId" => "98939562-90b0-40e9-8335-5526432d9741",
"EmailSubscription" => [
"Email" => "[email protected] ",
"DigestRequested" => "DAILY"
]
]);
$subscription = $account->subscriptions()->subscription($id);
$account->subscriptions()->getList(["orderType" => "portins"]);
$subscription->OrderType = "portins";
$subscription->update();
$subscription->delete();
$tns = new Iris\Tns(null, $client);
$tn = $tns->tn($id);
$tns = new Iris\Tns(null, $client);
$tns_items = $tns->getList(["page" => 1, "size" => 10 ]);
$tn = $tns->tn("7576768750");
$site = $tn->site();
$sippeer = $tn->sippeer();
$tnreservation = $tn->tnreservation();
$tn->tndetails();
$rc = $tn->ratecenter();
$lata = $tn->lata();
$lca = $tn->lca();
$resertation = $account->tnsreservations()->create(["ReservedTn" => "2512027430"]);
$resertation = $account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");
$resertation = $account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");
$resertation->delete();
$billingReports = $account->billingreports()->getList();
$billingReport = $account->billingreports()->request(
array("Type" => "bdr",
"DateRange" => array(
"StartDate" => "2018-02-05",
"EndDate" => "2018-02-06",
)));
$billingReport = $account->billingreports()->billingreport('a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2');
$zipStream = $billingReport->file();
$outFile = '/tmp/report.zip';
$billingReport->file(['stream' => true, 'sink' => $outFile]);
$tnoptions = $account->tnoptions();
$response = $tnoptions->getList();
print_r($response[0]->OrderId);
$tnoptions = $account->tnoptions();
$response = $tnoptions->tnoption("order_id");
print_r($response->OrderCreateDate);
$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
$tnoptions = $account->tnoptions();
$data = array(
"TnOptionGroups" => array(
"TnOptionGroup" => array(
"PortOutPasscode" => "12abd38",
"TelephoneNumbers" => array(
"TelephoneNumber" => "2018551020"
)
),
)
);
$response = $tnoptions->create($data);
print_r($response->OrderCreateDate);
$tnoptions = $account->tnoptions();
$data = array(
"TnOptionGroups" => array(
"TnOptionGroup" => array(
"CallForward" => "2018551022",
"TelephoneNumbers" => array(
"TelephoneNumber" => "2018551020"
)
),
)
);
$response = $tnoptions->create($data);
print_r($response->OrderCreateDate);
$tnoptions = $account->tnoptions();
$data = array(
"TnOptionGroups" => array(
"TnOptionGroup" => array(
"Sms" => "on",
"TelephoneNumbers" => array(
"TelephoneNumber" => "2018551020"
)
),
)
);
$response = $tnoptions->create($data);
print_r($response->OrderCreateDate);
$resp = $account->getImportTnOrders(array(
"createdDateFrom" => "2013-10-22T00:00:00.000Z",
"createdDateTo" => "2013-10-25T00:00:00.000Z"
));
print_r($resp->ImportTnOrderSummary[0]->OrderId);
$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);
print_r($account->getImportTnOrder("some_id_value")->ProcessingStatus);
print_r($account->getImportTnOrderHistory("some_id_value")->OrderHistory[0]->Status);
$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)
$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);
$response = $account->downloadImportTnOrderLoaFile("order_id", "file_id");
$file = fopen("write.pdf", "wb") or die("Unable to open file");
fwrite($file, $response);
fclose($file);
$account->replaceImportTnOrderLoaFile("order_id", "file_id", "binary_file_contents", "mime_type");
$account->deleteImportTnOrderLoaFile("order_id", "file_id");
$response = $account->getImportTnOrderLoaFileMetadata("order_id", "file_id");
print_r($response->DocumentName);
echo "\n";
print_r($response->DocumentType);
$file_metadata = new \Iris\FileMetaData(array(
"DocumentName" => "Updated",
"DocumentType" => "LOA"
));
$account->updateImportTnOrderLoaFileMetadata("order_id", "file_id", $file_metadata);
$account->deleteImportTnOrderLoaFileMetadata("order_id", "file_id");
print_r($account->checkTnsPortability(array("5554443333", "5553334444"))->ImportTnCheckerPayload);
print_r($account->getInserviceNumbers(array("areacode" => "919"))->TelephoneNumbers->Count);
print_r($account->checkInserviceNumber("5554443333"));
$resp = $account->getRemoveImportedTnOrders(array(
"createdDateFrom" => "2013-10-22T00:00:00.000Z",
"createdDateTo" => "2013-10-25T00:00:00.000Z"
));
print_r($resp->RemoveImportedTnOrderSummary[0]->OrderStatus);
$removeImportedTnOrder = new \Iris\RemoveImportedTnOrder(array(
"CustomerOrderId" => "custom string",
"TelephoneNumbers" => array(
"TelephoneNumber" => array("5554443333", "5553332222")
)
));
print_r($account->createRemoveImportedTnOrder($removeImportedTnOrder)->Location);
print_r($account->getRemoveImportedTnOrder("some_id_value")->ProcessingStatus);
print_r($account->getRemoveImportedTnOrderHistory("some_id_value")->OrderHistory[0]->Status);
$csrOrder = new \Iris\Csr(array(
"CustomerOrderId" => "order id",
"WorkingOrBillingTelephoneNumber" => "5554443333"
));
$response = $account->createCsrOrder($csrOrder);
print_r($response->OrderId);
$csrOrder = new \Iris\Csr(array(
"CustomerOrderId" => "order id",
"WorkingOrBillingTelephoneNumber" => "5554443333"
));
$response = $account->replaceCsrOrder("order_id", $csrOrder);
print_r($response->OrderId);
$response = $account->getCsrOrder("order_id");
print_r($response->OrderId);
$response = $account->getCsrOrderNotes("order_id");
print_r($response->Note[0]->Description);
$note = new \Iris\CsrNote(array(
"UserId" => "id",
"Description" => "description"
));
$account->addNoteToCsr("order_id", $note);
$note = new \Iris\CsrNote(array(
"UserId" => "id",
"Description" => "description"
));
$account->updateCsrOrderNote("order_id", "note_id", $note);
bash
composer install
php ./bin/phpunit --bootstrap ./vendor/autoload.php tests/
bash
$ cd examples
$ composer install
$ cp config.php.example config.php
bash
php availableNumbers-sample.php
php
$data = array(
"Description" => "Email to Bldg. 3 Front Desk",
"Type" => "EMAIL",
"EmailAddress" => "[email protected] "
);
$response = $account->createEmergencyNotificationRecipient($data);
php
$response = $account->getEmergencyNotificationRecipients();
php
$response = $account->getEmergencyNotificationRecipient("id");
php
$data = array(
"Description" => "Email to Bldg. 3 Front Desk",
"Type" => "EMAIL",
"EmailAddress" => "[email protected] "
);
$response = $account->replaceEmergencyNotificationRecipient("id", $data);
php
$account->deleteEmergencyNotificationRecipient("id");
php
$data = array(
"CustomerOrderId" => "value",
"AddedEmergenyNotificationGroup" => array(
"EmergencyNotificationRecipient" => array(
"Identifier" => "123"
)
)
);
$response = $account->createEmergencyNotificationGroupOrder($data);
php
$response = $account->getEmergencyNotificationGroupOrders();
php
$response = $account->getEmergencyNotificationGroupOrder("id");
php
$response = $account->getEmergencyNotificationGroups();
php
$response = $account->getEmergencyNotificationGroup("id");
php
$data = array(
"CustomerOrderId" => "123",
"EmergencyNotificationEndpointAssociations" => array(
"EmergenyNotificationGroup" => array(
"Identifier" => "456"
)
)
);
$response = $account->createEmergencyNotificationEndpointOrder($data);
php
$response = $account->getEmergencyNotificationEndpointOrders();
php
$response = $account->getEmergencyNotificationEndpointOrder("id");
php
$response = $account->getAlternateEndUserInformation();
php
$response = $account->getAlternateCallerInformation("id");
php
$response = $account->getApplications();
print_r($response);
php
$response = $account->getApplication("id");
print_r($response);
php
$data = array(
'ServiceType' => 'Messaging-V2',
'AppName' => 'sample',
'MsgCallbackUrl' => 'https://test.com'
);
$response = $account->createApplication($data);
print_r($response);
php
$data = array(
'ServiceType' => 'Messaging-V2',
'AppName' => 'sample',
'MsgCallbackUrl' => 'https://test2.com'
);
$response = $account->updateApplication("id", $data);
print_r($response);
php
$account->deleteApplication("id");
php
$response = $account->getApplicationSippeers("id");
print_r($response);