Raw schema
{
"type": "object",
"properties": {
"query": {
"description": "Kind of business, e.g. \"auto repair\", \"pharmacy\", \"hair salon\", \"public library\"",
"type": "string"
},
"phones": {
"description": "Call these exact businesses instead of searching (query and near not needed): the user's own list (vendors, quote requests, a spreadsheet of leads), or a call place_call refused for the hour (the batch dials at 7am their time).",
"type": "array",
"items": {
"type": "object",
"properties": {
"phone": {
"type": "string"
},
"business_name": {
"type": "string"
}
},
"required": [
"phone"
]
}
},
"queries": {
"description": "Several phrasings to widen the search (max 5), e.g. [\"tire shop\", \"brake repair\"]",
"type": "array",
"items": {
"type": "string"
}
},
"near": {
"description": "City and state or province, neighborhood, or a zip or postal code",
"type": "string"
},
"nears": {
"description": "Several areas (max 10), e.g. [\"Plano, TX\", \"Frisco, TX\"]",
"type": "array",
"items": {
"type": "string"
}
},
"count": {
"description": "How many places to call, 1-100, default 3",
"type": "number"
},
"concurrency": {
"description": "Calls at the same time, 1-10, default 5",
"type": "number"
},
"stop_after": {
"description": "Stop once this many calls succeed (e.g. 1 = first place that can do it)",
"type": "number"
},
"max_spend_usd": {
"description": "Stop dialing once the batch has cost this much",
"type": "number"
},
"include_closed": {
"description": "Also queue places that are closed now (they're called when they open, or reach voicemail)",
"type": "boolean"
},
"min_rating": {
"description": "Skip places rated below this (e.g. 4.0)",
"type": "number"
},
"exclude_phones": {
"description": "Numbers to leave out",
"type": "array",
"items": {
"type": "string"
}
},
"exclude_called": {
"description": "Skip places this account called in the last 14 days (default true)",
"type": "boolean"
},
"batch_id": {
"description": "Add more places to this existing batch (paging)",
"type": "string"
},
"dry_run": {
"description": "Only list who would be called and the estimated cost",
"type": "boolean"
},
"confirm": {
"description": "Required for more than 10 places, after the user saw the preview",
"type": "boolean"
},
"after_hours": {
"description": "As in place_call; applies to every call in the batch",
"type": "boolean"
},
"call_at": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"goal": {
"type": "string",
"description": "As in place_call; applies to every call in the batch"
},
"details": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"questions": {
"description": "As in place_call; applies to every call in the batch",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"on_behalf_of": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"callback_number": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"constraints": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"if_asked": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"voicemail_message": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"transfer_to": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"max_cost_usd": {
"description": "As in place_call; applies to every call in the batch",
"type": "number"
},
"language": {
"description": "As in place_call; applies to every call in the batch",
"type": "string"
},
"setup_code": {
"description": "From a needs_setup result, after the user finished the link",
"type": "string"
}
},
"required": [
"goal"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}