Task

Access the Task API. You can instantiate a Task.Client to receive tasks from a different application. Please check Task Events for the full list of events that a Task.Client can subscribe to.

Example

The following example listens for incoming tasks.

1
import { Task } from "@signalwire/realtime-api";
2
3
const client = new Task.Client({
4
  project: "<project-id>",
5
  token: "<api-token>",
6
  topics: ["office"],
7
});
8
9
client.on("task.received", (payload) => {
10
  console.log("Task Received", payload);
11
  // Do something with the payload...
12
});

From a different process, even on a different machine, you can then send tasks:

1
import { Task } from "@signalwire/realtime-api";
2
3
await Task.send({
4
  project: "<project-id>",
5
  token: "<api-token>",
6
  topic: "office",
7
  message: { hello: ["world", true] }
8
});

Classes

Functions

send

• Const send(params): Promise<void>

Send a job to your Task Client in a specific topic.

Parameters

Returns

Promise<void>

Example

Sending a task with a message to then make an outbound Call. Please note that the call is not performed automatically: your Task.Client gives you back your payload, which you should interpret by your own custom logic.

1
const message = {
2
  'action': 'call',
3
  'from': '+18881112222',
4
  'to': '+18881113333'
5
}
6
7
await Task.send({
8
  project: "<project-id>",
9
  token: "<api-token>",
10
  topic: 'office',
11
  message: message
12
})