contact_leads
Send real calls or SMS messages to a list of leads in one batch; confirm the audience first and use campaigns for scheduled, throttled outreach.
Instructions
Call or text a LIST of leads in one go (real calls / real SMS, billed). channel=call queues an outbound call to each lead; channel=sms sends each lead a message (message required unless sendMode=agent). leads are lead objects from leads_read (they must carry a phone, e.g. userPhone). Max 500 per call. Confirm the audience with the user first. For scheduled, throttled dialing use a campaign (campaigns_write).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | For channel=sms: specific sender number. | |
| mode | No | compact (default) = light mode: long text is cut and bulky blobs are replaced by a size marker. full = complete API response. | |
| leads | Yes | ||
| agentId | Yes | ||
| channel | Yes | ||
| message | No | For channel=sms. | |
| options | No | ||
| sendMode | No | For channel=sms. | |
| campaignId | No | ||
| contactMethodsPriority | No | Lead fields to read the phone from, in order. Default ["userPhone", "phone", "userID"]. |