Skip to content

v12.0.0

Latest

Choose a tag to compare

@ckoegel ckoegel released this 21 Nov 18:25
139bd60

What's Changed

Full Changelog: v11.0.1...v12.0.0

TN Lookup Migration Guide

  • All new response bodies will contain top level fields links, data, and errors.
  • data will contain information similar to that returned by the V1 response bodies.
  • links will be populated if receiving paginated results from Get Async Lookup Status.
  • errors will contain any errors with your request.

Create Async Lookup Request

Old

$body = new BandwidthLib\PhoneNumberLookup\Models\OrderRequest();
$body->tns = ["+19195551234"];
$resp = $this->bandwidthClient->getPhoneNumberLookup()->getClient()->createLookupRequest("ACCOUNT_ID", $body);
$requestId = $resp->getResult()->requestId;
  • $resp->getResult() was BandwidthLib\PhoneNumberLookup\Models\OrderResponse

New

$body = new BandwidthLib\PhoneNumberLookup\Models\CreateLookupRequest();
$body->phoneNumbers = ["+19195551234"];
$resp = $this->bandwidthClient->getPhoneNumberLookup()->getClient()->createAsyncBulkLookupRequest("ACCOUNT_ID", $body);
$requestId = $resp->getResult()->data->requestId;
  • $resp->getResult() is now BandwidthLib\PhoneNumberLookup\Models\CreateAsyncBulkResponse
  • response data is now inside $resp->getResult()->data
  • $resp->getResult()->data is BandwidthLib\PhoneNumberLookup\Models\CreateAsyncBulkResponseData

Get Async Lookup Status

Old

$resp = $this->bandwidthClient->getPhoneNumberLookup()->getClient()->getLookupRequestStatus("ACCOUNT_ID", $requestId);
$firstResult = $resp->getResult()->result[0];
$phoneNumber = $firstResult->e164Format;
  • $resp->getResult() was BandwidthLib\PhoneNumberLookup\Models\OrderStatus
  • $resp->getResult()->result was an array of BandwidthLib\PhoneNumberLookup\Models\Result

New

$resp = $this->bandwidthClient->getPhoneNumberLookup()->getClient()->getAsyncLookupRequestStatus("ACCOUNT_ID", $requestId);
$firstResult = $resp->getResult()->data->results[0];
$phoneNumber = $firstResult->phoneNumber;
  • $resp->getResult() is now BandwidthLib\PhoneNumberLookup\Models\LookupResponse
  • $resp->getResult()->data is BandwidthLib\PhoneNumberLookup\Models\LookupResponseData
    • This is equivalent to the old OrderStatus
  • $resp->getResult()->data->results is an array of BandwidthLib\PhoneNumberLookup\Models\LookupResult
    • results will be empty until status is COMPLETE

New Synchronous Lookup

Useful if requesting less than 100 TNs

$body = new BandwidthLib\PhoneNumberLookup\Models\CreateLookupRequest();
$body->phoneNumbers = ["+19195551234"];
$resp = $this->bandwidthClient->getPhoneNumberLookup()->getClient()->createSyncLookupRequest("ACCOUNT_ID", $body);
$firstResult = $resp->getResult()->data->results[0];
$phoneNumber = $firstResult->phoneNumber;
  • Request body is the exact same as Create Async Lookup Request, just limited to 100 TNs
  • Response body is the exact same as Get Async Lookup Status, but the status will always be COMPLETE and results will be populated.