POST
Call a lead now

Authorizations

Authorization
string
header
required

API token from the Voho console. Begins with voho_sk_live_.

Path Parameters

id
string
required

The agent's ID, from /v1/agents.

Body

application/json
to
string
required

The lead's phone number, in international format.

Example:

"+966512345678"

name
string

The lead's name. Also available to the agent as {{name}}.

Example:

"سارة"

variables
object

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.

Example:
from
string

Call from this number instead of the agent's own. Must be a Twilio number on your account.

Example:

"+966112345678"

Response

The lead was accepted.

status
enum<string>

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.

Available options:
calling,
queued,
skipped
lead_id
string
batch_id
string

The agent's Instant leads campaign.

reason
string

Why the lead was queued or skipped.

seconds_to_call
number

From receiving the request to placing the call, when status is calling.