voice-availability.check
read-only
Check live availability and nightly rate for a date range. Designed for the VAPI voice-agent tool-call surface — returns a spoken-friendly `spokenRate` string per option. Inventory is grouped by room type. Returns available:false if no inventory remains for the full stay window.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
checkIn | string | yes | First night of stay, YYYY-MM-DD. |
checkOut | string | yes | Departure date (exclusive), YYYY-MM-DD. |
guests | integer | yes | Headcount, 1-20. |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
available | boolean | yes | |
options | array of object | yes | |
options.roomTypeId | string | yes | Room type identifier (rooms.type text key). |
options.roomTypeName | string | yes | |
options.nightlyRateCents | integer | yes | |
options.spokenRate | string | yes | |
options.nights | integer | yes | |
options.totalCents | integer | yes |