Get phone number health
get_number_healthCheck spam flags, usage status, and call statistics (answer rate, failed calls, minutes) for a phone number to judge if a caller ID is flagged or over-used.
Instructions
Return usage and health of one phone number on this account (GET /numbers/{e164}/health): spam flag, usage status and call statistics (answer rate, failed calls, minutes) bucketed per day or per hour. Use it to judge whether a caller ID is being flagged or over-used; for the number's configuration and fees use get_phone_number_details. days sets the history window for daily granularity only and is ignored for hourly.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Days of history for daily granularity, 1-90 (default 30). Ignored when granularity is hourly. | |
| granularity | No | Bucket size for the statistics: daily (default) or hourly. | |
| phone_number | Yes | The number to inspect, E.164 (leading + optional); must be on this account. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success; false when the result is an error (then error, message and retryable are set). | |
| health | No | Vobiz's health report: spam flag, usage status and the per-day or per-hour statistics (calls, answered, failed, answer rate, minutes). |