number.md

The Number Client

The Number client wraps the number section of 46elks.se docs

Available services

Unlike Sms and Phone calls no sub services exist for the number client.

• Accessing the number client
• Allocate number
• Deallocate number
• Configure number
• Get all
• Get by id

Access the client

The number client may be accessed like this

// Initialize client
use Tarre\Php46Elks\Client as Php46ElkClient;
$Php46ElksClient = new Php46ElkClient('username', 'password');

$number = $Php46ElksClient->number();

Allocate a number

Allocate a virtual phone number

// Initialize client
use Tarre\Php46Elks\Client as Php46ElkClient;
$Php46ElksClient = new Php46ElkClient('username', 'password');

$number = $Php46ElksClient->number();

$result = $number->allocate('+46701474415', ['sms'], 'mobile', ['sms_url' => 'http://yourapp.io/sms']);

print_r($result);

Deallocate number

Deallocate a virtual phone number

// Initialize client
use Tarre\Php46Elks\Client as Php46ElkClient;
$Php46ElksClient = new Php46ElkClient('username', 'password');

$number = $Php46ElksClient->number();

$result = $number->deallocate('enter id', 'yes');

print_r($result);

Configure number

Configure a virtual phone number

// Initialize client
use Tarre\Php46Elks\Client as Php46ElkClient;
$Php46ElksClient = new Php46ElkClient('username', 'password');

$number = $Php46ElksClient->number();

$result = $number->configure('enter id', ['voice_start' => 'http://yourapp.io/voice']);

print_r($result);

Get all

Show virtual phone number information

// Initialize client
use Tarre\Php46Elks\Client as Php46ElkClient;
$Php46ElksClient = new Php46ElkClient('username', 'password');

$number = $Php46ElksClient->number();

$result = $number->get();

// print results
print_r($result->getData());

// get next page
print_r($result->getNext());

Get by id

Show virtual phone number information

// Initialize client
use Tarre\Php46Elks\Client as Php46ElkClient;
$Php46ElksClient = new Php46ElkClient('username', 'password');

$number = $Php46ElksClient->number();

$result = $number->getById('enter id');

print_r($result);