Alarm the paired phone
alarmSound a loud alarm on the phones paired to this roost. Pass hatchId and a short message — the phone shows that message and repeats the alarm until the person acknowledges it. Recipients are only phones paired to this roost or its workspace. There is no phone-number argument. Do not pass one, and do not try to reach any other device.
Android plays alarm audio. The alarm channel bypasses Do Not Disturb after the person grants that access. iOS requests Critical Alerts and this push is sent with a critical sound at full volume. Apple has not granted the Critical Alerts entitlement (com.apple.developer.usernotifications.critical-alerts) yet, so iOS does not bypass the Ring/Silent switch until that grant. Do not tell the user the silent switch was bypassed.
A claimed roost requires a paired agent session. If no phone is paired, or the phone has not allowed notifications, the call fails and nothing is sent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hatchId | No | Hatch id from the original hatch response. | |
| message | Yes | Short text shown on the alarm. The phone repeats until the person acknowledges it. | |
| tenantId | No | Legacy alias for `hatchId`. | |
| sessionToken | No | Optional paired session token from poll_pairing (when Authorization headers are unavailable). |