Place call
place_callPlaces one human phone call to a US or Canada number to ask up to 20 questions, gather answers, and return results for scheduling, information, or account tasks.
Instructions
Place one human phone call. The hold is the full call: the tier minimum for the first minute, then the per-minute rate for each additional minute. Default max_minutes is 5, so a tier 1 US or Canada call holds $6.50. Raise max_minutes on that call to hold more. record_call must be false or omitted. Only US and CA are live. A question is {"id","ask","type"?}: id up to 80 characters, ask up to 1000 characters, at most 20 questions. goal is at most 4000 characters. Idempotency key is required. Poll get_call, or pass callback_url. validate_call checks the body and places no hold.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | Yes | ||
| phone | Yes | US or Canada number. 801-414-4664, (801) 414-4664, and +1 801 414 4664 are accepted and stored as E.164. | |
| script | No | ||
| purpose | Yes | ||
| deadline | Yes | ISO-8601. Needs 60 minutes of weekday 09:00–17:00 recipient-local, unless allow_outside_business_hours is true. | |
| language | No | en, fil, tl, war, or ceb. Default en. | |
| extension | No | Optional digits. Passed into the VA instructions. Not billed. | |
| questions | Yes | One to 20 questions. Each item is {id, ask, type?}. | |
| max_minutes | No | Default 5. Maximum 60. The hold covers this many minutes. | |
| record_call | No | False or omit. True is rejected: recording is not available. | |
| script_mode | No | ||
| time_window | No | Optional 24-hour HH:MM-HH:MM in the recipient time zone. Example: 09:00-17:00. End must be after start. | |
| callback_url | No | ||
| instructions | No | Outranks script wording. The extension is appended for the VA. | |
| max_attempts | No | Default 3. Maximum 5. | |
| on_behalf_of | Yes | ||
| business_name | Yes | ||
| idempotencyKey | Yes | Same value as the REST Idempotency-Key header. | |
| retry_preference | No | ||
| shareable_contact | No | ||
| recipient_timezone | No | IANA zone. Omit it and TaskBullet infers a US or Canada area code. An uninferable number needs this field. | |
| allowed_disclosures | No | ||
| consent_attestation | Yes | Must be true. | |
| allow_outside_business_hours | No | Set true only after the customer confirms the call may happen outside weekday 09:00–17:00 in the recipient time zone. The deadline then needs 60 minutes of clock time. Omit or false keeps the weekday business-hour rule. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||