VocalDocscontracts 1.65.0

CallCreateRequest

Starts a Call: a web Call for a browser or, from 1.16.0, an outbound phone Call that dials to. Idempotency-Key is required.

An object with 14 fields.

Fields

FieldTypeRequiredDescription
agent_idAgentIdyes
agent_versionintegernoA published version to pin; the active version of the Agent when omitted.
captureCaptureRequestnoAdded in 1.57.0 (ADR 0048 decision 5). {"mode": "verbose"} asks for verbose capture of this Call, refused with 403 capture_not_allowed when the pinned Compliance profile's verbose_capture forbids it; standard keeps a capture window of the Agent from applying. Absent, an open capture window decides.
contactContactMatchInputnoAdded in 1.61.0. The Contact by an identity or an external id, in place of contact_id; one Contact must hold it (contact_match_conflict when several do, not_found when none does).
contact_idContactIdnoAdded in 1.61.0. The Contact the Call is for, resolved asserted. A merged Contact resolves through its tombstone; a deleted one is 409 contact_not_active. With transport: phone and no to, the Call dials its primary phone identity.
directionCallDirectionnoAdded in 1.16.0. Absent means inbound. outbound is accepted only with transport: phone, requires to, and makes the platform dial it.
from_number_idPhoneNumberIdnoAdded in 1.16.0. The Phone number whose number is the caller ID of an outbound Call. From 1.22.0, when it is omitted the setting outbound.default_from as resolved for the Call names it, and when that is unset too, the Organization's earliest active Phone number with the outbound capability. A number of another Organization is not found (404 not_found), and nothing is dialled; a number of the Organization that is not active or lacks the outbound capability is refused with 403 dial_not_allowed, reason number_not_outbound_capable.
retryRetryPolicyInputnoAdded in 1.61.0. Retries the Call once after an ended reason it lists. An outbound phone Call only (schedule_not_outbound otherwise). The retry (call.retry) runs admission again, the pre-call hook among it (workspace ADR 0049, decision 1).
scheduleCallScheduleInputnoAdded in 1.61.0. Starts the Call later: it is created scheduled. An outbound phone Call only (schedule_not_outbound otherwise). From 1.64.0, decided: the start job (call.scheduled_start) runs admission in full at the start, the pre-call hook among it with the direction outbound, as for a Call admitted at once (workspace ADR 0049, decision 1).
settings_overridesAgentSettingsInputnoAdded in 1.18.0. The per-Call override, the Call layer of the settings block, which wins over the Agent version's values. Only the paths CALL_LAYER_PATHS lists may be set (the greeting's mode and wait_ms, speech.speaking_rate, listening.end_of_turn, listening.interruption, the silence timings and limits.max_duration_s); any other path is refused with 422 validation_failed and the issue setting_override_not_allowed. A path the platform or the Organization locks is refused with setting_locked, a value outside their bounds with setting_out_of_bounds, and limits.max_duration_s may only lower the value the layers above resolve to.
tostringnoAdded in 1.16.0. The number to dial, in E.164 form such as +14155552486; required when direction is outbound and refused otherwise, except that from 1.61.0 an outbound Call that names a Contact may omit it to dial the primary phone identity of the Contact (contact_phone_missing when it has none). It is write-only: no response, list, log or Audit event repeats it, and the Call detail carries only destination_hint.
transportCallTransportyes
variablesmap of VariableValuenoAdded in 1.17.0. The values of the Agent version's declared variables, by name: at most 50. A required variable without a value is refused with 422 validation_failed and the issue variable_missing, an undeclared name with variable_unknown, and a value of the wrong type or longer than its max_length with variable_type. Values are write-only: no response, log or Audit event repeats them.
voicemailVoicemailOverrideInputnoAdded in 1.61.0. The answering-machine behaviour of the Call and its retry. An outbound phone Call only (schedule_not_outbound otherwise).

Used by

The operations whose parameters, request body or responses name this shape directly.