API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Capability

Check whether a recipient address supports iMessage or RCS before sending a message.

Check iMessage capability

client.capability.checkiMessage(CapabilityCheckiMessageParams { address, from } body, RequestOptionsoptions?): HandleCheckResponse { address, available }

POST/v3/capability/check_imessage

Check RCS capability

client.capability.checkRCS(CapabilityCheckRCSParams { address, from } body, RequestOptionsoptions?): HandleCheckResponse { address, available }

POST/v3/capability/check_rcs

ModelsExpand Collapse

HandleCheck { address, from }

address: string

The recipient phone number or email address to check

from?: string

Optional sender phone number. If omitted, an available phone from your pool is used automatically.

HandleCheckResponse { address, available }

address: string

The recipient address that was checked

available: boolean

Whether the recipient supports the checked messaging service