connection_info
Connection Info
Verify the current connection: owner.id is the human public User ID, handle identifies the robot, and home_room is its delivery room. After login or reconnect, match owner.id and handle to the approved account and robot before sending. A mismatch means stop and reload or restart the MCP client. Includes a credential-protected latest-pings feed and token-free install URL; never send credentials to the install URL.
无需输入参数。
Revoke this authenticated robot connection, including its access and refresh credentials and room memberships. Use only when the human explicitly requests logout, disconnection, or reconnection. Call BEFORE clearing local credentials or running MCP logout/login. It affects only the current connection and accepts no account or robot selector. After login, restart or reload the MCP client, then match connection_info owner.id and handle to the approved account and robot before sending.
无需输入参数。
List the rooms the authenticated account belongs to.
无需输入参数。
list_quick_actions
List Quick Actions
List the quick actions configured for a room.
输入参数invite_code必填
trigger_quick_action
Trigger Quick Action
Press a room quick action, notifying its members. Rate-limited. Read the action's input_type first (list_quick_actions): location needs data.location, link needs data.url, file/photo/pdf need attachment_ids — a press without the matching detail is a 422 quick_action_input_required. In someone else's personal room is_urgent and requires_ack are ignored; only the owner's own setting on the action applies.
输入参数dataack_modeis_urgentinvite_code必填requires_ackaction_number必填attachment_idstrigger_sourcequick_action_id
Send a custom ping to a room the account belongs to. Pass data.checklist.items to send a checklist the room ticks through together; read the ticks back as checklist_state. Rate-limited. In someone else's personal room only a Pro account may send it, text only (a link in the message is refused too), without title, is_urgent or requires_ack (all three are ignored there), and it counts toward the visitor's two-ping cap; otherwise use trigger_quick_action there.
输入参数datatitlemessage必填ack_modereply_tois_urgentaction_iconinvite_code必填requires_ackaction_numberattachment_idscorrelation_id另有 1 个
live_status
Publish Live Status
Start, 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.
输入参数datatitleactioninvite_code必填live_status必填requires_ackcorrelation_id必填ack_timeout_seconds
get_live_status
Get Live Status
Read back the current state of a live stream you created, so a restarted producer can reconcile instead of starting a duplicate. Only returns streams started by this credential, within the last 24 hours. Returns notification_id and correlation_id, then the stored display state (state, progress, message, category, template, accent_override, eta_at, deadline_at, duration_seconds, metrics, prompt, options, left, right, center, steps, current_step), action_state, and updated_at. Fields you never set come back as null rather than being omitted, so a matchup/metrics/countdown/question stream can be resumed without re-sending content.
输入参数invite_code必填correlation_id必填
list_room_icons
List Room Icons
List the room-icon catalog (icon ids, tags, and categories). Call this before create_room / create_public_room / create_webhook to pick a valid icon id, and to interpret icon values returned by reads.
无需输入参数。
list_notifications
List Notifications
List a bounded page of recent pings across approved rooms, newest first. Use page to continue while has_more is true.
输入参数datepagetypelimit
get_notification
Get Notification
Fetch one visible ping by notification id, including its current action_state and, once anything on its data.checklist is checked, checklist_state.
输入参数notification_id必填
wait_for_notification
Wait for Notification
Long-poll for the next ping. Blocks until one arrives or the timeout elapses — the real-time inbound channel for an agent. The agent's own sends are excluded.
输入参数aftertimeout
wait_for_ack
Wait for Acknowledgement
Long-poll a generic acknowledgement-required ping until its confirmation rule is met (any: first confirmation; all: every original eligible recipient), it expires, or the timeout elapses. Questions use wait_for_answer instead.
输入参数timeoutnotification_id必填
request_approval
Request Approval
Ask the human to approve or reject an action, then block on their answer (pair with wait_for_approval). Delivered as a push to the connected human only, so like a direct ask_question to them it needs no trigger permission in the room; public and personal rooms are refused. Rate-limited.
输入参数ttldatatitleoptionsquestion必填invite_code必填correlation_ididempotency_key
wait_for_approval
Wait for Approval
Long-poll an approval request until the human decides or it expires. Returns the status and, once decided, the chosen option.
输入参数timeoutapproval_id必填
Fetch the current status of an approval request without blocking.
输入参数approval_id必填
Ask a person a question with 2-4 tappable options, then block on their answer (pair with wait_for_answer). Delivered as a push they can answer from the lock screen or in-app; the first valid answer wins. Rate-limited.
输入参数ttldataprompt必填contextoptionsreply_totext_inputinvite_code必填attachment_idscorrelation_ididempotency_key
wait_for_answer
Wait for Answer
Long-poll a question until it is answered or expires. Returns the state and, once answered, the chosen option value + label and the responder.
输入参数timeoutquestion_id必填
Fetch the current state of a question without blocking.
输入参数question_id必填
list_questions
List Questions
List a bounded page of questions you asked, newest first. Optionally filter by state; use page while has_more is true.
输入参数pagelimitstate
cancel_question
Cancel Question
Withdraw a still-pending question you asked.
输入参数question_id必填
activate_agent_inbox
Activate Agent Inbox
Start or resume the onboarding Question in the private room the human chose during authorization. If recipient_not_ready, ask the human to install or update PingRoom from install_url, open the app, sign in, and enable notifications before retrying. Read question.id, then call wait_for_handoff only while state is pending and within a bounded local deadline. Success is answered with activation_completed true. Any other terminal result is incomplete: stop polling that attempt, then call activate_agent_inbox again for one numbered retry. The stamp requires native phone receipt before the human answer.
无需输入参数。
create_handoff
Create Handoff
Hand work to exactly one human as either an acknowledgement or a tappable question. The server verifies that one of the recipient's current devices supports the complete Handoff action before creating anything.
输入参数datakind必填prompt必填optionsurgencyaudience必填reply_toexpires_incorrelation_ididempotency_key
wait_for_handoff
Wait for Handoff
Long-poll a Handoff until the human resolves it, it expires, or the bounded timeout elapses. For the onboarding Question returned by activate_agent_inbox, success requires an answered result with activation_completed true; use a bounded local deadline and treat any terminal answer without that stamp as incomplete.
输入参数timeouthandoff_id必填
Fetch the authoritative current state of one Handoff without blocking.
输入参数handoff_id必填
list_handoffs
List Handoffs
List a bounded page of this agent's Handoffs, newest first. Omit state (or use open) for unresolved work; use all for history and page while has_more is true.
输入参数pagelimitstate
upload_attachment
Upload Attachment
Upload a small file (max ~90 KiB over MCP; Pro account required) and get an attachment id to include in broadcast or ask_question via attachment_ids. Larger files: use the PingRoom CLI or agent REST API.
输入参数filename必填mime_typecontent_base64必填
get_attachment
Get Attachment
Fetch an attachment visible to this agent as base64 content plus metadata. Results over the connector size limit return attachment_too_large — fetch those via the agent REST API instead.
输入参数attachment_id必填
delete_attachment
Delete Attachment
Delete an attachment this agent uploaded that is not yet claimed by a ping.
输入参数attachment_id必填
Fetch a single room by its invite code, including members and quick actions.
输入参数invite_code必填
Create a new private room owned by the authenticated account. Free accounts may own up to five rooms. If this agent was granted every room and has no delivery room yet, the new room becomes its delivery room — where its handoffs and direct questions land.
输入参数icon必填name必填color必填
create_public_room
Create Public Room
Create a publicly discoverable room with a unique @handle. Counts toward the free-plan five-room cap.
输入参数icon必填name必填color必填handle必填categoryshow_ownerdescriptionlocation_namelocation_latitudelocation_longitude
Join a room using its invite code. Include the password only if the room is protected.
输入参数passwordinvite_code必填
list_webhooks
List Webhooks
List the incoming webhooks (with their trigger URLs) for a room the account owns.
输入参数invite_code必填
create_webhook
Create Webhook
Create an incoming webhook for a room the account owns. The bound account must be Pro. Returns the secret trigger URL — treat it as a credential.
输入参数iconname必填colorsoundtitleenabledmessageinvite_code必填action_numbercooldown_seconds
update_webhook
Update Webhook
Update an incoming webhook (by id) on a room the account owns — e.g. change its icon, title, message, or sound.
输入参数iconnamecolorsoundtitleenabledmessagewebhook_id必填invite_code必填action_numbercooldown_secondsregenerate_secret
delete_webhook
Delete Webhook
Delete an incoming webhook (by id) from a room the account owns.
输入参数webhook_id必填invite_code必填
update_quick_action
Update Quick Action
Configure a numbered quick-action slot for a room the account owns. Sends a background room refresh to room members' devices.
输入参数icon必填label必填soundinput_typeinvite_code必填requires_ackaction_number必填
update_quick_actions
Update Quick Actions
Configure several of a room's quick-action slots in one call. Prefer this over repeated update_quick_action: each single-slot write wakes room members' devices with its own background refresh, so setting up four Pings one at a time spends four of a finite daily push budget on one operation. Slots you do not list are left exactly as they are, so this is also the right tool for editing a single Ping.
输入参数actions必填invite_code必填
set_avatar
Set Agent Avatar
Set this agent's avatar. Must be one of the PingRoom bot avatars.
输入参数avatar_id必填
rotate_handle
Rotate Agent Handle
Rotate this agent's public handle — kill-switch for a leaked handle.
无需输入参数。