SMS Deliverability Check
vri_sms_deliverabilityLine-type-based SMS capability and reputation signals for a North American number. Not an actual delivery test or guarantee. Unknown reputation never clears a number to message. Returns sms_capable (live line-type read), VoIP flag, spam reputation, the recipient's approximate local time with an 8am-9pm calling-window flag, and plain-language reasons. Deliverability and reputation signals only — not a legal compliance determination (no DNC/reassigned-number/litigator data). Performs its own LRN and spam lookup; avoid calling after number_lookup for the same data. Live customer keys spend balance. Repeating a call can charge again; reuse a stable request_id with identical arguments for a safe retry. Use max_cost to cap the quote. Use a test key for integration tests.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_cost | No | Maximum quoted cost in USD; rejected before lookup if exceeded. | |
| request_id | No | Stable unique ID for this operation. Reuse with identical arguments to retrieve its receipt without another charge. | |
| phone_number | Yes | US/Canada number, any common format |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| voip | No | ||
| reasons | No | Plain-language reasons this number is or is not a good send. Empty means nothing is wrong. When reputation is against the number these also carry the evidence behind it (complaint counts and recency, complaint category, community reports, recent porting) and a closing "reputation confidence: low|medium|high" line. | |
| line_type | No | ||
| sms_capable | No | Inferred from line type; null when unknown. Not a delivery guarantee. | |
| spam_flagged | No | ||
| recipient_local | No | Approximate timezone, local_time, quiet_hours_ok | |
| ok_to_message_now | No | sms_capable AND clean AND inside the calling window |