Place an outbound call
create_outbound_callCreate a policy-gated outbound call request. purpose is required and free-form (see the purpose property description for the advisory catalog); recipient_type is optional and recorded, never enforced; destination country is authorized against the org's workspace capabilities.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| policy | No | ||
| 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. | |
| agent_id | No | ||
| categories | No | ||
| project_id | Yes | ||
| campaign_id | No | ||
| relationship | No | ||
| from_number_id | Yes | ||
| 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. | |
| runtime_config | No | ||
| user_requested | No | ||
| organization_id | No | Optional. Defaults to the authenticated workspace; when supplied it must be that workspace's id. | |
| agent_endpoint_id | No | ||
| user_authorization | Yes |