Relay SDK for PHP

Getting Started

The Relay SDK for PHP enables PHP developers to connect and use SignalWire's Relay APIs within their own PHP code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications.

The Relay SDK for PHP is easy to use and only takes a few minute to setup and get running.

Latest Version:

Source Code: signalwire/signalwire-php

Support: SignalWire Community Slack Channel

Installation

Install the package using Composer:

composer require signalwire/signalwire

Minimum Requirements

The PHP SDK requires PHP 7.1 or greater installed on your system.

Using the SDK

The PHP SDK can be used to get up and running with Relay quickly and easily. In order to use the PHP client, you must get your project and token from your SignalWire dashboard.

There are a few ways to get started, depending on your needs: Relay.Consumer, Relay.Task, and Relay.Client.

Relay Consumer

A Relay.Consumer creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs.

Relay Consumers can scale easily, simply by running multiple instances of your Relay.Consumer process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments.

Setting up a new consumer is the easiest way to get up and running.

<?php

require dirname(__FILE__) . '/vendor/autoload.php';

use Generator as Coroutine;
use SignalWire\Relay\Consumer;

class CustomConsumer extends Consumer {
  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
  public $contexts = ['home', 'office'];

  public function ready(): Coroutine {
    yield;
    // Consumer is successfully connected with Relay.
    // You can make calls or send messages here..
  }

  public function onIncomingCall($call): Coroutine {
    $result = yield $call->answer();
    if ($result->isSuccessful()) {
      yield $call->playTTS(['text' => 'Welcome to SignalWire!']);
    }
  }
}

$consumer = new CustomConsumer();
$consumer->run();

Learn more about Relay Consumers

Relay Task

A Relay.Task is simple way to send jobs to your Relay.Consumers from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously.

For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately.

Send a task in the office context with custom data.

// create-task.php
<?php

require dirname(__FILE__) . '/vendor/autoload.php';

use SignalWire\Relay\Tasking\Task;

$task = new Task('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');
$context = 'office';
$delivered = $task->deliver($context, [
  'uuid' => 'unique id',
  'data' => 'data for your job'
]);

Handle the task in a Consumer.

// consumer-task.php
<?php

require dirname(__FILE__) . '/vendor/autoload.php';

use Generator as Coroutine;

class CustomConsumer extends SignalWire\Relay\Consumer {
  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
  public $contexts = ['office']; // Task is delivered on the "office" context!

  public function onTask($message): Coroutine {
    yield;
    // Retrieve your custom properties in $message..
    echo $message->uuid; // 'unique id'
    echo $message->data; // 'data for your job'
  }
}

$consumer = new CustomConsumer();
$consumer->run();

Learn more about Relay Tasks

Relay Client

Relay.Client is a lower level object, giving you a basic connection to Relay but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the Relay connection yourself.

Setting up a new client and make an outbound call.

<?php

$client = new SignalWire\Relay\Client([
  'project' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  'token' => 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
]);

$client->on('signalwire.ready', function($client) {

  $params = [ 'type' => 'phone', 'from' => '+1XXXXXXXXXX', 'to' => '+1YYYYYYYYYY' ];
  $client->calling->dial($params)->done(function($result) {
    if ($result->isSuccessful()) {
      // Your active $call..
      $call = $result->getCall();
    }
  });

});

$client->connect();

Learn more about Relay Clients

Contexts

Relay uses Contexts as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the context; Relay will then deliver that call or event to Consumers that are configured to listen for that context.

For example, you could have a customer support phone number configured to send to Relay with the support context, and a personal number configured with personal context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules.

API Reference

Relay.Client

Relay.Client is the basic connection to Relay, allowing you send commands to Relay and setup handlers for inbound events.

Constructor

Constructs a client object to interact with Relay.

Parameters

Examples

Create a Client to interact with the Relay API.

<?php

$client = new SignalWire\Relay\Client([
  'project' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  'token' => 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
]);

Properties

Methods

connect

Activates the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established.

Available In:

Returns

void

Examples

<?php

$client->connect();

disconnect

Disconnect the client from Relay.

Available In:

Returns

void

Examples

<?php

$client->disconnect();

on

Attach an event handler for a specific type of event.

Available In:

Parameters

Returns

Relay.Client - The client object itself.

Examples

Subscribe to the signalwire.ready and signalwire.error events.

<?php

$client->on('signalwire.ready', function($client) {
  // Your client is ready!
})->on('signalwire.error', function(\Exception $error) {
  // Got an error...
});

off

Remove an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed.

Parameters

Returns

Relay.Client - The client object itself.

Examples

Subscribe to the signalwire.error and then, remove the event handler.

<?php

$errorHandler = function($error) {
  // Log the error..
};

$client->on('signalwire.error', $errorHandler);

// .. later
$client->off('signalwire.error', $errorHandler);

Events

All available events you can attach a listener on.

Relay.Calling

This represents the API interface for the Calling Relay Service. This object is used to make requests related to managing end to end calls.

Methods

dial

Make an outbound Call and waits until it has been answered or hung up.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DialResult object.

Examples

Make an outbound Call and grab the call object if it was answered.

<?php

$params = [ 'type' => 'phone', 'from' => '+1XXXXXXXXXX', 'to' => '+1YYYYYYYYYY' ];
$client->calling->dial($params)->done(function($dialResult) {
  if ($dialResult->isSuccessful()) {
    // Your active $call..
    $call = $dialResult->getCall();
  }
});

newCall

Create a new Call object. The call has not started yet allowing you to attach event listeners on it.

Available In:

Parameters

See Relay.Calling.Dial for the parameter list.

Returns

Call - A new Relay.Calling.Call object.

Examples

Create a new Call object.

<?php

$params = [ 'type' => 'phone', 'from' => '+1XXXXXXXXXX', 'to' => '+1YYYYYYYYYY' ];
$call = $client->calling->newCall($params);
// Use the $call object...

Relay.Calling.AnswerResult

This object returned from the answer method.

Methods

getEvent

Returns the last Relay Event arrived for this operation.

Available In:

Parameters

None

Returns

Relay.Event - Last Relay Event.

Examples

Start recording in stereo mode and grab the result when it's completed.

<?php

$call->answer()->done(function($result) {
  $event = $result->getEvent();
  // Inspect $event->payload ..
});

isSuccessful

Return true if the call was answered without errors, false otherwise.

Available In:

Parameters

None

Returns

boolean - Whether the call has been answered successfully.

Examples

Start the recording and then check if it has ended successfully.

<?php

$call->answer()->done(function($result) {
  if ($result->isSuccessful()) {
    // $call is now active...
  }
});

Relay.Calling.Call

All calls in SignalWire have a common generic interface, Call. A Call is a connection between SignalWire and another device.

Properties

Methods

amd

Alias for detectAnsweringMachine.

amdAsync

Alias for detectAnsweringMachineAsync.

answer

Answer an inbound call.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.AnswerResult object.

Examples

Answer an inbound call and check if it was successful.

<?php

$call->answer()->done(function($answerResult) {

});

connect

Attempt to connect an existing call to a new outbound call and waits until one of the remote party picks the call or the connect fails.
This method involves complex nested parameters. You can connect to multiple devices in series, parallel, or any combination of both with creative use of the parameters. Series implies one device at a time, while parallel implies multiple devices at the same time.

Available In:

Parameters

• Structure of a device:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.ConnectResult object.

Examples

Try connecting by calling +18991114444 and +18991114445 in series.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connect(...$devices)->done(function($connectResult) {
  if ($connectResult->isSuccessful()) {
    $remoteCall = $connectResult->getCall();
  }
});

Combine serial and parallel calling. Call +18991114443 first and - if it doesn't answer - try calling in parallel +18991114444 and +18991114445. If none of the devices answer, continue the same process with +18991114446 and +18991114447.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114443", "timeout" => 30 ],
  [
    [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
    [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
  ],
  [
    [ "type" => "phone", "to" => "+18991114446", "timeout" => 30 ],
    [ "type" => "phone", "to" => "+18991114447", "timeout" => 20 ]
  ]
];
$call->connect(...$devices)->done(function($connectResult) {
  if ($connectResult->isSuccessful()) {
    $remoteCall = $connectResult->getCall();
  }
});

Try connecting by calling +18991114444 and +18991114445 in series playing the US ringtone.

<?php

$params = [
  "devices" => [
    [ "type" => "phone", "to" => "+18991114444" ],
    [ "type" => "phone", "to" => "+18991114445" ]
  ],
  "ringback" => [ "type" => "ringtone", "name" => "us" ]
];
$call->connect(...$devices)->done(function($connectResult) {
  if ($connectResult->isSuccessful()) {
    $remoteCall = $connectResult->getCall();
  }
});

connectAsync

Asynchronous version of connect. It does not wait the connect to completes or fails but returns a Relay.Calling.ConnectAction you can interact with.

Available In:

Parameters

See connect for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.ConnectAction object.

Examples

Trying to connect a call by calling in series +18991114444 and +18991114445.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connect(...$devices)->done(function($connectAction) {
  // .. do other important things while Relay try to connect your call..

  // then check whether the action has completed
  if ($connectAction->isCompleted()) {

  }
});

detect

Start a detector on the call and waits until it has finished or failed.

The detect method is a generic method for all types of detecting, see detectAnsweringMachine, detectDigit or detectFax for more specific usage.

Available In:

Parameters

• To detect an answering machine:

• To detect digits:

• To detect a fax:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect a machine with custom parameters and timeout.

<?php

$params = [
  'type' => 'machine',
  'timeout' => 45,
  'initial_timeout' => 3.0
];
$call->detect($params)->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {
    $type = $detectResult->getType(); // machine
    $result = $detectResult->getResult(); // MACHINE / HUMAN / UNKNOWN
  }
});

Detect a Fax setting timeout only.

<?php

$params = [
  'type' => 'fax',
  'timeout' => 45
];
$call->detect($params)->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {

  }
});

detectAsync

Asynchronous version of detect. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detect for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect digits using default parameters. Stop the action immediately.

<?php

$call->on('detect.update', function ($call, $params) {
  // Handle a detector event here..
  print_r($params);
});
$call->detectAsync([ 'type' => 'digit' ])->done(function ($detectAction) {
  // Do other things while detector runs and then stop it.
  if (!$detectAction->isCompleted()) {
    $detectAction->stop();
  }
});

detectAnsweringMachine

This is a helper function that refines the use of detect. The Promise will be resolved with a Relay.Calling.DetectResult object as soon as the detector decided who answered the call: MACHINE, HUMAN or UNKNOWN.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Perform an AMD and wait until the machine is ready.

<?php

$params = [
  'wait_for_beep' => true
];
$call->detectAnsweringMachine($params)->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {
    $result = $detectResult->getResult(); // MACHINE || HUMAN || UNKNOWN
  }
});

detectAnsweringMachineAsync

Asynchronous version of detectAnsweringMachine. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detectAnsweringMachine for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Perform an asynchronous AMD on the call. Then stop the action if not completed yet.

<?php

$call->on('detect.update', function ($call, $params) {
  // Handle a detector event here..
  print_r($params);
});
$call->detectAnsweringMachineAsync()->done(function ($detectAction) {
  // Do other things while detector runs and then stop it.
  if (!$detectAction->isCompleted()) {
    $detectAction->stop();
  }
});

detectDigit

This is a helper function that refines the use of detect. This simplifies detecting digits on a call.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect digits and then write a log with the result.

<?php

$call->detectDigit()->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {
    echo "Digits detected: " . $detectResult->getResult();
  }
});

detectDigitAsync

Asynchronous version of detectDigit. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detectDigit for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect only 1-3 digits asynchronously.

<?php

$call->on('detect.update', function ($call, $params) {
  // Handle a detector event here..
  print_r($params);
});
$call->detectDigitAsync([ 'digits' => '123' ])->done(function ($detectAction) {
  // Do other things while detector runs and then stop it.
  if (!$detectAction->isCompleted()) {
    $detectAction->stop();
  }
});

detectFax

This is a helper function that refines the use of detect. This simplifies detecting a fax.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect fax on the current call.

<?php

$call->detectFax()->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {
    // A fax has been detected!
  }
});

detectFaxAsync

Asynchronous version of detectFax. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detectFax for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect fax on the current call. Stop the action immediately.

<?php

$call->on('detect.update', function ($call, $params) {
  // Handle a detector event here..
  print_r($params);
});
$call->detectFaxAsync()->done(function ($detectAction) {
  // Do other things while detector runs and then stop it.
  if (!$detectAction->isCompleted()) {
    $detectAction->stop();
  }
});

detectHuman

This is a helper function that refines the use of detect. This simplifies detecting a human on the call and is the inverse of detectMachine.

Deprecated since: Use detectAnsweringMachine instead.

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect a human on the current call.

<?php

$call->detectHuman()->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {
    // A human has been detected!
  }
});

detectHumanAsync

Asynchronous version of detectHuman. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Deprecated since: Use detectAnsweringMachineAsync instead.

Parameters

See detectHuman for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect a human on the current call. Stop the action immediately.

<?php

$call->detectHumanAsync()->done(function ($detectAction) {
  // For demonstration purposes only..
  $detectAction->stop();
});

detectMachine

This is a helper function that refines the use of detect. This simplifies detecting a machine on the call and is the inverse of detectHuman.

Deprecated since: Use detectAnsweringMachine instead.

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect a machine on the current call.

<?php

$call->detectMachine()->done(function($detectResult) {
  if ($detectResult->isSuccessful()) {
    // A machine has been detected!
  }
});

detectMachineAsync

Asynchronous version of detectMachine. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Deprecated since: Use detectAnsweringMachineAsync instead.

Parameters

See detectMachine for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect a machine on the current call. Stop the action immediately.

<?php

$call->detectMachineAsync()->done(function ($detectAction) {
  // For demonstration purposes only..
  $detectAction->stop();
});

dial

This will start a call that was created with newCall and waits until the Call has been answered or hung up.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DialResult object.

Examples

<?php

$call->dial()->done(function($dialResult) {

});

faxReceive

Prepare the call to receive an inbound fax. It waits until the fax has been received or failed.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.FaxResult object.

Examples

Receiving a fax on the call and print logs for URL and number of received pages.

<?php

$call->faxReceive()->done(function($faxResult) {
  echo 'URL: ' . $faxResult->getDocument() . PHP_EOL;
  echo 'Total pages: ' . $faxResult->getPages();
});

faxReceiveAsync

Asynchronous version of faxReceive. It does not wait the fax to be received but returns Relay.Calling.FaxAction you can interact with.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.FaxAction object.

Examples

Trying to receive a fax and then stop it.

<?php

$call->faxReceiveAsync()->done(function ($faxAction) {
  // For demonstration purposes only..
  $faxAction->stop();
});

faxSend

Send a fax through the call. It waits until the fax has been sent or failed.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.FaxResult object.

Examples

Sending a fax on the call and print logs the number of sent pages.

<?php

$call->faxSend('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', null, 'Custom Header')->done(function($faxResult) {
  echo "\n URL: " . $faxResult->getDocument();
  echo "\n Total pages: " . $faxResult->getPages();
});

faxSendAsync

Asynchronous version of faxSend. It does not wait the fax to be sent but returns a Relay.Calling.FaxAction you can interact with.

Available In:

Parameters

See faxSend for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.FaxAction object.

Examples

Trying to send a fax and then stop it.

<?php

$call->faxSendAsync('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', null, 'Custom Header')->done(function ($faxAction) {
  // For demonstration purposes only..
  $faxAction->stop();
});

hangup

Hangup the call.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.HangupResult object.

Examples

Hangup the current call and check if it was successful.

<?php

$call->hangup()->done(function($hangupResult) {
  if ($hangupResult->isSuccessful()) {

  }
});

on

Attach an event handler for the event.

Available In:

Parameters

Returns

Relay.Calling.Call - The call object itself.

Examples

Subscribe to the answered and ended events for a given call.

<?php

$call->on('ended', function($call) {
  // Call has ended.. cleanup something?
});

off

Remove an event handler that were attached with the on method. If you don't pass a $handler, all listeners for that event will be removed.

Available In:

Parameters

Returns

Relay.Calling.Call - The call object itself.

Examples

Subscribe to the call ended state change and then, remove the event handler.

<?php

$callback = function($call) {
  // Call has ended.
};

$call->on('ended', $callback);

// .. later
$call->off('ended', $callback);

play

Play one or multiple media in a call and waits until the playing has ended.

The play method is a generic method for all types of playing, see playAudio, playSilence, playTTS or playRingtone for more specific usage.

Available In:

Parameters

$params	array	required	Array with the following properties:
media	array	required	List of media elements to play. See below for each type.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

• To play an audio file:

• To play a text to speech string:

• To play silence:

• To play ringtone:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play multiple media elements in the call.

<?php

$params = [
  'media' => [
    [ "type" => "tts", "text" => "Listen this awesome file!" ],
    [ "type" => "audio", "url" => "https://example.domain.com/audio.mp3" ],
    [ "type" => "silence", "duration" => 5 ],
    [ "type" => "tts", "text" => "Did you like it?" ]
  ],
  'volume' => 4.0
];
$call->play($params)->done(function ($playResult) {
  if ($playResult->isSuccessful()) {

  }
});

playAsync

Asynchronous version of play. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See play for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play multiple media elements in the call and then stop it.

<?php

$params = [
  'media' => [
    [ "type" => "tts", "text" => "Listen this awesome file!" ],
    [ "type" => "audio", "url" => "https://example.domain.com/audio.mp3" ],
    [ "type" => "silence", "duration" => 5 ],
    [ "type" => "tts", "text" => "Did you like it?" ]
  ],
  'volume' => 4.0
];
$call->playAsync($params)->done(function ($playAction) {
  // For demonstration purposes only..
  $playAction->stop();
});

playAudio

This is a helper function that refines the use of play. This simplifies playing an audio file.

Available In:

Parameters

$params	array	required	Array with the following properties:
url	string	required	Http(s) URL to audio resource to play.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play an Mp3 file using the signature with a string as parameter.

<?php

$call->playAudio('https://cdn.signalwire.com/default-music/welcome.mp3')->done(function($playResult) {
  // interact with $playResult..
});

Play an Mp3 file setting volume level to 4dB. Require v2.3+

<?php

$params = [
  'url' => 'https://cdn.signalwire.com/default-music/welcome.mp3',
  'volume' => 4.0
];
$call->playAudio($params)->done(function($playResult) {
  // interact with $playResult..
});

playAudioAsync

Asynchronous version of playAudio. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playAudio for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play an Mp3 file and stop it after 5 seconds.

<?php

$call->playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')->done(function($playAction) {
  // For demonstration purposes only..
  $playAction->stop();
});

Play an Mp3 file setting the volume and stop it after 5 seconds.

<?php

$params = [
  'url' => 'https://cdn.signalwire.com/default-music/welcome.mp3',
  'volume' => 4.0
];
$call->playAudioAsync($params)->done(function($playAction) {
  // For demonstration purposes only..
  $playAction->stop();
});

playRingtone

This is a helper function that refines the use of play. This simplifies play a ringtone.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play a single US ringtone.

<?php

$params = [ 'name' => 'us' ];
$call->playRingtone($params)->done(function($playResult) {
  // interact with $playResult..
});

playRingtoneAsync

Asynchronous version of playRingtone. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playRingtone for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play US ringtone for 30 seconds, if Agent is available, stop the play.

<?php

$params = [ 'name' => 'us', 'duration' => 30 ];
$call->playRingtoneAsync($params)->done(function($playAction) use ($globalAgent) {
  // For demonstration purposes only ..
  if ($globalAgent->isAvailable()) {
    $playAction->stop();
  }
});

playSilence

This is a helper function that refines the use of play. This simplifies playing silence.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play silence for 10 seconds.

<?php

$call->playSilence(10)->done(function($playResult) {
  // interact with $playResult..
});

playSilenceAsync

Asynchronous version of playSilence. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playSilence for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play silence for 60 seconds, if Agent is available, stop the play.

<?php

$call->playSilenceAsync(60)->done(function($playAction) use ($globalAgent) {
  // For demonstration purposes only ..
  if ($globalAgent->isAvailable()) {
    $playAction->stop();
  }
});

playTTS

This is a helper function that refines the use of play. This simplifies playing TTS.

Available In:

Parameters

$params	array	required	Array with the following properties:
text	string	required	TTS to play.
language	string	optional	Default to en-US.
gender	string	optional	male or female. Default to female.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play TTS.

<?php

$params = [ 'text' => 'Welcome to SignalWire!' ];
$call->playTTS($params)->done(function($playResult) {
  // interact with $playResult..
});

playTTSAsync

Asynchronous version of playTTS. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playTTS for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play TTS and stop it after 5 seconds.

<?php

$params = [ 'text' => 'Welcome to SignalWire!' ];
$call->playTTSAsync($params)->done(function($playAction) {
  // interact with $playAction..

  $playAction->stop();
});

prompt

Play one or multiple media while collecting user's input from the call at the same time, such as digits and speech.

It waits until the collection succeed or timeout is reached.

The prompt method is a generic method, see promptAudio, promptTTS or promptRingtone for more specific usage.

Available In:

Parameters

$collect	array	required	Array with the following properties:
type	string	required	digits, speech or both.
media	array	required	List of media elements to play. See play for the array structure.
initial_timeout	number	optional	Initial timeout in seconds. Default to 4 seconds.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

• To collect digits:

• To collect speech:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Ask user to enter their PIN and collect the digits.

<?php

$mediaToPlay = [
  ['type' => 'tts', 'text' => 'Welcome at SignalWire. Please, enter your PIN and then # to proceed']
];
$collect = [
  'type' => 'digits',
  'digits_max' => 4,
  'digits_terminators' => '#',
  'media' => $mediaToPlay
];
$call->prompt($collect)->done(function($promptResult) {
  if ($promptResult->isSuccessful()) {
    $type = $promptResult->getType(); // => digit
    $pin = $promptResult->getResult(); // => pin entered by the user
  }
});

promptAsync

Asynchronous version of prompt. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See prompt for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Ask user to enter their PIN and collect the digits.

<?php

$mediaToPlay = [
  ['type' => 'tts', 'text' => 'Welcome at SignalWire. Please, enter your PIN and then # to proceed']
];
$collect = [
  'type' => 'digits',
  'digits_max' => 4,
  'digits_terminators' => '#',
  'media' => $mediaToPlay
];
$call->promptAsync($collect, $tts)->done(function($promptAction) {
  // .. do other important things while collecting user digits..
  if ($promptAction->isCompleted()) {
    $promptResult = $promptAction->getResult(); // => Relay.Calling.PromptResult Object
  }
});

promptAudio

This is a helper function that refines the use of prompt.
This function simplifies playing an audio file while collecting user's input from the call, such as digits and speech.

Available In:

Parameters

You can set all the properties that prompt accepts replacing media with:

The SDK will build the media for you.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Collect user's digits while playing an Mp3 file.

<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 4,
  'url' => 'https://cdn.signalwire.com/default-music/welcome.mp3'
];
$call->promptAudio($collect)->done(function($promptResult) {
  if ($promptResult->isSuccessful()) {
    $type = $promptResult->getType(); // => digit
    $pin = $promptResult->getResult(); // => pin entered by the user
  }
});

promptAudioAsync

Asynchronous version of promptAudio. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See promptAudio for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Ask user to enter their PIN and collect the digits.

<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 4,
  'url' => 'https://cdn.signalwire.com/default-music/welcome.mp3'
];
$call->promptAudioAsync($collect)->done(function($promptAction) {
  // .. do other important things while collecting user digits..
  if ($promptAction->isCompleted()) {
    $promptResult = $promptAction->getResult(); // => Relay.Calling.PromptResult Object
  }
});

promptRingtone

This is a helper function that refines the use of prompt.
This function simplifies playing ringtone while collecting user's input from the call, such as digits and speech.

Available In:

Parameters

You can set all the properties that prompt accepts replacing media with:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Play US ringtone for 30 seconds while collect digits.

<?php

$params = [
  'type' => 'digits',
  'digits_max' => 3,
  'name' => 'us',
  'duration' => '30'
];
$call->promptRingtone($params)->done(function($promptResult) {
  if ($promptResult->isSuccessful()) {
    $type = $promptResult->getType(); // => digit
    $pin = $promptResult->getResult(); // => user's digits
  }
});

promptRingtoneAsync

Asynchronous version of promptRingtone. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See promptRingtone for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Play US ringtone for 30 seconds while collect digits in asynchronous.

<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'name' => 'us',
  'duration' => '30'
];
$call->promptRingtoneAsync($collect)->done(function($promptAction) {
  // .. do other important things while collecting user digits..

  if ($promptAction->isCompleted()) {
    $promptResult = $promptAction->getResult(); // => Relay.Calling.PromptResult Object
  }
});

promptTTS

This is a helper function that refines the use of prompt.
This function simplifies playing TTS while collecting user's input from the call, such as digits and speech.

Available In:

Parameters

You can set all the properties that prompt accepts replacing media with:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Ask user to enter their PIN and collect the digits.

<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'text' => 'Please, enter your 3 digit PIN.'
];
$call->promptTTS($collect)->done(function($promptResult) {
  if ($promptResult->isSuccessful()) {
    $type = $promptResult->getType(); // => digit
    $pin = $promptResult->getResult(); // => pin entered by the user
  }
});

promptTTSAsync

Asynchronous version of promptTTS. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See promptTTS for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Ask user to enter their PIN and collect the digits.

<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'text' => 'Please, enter your 3 digit PIN.'
];
$call->promptTTSAsync($collect)->done(function($promptAction) {
  // .. do other important things while collecting user digits..
  if ($promptAction->isCompleted()) {
    $promptResult = $promptAction->getResult(); // => Relay.Calling.PromptResult Object
  }
});

record

Start recording the call and waits until the recording ends or fails.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.RecordResult object.

Examples

Start recording audio in the call for both direction in stereo mode, if successful, grab url, duration and size from the RecordResult object.

<?php

$params = [
  'stereo' => true,
  'direction' => 'both'
];
$call->record($params)->done(function($recordResult) {
  if ($recordResult->isSuccessful()) {
    $url = $recordResult->getUrl();
    $duration = $recordResult->getDuration();
    $size = $recordResult->getSize();
  }
});

recordAsync

Asynchronous version of record. It does not wait the end of recording but returns a Relay.Calling.RecordAction you can interact with.

Available In:

Parameters

See record for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.RecordAction object.

Examples

Start recording audio in the call for both direction in stereo mode and then stop it using the RecordAction object.

<?php

$params = [
  'stereo' => true,
  'direction' => 'both'
];
$call->record($params)->done(function($recordAction) {
  // For demonstration purposes only ..
  $recordAction->stop();
});

sendDigits

This method sends DTMF digits to the other party on the call. Allowed digits are 1234567890*#ABCD and wW for short and long waits. If any invalid characters are present, the entire operation is rejected.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.SendDigitsResult object.

Examples

Send some digits.

<?php

$call->sendDigits('123')->done(function($result) {
  if ($result->isSuccessful()) {
    // ...
  }
});

sendDigitsAsync

Asynchronous version of sendDigits. It does not wait for the sending event to complete, and immediately returns a Relay.Calling.SendDigitsAction object you can interact with.

Available In:

Parameters

See sendDigits for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.SendDigitsAction.

Examples

Send some digits and then check if the operation is completed using the SendDigitsAction object.

<?php

$call->sendDigitsAsync('123')->done(function($action) {
  // ...
  // Later in the code for demonstration purposes only ..
  $completed = $action->isCompleted();
});

tap

Intercept call media and stream it to the specify endpoint. It waits until the end of the call.

Available In:

Parameters

• To tap through RTP:

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.TapResult object.

Examples

Tapping audio from the call, if successful, print both source and destination devices from the TapResult object.

<?php

$tap = [
  'audio_direction' => 'both',
  'target_type' => 'rtp',
  'target_addr' => '192.168.1.1',
  'target_port' => 1234
];
$call->tap($tap)->done(function($tapResult) {
  if ($tapResult->isSuccessful()) {
    print_r($tapResult->getSourceDevice());
    print_r($tapResult->getDestinationDevice());
  }
});

tapAsync

Asynchronous version of tap. It does not wait the end of tapping but returns a Relay.Calling.TapAction you can interact with.

Available In:

Parameters

See tap for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.TapAction object.

Examples

Tapping audio from the call and then stop it using the TapAction object.

<?php

$tap = [
  'audio_direction' => 'both',
  'target_type' => 'rtp',
  'target_addr' => '192.168.1.1',
  'target_port' => 1234
];
$call->tapAsync($tap, $device)->done(function($tapAction) {
  // ... later in the code to stop tapping..
  $tapAction->stop();
});

waitFor

Wait for specific events on the Call or returns false if the Call ends without getting them.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with true or false.

Examples

Wait for ending or ended events.

<?php

$call->waitFor('ending', 'ended')->done(function($success) {
  if ($success) {
    // ...
  }
});

waitForAnswered

This is a helper function that refines the use of waitFor. This simplifies waiting for the answered state.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with true or false.

Examples

Wait for the answered event.

<?php

$call->waitForAnswered()->done(function($success) {
  if ($success) {
    // ...
  }
});

waitForEnded

This is a helper function that refines the use of waitFor. This simplifies waiting for the ended state.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with true or false.

Examples

Wait for the ended event.

<?php

$call->waitForEnded()->done(function($success) {
  if ($success) {
    // ...
  }
});

waitForEnding

This is a helper function that refines the use of waitFor. This simplifies waiting for the ending state.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with true or false.

Examples

Wait for the ending event.

<?php

$call->waitForEnding()->done(function($success) {
  if ($success) {
    // ...
  }
});

waitForRinging

This is a helper function that refines the use of waitFor. This simplifies waiting for the ringing state.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with true or false.

Examples

Wait for ending or ended events.

<?php

$call->waitForRinging()->done(function($success) {
  if ($success) {
    // ...
  }
});

Events

All these events can be used to track the calls lifecycle and instruct SignalWire on what to do for each different state.

State Events

To track the state of a call.

Connect Events

To track the connect state of a call.

Play Events

To track a playback state.

Record Events

To track a recording state.

Prompt Events

To track a prompt state.

Fax Events

To track a fax state.

Detect Events

To track a detector state.

Tap Events

To track a tapping state.

Digits Events

To track a send digits action state.

Ringtones

Here you can find all the accepted values for the ringtone to play, based on short country codes:

Relay.Calling.ConnectAction

This object returned from connectAsync method that represents a connecting attempt that is currently active on a call.

Methods

getResult

Returns the final result of the connect attempt.

Available In:

Parameters

None

Returns

Relay.Calling.ConnectResult - Final result of the connect attempt.

Examples

Trying to connect two numbers in series and grab the result when it's completed.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connectAsync(...$devices)->done(function($action) {
  // .. later in the code since it's an async method
  if ($action->isCompleted()) {
    $result = $action->getResult();
  }
});

getState

Return the current state of the connect attempt.

Available In:

Parameters

None

Returns

string - Current state of the connect attempt.

Examples

Trying to connect two numbers in series and print the state.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connectAsync(...$devices)->done(function($action) {
  echo $action->getState();
});

getPayload

Return the payload sent to Relay to initiate the request. Useful to inspect what you sent to perform this action.

Available In:

Parameters

None

Returns

Object - Payload sent to Relay.

Examples

Trying to connect two numbers in series and print out the payload.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connectAsync(...$devices)->done(function($action) {
  print_r($action->getPayload());
});

isCompleted

Return true if the connect attempt has finished, false otherwise.

Available In:

Parameters

None

Returns

Boolean - True/False accordingly to the state.

Examples

Trying to connect two numbers in series and check if it has finished.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connectAsync(...$devices)->done(function($action) {
  if ($action->isCompleted()) {

  }
});

Relay.Calling.ConnectResult

This object returned from the connect method that represents the final result of a connection between your call and a remote one.

Methods

getCall

Return the Call object connected with yours, if the connection succeeded.

Available In:

Parameters

None

Returns

Relay.Calling.Call - The remote Call.

Examples

Trying to connect two devices and then use the remote Call.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connect(...$devices)->done(function($result) {
  if ($result->isSuccessful()) {
    $remoteCall = $result->getCall();
    // Use $remoteCall as a normal Relay.Calling.Call object...
  }
});

getEvent

Returns the last Relay Event arrived for this operation.

Available In:

Parameters

None

Returns

Relay.Event - Last Relay Event.

Examples

Trying to connect two devices and then grab the Relay event to inspect the payload.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connect(...$devices)->done(function($result) {
  $event = $result->getEvent();
  // Inspect $event->payload ..
});

isSuccessful

Return true if the call has connected with a remote party, false otherwise.

Available In:

Parameters

None

Returns

boolean - Whether the call has been connected successfully.

Examples

Trying to connect two devices and then check if your call has been connected.

<?php

$devices = [
  [ "type" => "phone", "to" => "+18991114444", "timeout" => 30 ],
  [ "type" => "phone", "to" => "+18991114445", "timeout" => 20 ]
];
$call->connect(...$devices)->done(function($result) {
  if ($result->isSuccessful()) {
    // Your call has been connected..
  }
});

Relay.Calling.DetectAction

This object returned from one of asynchronous detect methods that represents a running detector on the call.

Methods

getControlId

Return the UUID to identify the action.

Available In:

Parameters

None

Returns

string - UUID to identify the action.

Examples

Start a detector and print the controlId.

<?php

$call->detectMachineAsync()->done(function ($action) {
  echo $action->getControlId();
});

getPayload

Return the payload sent to Relay to initiate the request. Useful to inspect what you sent to perform this action.

Available In:

Parameters

None

Returns

Object - Payload sent to Relay.

Examples

Start a detector and print out the payload.

<?php

$call->detectDigitAsync()->done(function($detectResult) {
  print_r($action->getPayload());
});

getResult

Returns the final detector result.

Available In:

Parameters

None

Returns

Relay.Calling.DetectResult - Final detector result.

Examples

Trying detecting DTMF and grab the result when it's completed.

<?php

$call->detectDigitAsync()->done(function($action) {
  // .. later in the code since it's an async method
  if ($action->isCompleted()) {
    $detectResult = $action->getResult();
  }
});

isCompleted

Return true if detector has finished, false otherwise.

Available In:

Parameters

None

Returns

Boolean - True/False accordingly to the state.

Examples

Trying detecting DTMF and check if it has finished.

<?php

$call->detectDigitAsync()->done(function($action) {
  // .. later in the code since it's an async method
  if ($action->isCompleted()) {

  }
});

stop

Stop the action immediately.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Trying detecting a machine and then stop the action.

<?php

$call->detectMachineAsync()->done(function ($action) {
  // For demonstration purposes only..
  $action->stop()->done(function($stopResult) {

  });
});

Relay.Calling.DetectResult

This object returned from one of synchronous detect methods that represents the final result of a detector.

Methods

getEvent

Returns the last Relay Event arrived for this operation.

Available In:

Parameters

None

Returns

Relay.Event - Last Relay Event.

Examples

Detect digits and grab the result when it's completed.

<?php

$call->detectDigit()->done(function($result) {
  $event = $result->getEvent();
  // Inspect $event->payload ..
});

getResult

Returns the result of the detector. It could be the digits or the type (machine or human) detected.

Available In:

Parameters

None

Returns

string - Detector result.

Examples

Detect DTMF and print out the result.

<?php

$call->detectDigit()->done(function($result) {
  if ($result->isSuccessful()) {
    echo "DTMF detected: " . $result->getResult();
  }
});

getType

Returns the type of detector.

Available In:

Parameters

None

Returns

string - Detector type: digit, machine or fax.

Examples

Check the type of a detector.

<?php

$call->detectFax()->done(function($result) {
  if ($result->isSuccessful()) {
    echo "Detector type: " . $result->getType();
  }
});

isSuccessful

Return true if detector succeeded, false otherwise.

Available In:

Parameters

None

Returns

Boolean - True/False accordingly to the state.

Examples

Start detecting a fax, then check if a fax has been detected.

<?php

$call->detectFax()->done(function($result) {
  if ($result->isSuccessful()) {
    // Fax has been detected!
  }
});

Relay.Calling.DialResult

This object returned from Calling dial and Call dial methods.

Methods

getCall

Return the active Call object, right after the remote peer picked it up.

Available In:

Parameters

None

Returns

Relay.Calling.Call - The remote Call.

Examples

Trying to call a remote peer and, if it answer, get the active Call.

<?php

$params = [ 'type' => 'phone', 'from' => '+1XXXXXXXXXX', 'to' => '+1YYYYYYYYYY' ];
$client->calling->dial($params)->done(function($result) {
  if ($result->isSuccessful()) {
    $call = $result->getCall();
    // Your active $call..
  }
});

getEvent

Returns the last Relay Event arrived for this operation.

Available In:

Parameters

None

Returns

Relay.Event - Last Relay Event.

Examples

Start an outbound Call and then grab the Relay event to inspect the payload.

<?php

$call->dial()->done(function($result) {
  $event = $result->getEvent();
  // Inspect $event->payload ..
});

isSuccessful

Return true if the call was picked up by the remote party, false otherwise.

Available In:

Parameters

None

Returns

boolean - Whether the call has been answered.

Examples

Start an outbound Call and then check if the dial has completed successfully.

<?php

$call->dial()->done(function($result) {
  if ($result->isSuccessful()) {
    // Your call has been answered by the remote party..
  }
});

Relay.Calling.FaxAction

This object returned from faxReceiveAsync and faxSendAsync methods represents a receiving or sending Fax on the call.

Methods

getControlId

Return the UUID to identify the fax action.

Available In:

Parameters

None

Returns

string - UUID to identify the action.

Examples

Start faxing and print the controlId.

<?php

$call->faxSendAsync('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf')->done(function ($action) {
  echo $action->getControlId();
});

getPayload

Return the payload sent to Relay to initiate the request. Useful to inspect what you sent to perform this action.

Available In:

Parameters

None

Returns

Object - Payload sent to Relay.

Examples

Start sending a fax and print out the payload.

<?php

$call->faxSendAsync('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', '+1888222111', 'Custom Header')->done(function ($action) {
  print_r($action->getPayload());
});

getResult

Returns the final result of the faxing.

Available In:

Parameters