07.keywords.md

List keywords

use FireText\Api;
require 'vendor/autoload.php';

$apiKey = 'YOUR_API_KEY';

$client = new Api\Client(new Api\Credentials\ApiKey($apiKey));

$request = $client->request('Keywords');

$result = $client->response($request);

if($result->isSuccessful()) {
    foreach($result->getItems() as $message) {
        $data = $message->getHydrator()
            ->extract($message);
        
        foreach($data as $field => $value) {
            echo "$field: $value".PHP_EOL;
        }
        echo PHP_EOL;
    }
} else {
    throw $result->getStatus()
        ->getException();
}

Add a forward

use FireText\Api;
require 'vendor/autoload.php';

$apiKey = 'YOUR_API_KEY';

$client = new Api\Client(new Api\Credentials\ApiKey($apiKey));

$keywordId = 1234567890;
$destination = "https://example.net/inbound"; // url, email or mobile

$request = $client->request('Forward', $keywordId, $destination);

$result = $client->response($request);

if($result->isSuccessful()) {
    echo "Forward added successfully".PHP_EOL;
} else {
    throw $result->getStatus()
        ->getException();
}

Remove a forward

use FireText\Api;
require 'vendor/autoload.php';

$apiKey = 'YOUR_API_KEY';

$client = new Api\Client(new Api\Credentials\ApiKey($apiKey));

$keywordId = 1234567890;
$destination = "https://example.net/inbound"; // url, email or mobile

$request = $client->request('Forward', $keywordId, $destination);
$request->setRemove(1);

$result = $client->response($request);

if($result->isSuccessful()) {
    echo "Forward removed successfully".PHP_EOL;
} else {
    throw $result->getStatus()
        ->getException();
}