Skip to main content

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.

Creating Tasks​

A Task is a simple object with 2 required arguments: project and token. Project and Token are used to send the Task to your Consumers. Once created, the Task has only one method deliver to send jobs to your Consumer.

require 'signalwire/relay/task'

task = Signalwire::Relay::Task.new(project: "your-project-id", token: "your-project-token")
task.deliver(context: 'incoming', message: { number_to_call: '+1555XXXXXXX', message_to_play: 'We have a message for you' })

Methods​

deliver​

Send a job to your Consumer in a specific context.

Parameters

ParameterTypeRequiredDescription
contextStringYesContext where to send the Task.
messageHashYesObject with your custom data that will be sent to your Consumer's on_task handler.

Returns

Boolean - true if the request was successful, false if not.

Examples

Deliver a task to your Consumer with a message to then make an outbound Call.

message = {
  'action': 'call',
  'from': '+18881112222'
  'to': '+18881113333'
}

result = task.deliver(context: 'incoming', message: message)

puts "error delivering task" if result == false