Send an SMS
send_smsSend a policy-gated outbound SMS from one of the workspace's numbers, charged to the workspace balance. purpose is required and free-form (see the purpose property description for the advisory catalog); recipient_type is optional and recorded, never enforced. Returned body, metadata, error and idempotency_key require sms:read, including on replays.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| purpose | Yes | Required, free-form outbound purpose declaration -- never refused for being novel. Any non-empty token is accepted; the documented advisory catalog is: appointment, booking_confirmation, callback_requested, customer_outreach, delivery_notification, ops_alert, other, payment_reminder, personal_errand, reservation, status_check, support. | |
| categories | No | ||
| project_id | No | ||
| campaign_id | No | ||
| relationship | No | ||
| recipient_type | No | Optional, never enforced or required -- outbound is not restricted to business recipients. Persisted verbatim on the call row if sent; SMS has no recipient_type column, so it is accepted but not stored there. | |
| user_requested | No | ||
| organization_id | No | Optional. Defaults to the authenticated workspace; when supplied it must be that workspace's id. | |
| to_phone_number | Yes | ||
| user_authorization | No | ||
| from_phone_number_id | Yes |