Publish Live Status
live_statusStart, update, or end a live progress card on the room members' lock screen (an iOS Live Activity / Android live update). Reuse the same correlation_id for every ping of one stream: the first ping starts the card and sends one alert, further "running" pings move it silently, and the first "done"/"failed" sends one completion alert and ends it. Free accounts get a small number of NEW streams per day; updates and the final ping of an open stream are never charged; a first ping that is already "done"/"failed" counts as a new stream.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"invite_code": "<invite_code>",
"correlation_id": "<correlation_id>",
"live_status": "<live_status>"
},
"name": "live_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Arbitrary structured context (max 25 keys / 8KB), returned on read surfaces after connector privacy filtering. Do not put secrets in data. | |
| tags | No | Up to 10 labels to file this ping under, so history can later be filtered by one (list_notifications and wait_for_notification take a tag). Each is 1 to 32 characters: lowercase letters, digits, "-" and "_", starting with a letter or digit. Trimmed, lowercased and de-duplicated for you. Set by the ping that starts the stream; later pings of the same stream may repeat or omit them and never change them. | |
| title | No | Card title. Every template takes at most 40 characters and refuses a longer one; only the claim template takes up to 120 (its request text), which is why this schema allows 120. Defaults to the selected quick action's label. | |
| action | No | Quick-action slot to attribute the stream to (supplies the icon and sound). | |
| invite_code | Yes | Room invite code. | |
| live_status | Yes | The live card's state. Only state is required. | |
| requires_ack | No | Add an Acknowledge button; the first eligible member to tap resolves it for everyone. Does not raise the interruption level — set category "alert" for a time-sensitive start. | |
| correlation_id | Yes | The stream key. Reuse it on every ping of the same stream. | |
| ack_timeout_seconds | No | Optional acknowledgement deadline in seconds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Purpose-built PingRoom result with credential and account fields removed. |