Call a lead now
Hand every new lead to an agent, and it calls them within seconds.
Before the first lead
- Attach a Twilio number to the agent in the console. The call goes out from that number. To use a different one, pass it as
from. - Create an API token on the API Tokens page.
- Write the agent for an outbound call: it rang them, so it should say who it is, why it is calling, and ask whether now is a good time. The Real-estate sales template is written this way.
Sending a lead
variables are filled into the agent’s instructions and greeting, so an agent written with {{unit}} opens knowing what the lead asked about. name is available as {{name}}.
What happens to a lead
- Calling window. Leads are called between 09:00 and 20:00 Riyadh time. One that arrives at night is called when the window opens.
- No answer. Retried twice more, 15 minutes apart. A voicemail counts as no answer, and the agent hangs up on it rather than talking to the tone.
- Do not call. A number on your do-not-call list is never called.
- Double submissions. The same number sent again while a call to it is under way does not place a second call. Sent again later, it is a new lead and gets the full set of attempts.
- Pausing. Pause Instant leads on the Outbound page and new leads are refused with
409until you resume it.
Cost
A call is billed per connected minute at the live call rate, from the same balance as everything else. A call that is not answered costs nothing.Authorizations
API token from the Voho console. Begins with voho_sk_live_.
Path Parameters
The agent's ID, from /v1/agents.
Body
The lead's phone number, in international format.
"+966512345678"
The lead's name. Also available to the agent as {{name}}.
"سارة"
What the lead asked about, filled into the agent's instructions and greeting as {{unit}} and the like, so it opens knowing why it is calling. Up to 10 keys, letters, digits and underscores.
Call from this number instead of the agent's own. Must be a Twilio number on your account.
"+966112345678"
Response
The lead was accepted.
calling: the phone is ringing now. queued: it will be called at the next opportunity, see reason. skipped: it will not be called, see reason.
calling, queued, skipped The agent's Instant leads campaign.
Why the lead was queued or skipped.
From receiving the request to placing the call, when status is calling.

