Enable Heartbeat Streaming
stream::heartbeat::enable
Using this method, you can enable heartbeat events streaming to a specific client.
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| client_id | integer | – | 0 | In the case of a single client, this defaults to 0. This ID can be used to access data via http://localhost:7783/event-stream?id=1. |
| config | object | – | A standard StreamingConfig object. |
Response Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| streamer_id | string | – | An identifier for the data stream. This can be used later to disable streaming for the event with stream::disable. |
📌 Examples
POST Enable Heartbeat Events
stream::heartbeat::enable {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::heartbeat::enable",
"mmrpc": "2.0",
"params": {
"config": {
"stream_interval_seconds": 30
},
"client_id": 1
}
}curl --url "http://127.0.0.1:7783" --data '{
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::heartbeat::enable",
"mmrpc": "2.0",
"params": {
"config": {
"stream_interval_seconds": 30
},
"client_id": 1
}
}'import requests
import json
url = "http://127.0.0.1:7783"
payload = {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::heartbeat::enable",
"mmrpc": "2.0",
"params": {
"config": {
"stream_interval_seconds": 30
},
"client_id": 1
}
}
response = requests.post(url, json=payload)
print(json.dumps(response.json(), indent=2))const payload = {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::heartbeat::enable",
"mmrpc": "2.0",
"params": {
"config": {
"stream_interval_seconds": 30
},
"client_id": 1
}
};
const response = await fetch("http://127.0.0.1:7783", {
method: "POST",
body: JSON.stringify(payload),
});
console.log(await response.json());<?php
$payload = <<<'JSON'
{
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::heartbeat::enable",
"mmrpc": "2.0",
"params": {
"config": {
"stream_interval_seconds": 30
},
"client_id": 1
}
}
JSON;
$ch = curl_init("http://127.0.0.1:7783");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{"userpass":"RPC_UserP@SSW0RD","method":"stream::heartbeat::enable","mmrpc":"2.0","params":{"config":{"stream_interval_seconds":30},"client_id":1}}`)
resp, err := http.Post("http://127.0.0.1:7783", "application/json", bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
require 'uri'
uri = URI("http://127.0.0.1:7783")
payload = {
"userpass": "RPC_UserP@SSW0RD",
"method": "stream::heartbeat::enable",
"mmrpc": "2.0",
"params": {
"config": {
"stream_interval_seconds": 30
},
"client_id": 1
}
}
response = Net::HTTP.post(uri, payload.to_json, 'Content-Type' => 'application/json')
puts JSON.pretty_generate(JSON.parse(response.body))Show Enable Heartbeat Events Response
{
"mmrpc": "2.0",
"result": {
"streamer_id": "HEARTBEAT"
},
"id": null
}Here is an example of the stream data you should be able to see in http://localhost:7783/event-stream?id=1 at each heatbeat:
data: {"_type":"HEARTBEAT","message":{}}
Error Types
| Parameter | Type | Required | Description |
|---|---|---|---|
| UnknownClient | string | – | No client has an open connection using this client_id |
| ClientAlreadyListening | string | – | The requested events are already being sent to the client_id |
Show Error Responses
Error Response (Unknown Client)
{
"mmrpc": "2.0",
"error": "UnknownClient",
"error_path": "heartbeat",
"error_trace": "heartbeat:35]",
"error_type": "EnableError",
"error_data": "UnknownClient",
"id": null
}Error (Client Already Listening)
{
"mmrpc": "2.0",
"error": "ClientAlreadyListening",
"error_path": "heartbeat",
"error_trace": "heartbeat:35]",
"error_type": "EnableError",
"error_data": "ClientAlreadyListening",
"id": null
}