Core

Relay.Consumer

View as Markdown

A RELAY Consumer is a simple PHP class that runs in its own process along side your application to handle calling and messaging events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic 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.

Creating Consumers

A RELAY Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events.

A consumer has 2 required properties: project, token, and usually requires at least one contexts for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function onIncomingCall($call): Coroutine {
13    yield $call->answer();
14    yield $call->playTTS(['text' => 'Welcome to SignalWire!']);
15  }
16}
17
18$consumer = new CustomConsumer();
19$consumer->run();

Coroutine & yield keywords

In the Consumer examples you can see the special keyword yield and the return type Coroutine on the onIncomingCall method. These keywords help you write asynchronous code that “seems” synchronous, avoiding the need to nest your code in multiple callbacks.

Since the Relay PHP SDK is built on top of ReactPHP, a lot of methods return Promises that will be resolved with the result of the asynchronous operations. By flattening out the nested callbacks, you can just yield the Promises to wait for its value.

If you are familiar with Javascript, yield is similar to the async/await syntax in JS.

1<?php
2  public function onIncomingCall($call): Coroutine {
3    // Using yield
4    $answerResult = yield $call->answer();
5  }
Important

Within functions with return type Coroutine you must force PHP to parse the function as a Generator so, if you don’t need any yield in your code, just set the first line as:

1<?php
2  public function onIncomingCall($call): Coroutine {
3    yield;
4    // ...
5  }

Initializing Consumers

You can optionally add an setup method if you need to do any initialization work before processing messages. This is useful to do any one-off work that you wouldn’t want to do for each and every event, such as setting up logging or connecting to a datastore.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function setup() {
13    // Initialize anything you'd like available for all events.
14    // Like logging, database connections, etc.
15  }
16
17  public function onIncomingCall($call): Coroutine {
18    yield $call->answer();
19    yield $call->playTTS(['text' => 'Welcome to SignalWire!']);
20  }
21}
22
23$consumer = new CustomConsumer();
24$consumer->run();

Properties

PropertyTypeDescription
clientRelay.ClientThe underlying Relay client object.

Event Handlers

Event handlers are where you will write most of your code. They are executed when your consumer receives a matching event for the contexts specified by your Consumer.

ready

Executed once your Consumer is connected to RELAY and the session has been established.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function ready(): Coroutine {
13    $params = [ 'type' => 'phone', 'from' => '+1XXXXXXXXXX', 'to' => '+1YYYYYYYYYY' ];
14    $dialResult = yield $this->client->calling->dial($params);
15    if ($dialResult->isSuccessful()) {
16      // Your active $call..
17      $call = $dialResult->getCall();
18    }
19  }
20}
21
22$consumer = new CustomConsumer();
23$consumer->run();

onIncomingCall

Executed when you receive an inbound call, passes in the inbound Call object.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function onIncomingCall($call): Coroutine {
13    yield $call->answer();
14    yield $call->playTTS(['text' => 'Welcome to SignalWire!']);
15  }
16}
17
18$consumer = new CustomConsumer();
19$consumer->run();

onTask

Executed with your message sent through a Relay.Task.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function onTask($message): Coroutine {
13    yield;
14    print_r($message);
15    // ..Use your own $message sent in the context "default" from a Relay.Task
16  }
17}
18
19$consumer = new CustomConsumer();
20$consumer->run();

onIncomingMessage

Executed when you receive an inbound SMS or MMS, passes in the inbound Message object.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function onIncomingMessage($message): Coroutine {
13    yield;
14    // Handle the inbound message here..
15  }
16}
17
18$consumer = new CustomConsumer();
19$consumer->run();

onMessageStateChange

Executed when a message state changes, passes in the inbound Message object.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6use SignalWire\Log;
7
8class CustomConsumer extends SignalWire\Relay\Consumer {
9  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
10  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
11  public $contexts = ['default'];
12
13  public function ready(): Coroutine {
14    $params = [
15      'context' => 'default',
16      'from' => '+1xxx',
17      'to' => '+1yyy',
18      'body' => 'Welcome at SignalWire!'
19    ];
20    $result = yield $this->client->messaging->send($params);
21    if ($result->isSuccessful()) {
22      Log::info('SMS queued successfully!');
23    }
24  }
25
26  public function onMessageStateChange($message): Coroutine {
27    yield;
28    // Keep track of your SMS state changes..
29    Log::info("Message {$message->id} state: {$message->state}.");
30  }
31}
32
33$consumer = new CustomConsumer();
34$consumer->run();

Cleaning Up on Exit

When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service.

Just implement a teardown method in your consumer and it will be called during the shutdown procedure.

1<?php
2
3require dirname(__FILE__) . '/vendor/autoload.php';
4
5use Generator as Coroutine;
6
7class CustomConsumer extends SignalWire\Relay\Consumer {
8  public $project = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX';
9  public $token = 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
10  public $contexts = ['default'];
11
12  public function onIncomingCall($call): Coroutine {
13    yield $call->answer();
14    yield $call->playTTS(['text' => 'Welcome to SignalWire!']);
15  }
16
17  public function teardown(): Coroutine {
18    // Clean up any resources when exiting.
19  }
20}
21
22$consumer = new CustomConsumer();
23$consumer->run();

Running Consumers

Running a consumer is just like running any other PHP script, simply execute the script as a separate process and ensure you invoke the ->run(); method at the end of your script. The process will stay up until you shut it down.

Shutting Down Consumers

In order to gracefully shut down a RELAY consumer process, send it the SIGTERM signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier.