Allowed Functions

Deny by default

The Code Step validator rejects any function or method call that is not on the allow-list below. Validation runs before execution, so disallowed calls never run. This page covers the Code Step inside a call script. The Code step in an automation pipeline is a separate sandbox with its own list of functions — see Steps.

Built-in Functions

abs(value)      all(values)       any(values)   bool(value)
dict(value)     enumerate(values) float(value)  int(value)
len(value)      list(value)       max(values)   min(values)
print(*values)  range(stop)       round(value)  set(value)
sleep(seconds)  sorted(values)    str(value)    sum(values)
tuple(value)

print(...) writes a user-facing system note for Code Step diagnostics. It supports multiple values plus sep and end; multi-line output is split into separate system notes. range accepts range(stop), range(start, stop), and range(start, stop, step). sleep(seconds) pauses the Code Step for that many seconds before it carries on. The call waits with it, so keep pauses short (a second or two), for example to give an SMS reply time to arrive before reading it.

Allowed Methods

value.append(item)     value.endswith("x")  value.get("key")
value.join(items)      value.lower()        value.lstrip()
value.replace("a","b") value.rstrip()       value.split(",")
value.startswith("x")  value.strip()        value.upper()

Most allowed methods are string methods. get is allow-listed for dictionary-style values, and append is allow-listed for list-building.

Flow Helpers

coalesce(value, default)
is_empty(value)
is_not_empty(value)
map_value(key, mapping, default)

coalesce(value, default) — returns default when value is None or ""
is_empty(value) — true for None, "", [], or {}
is_not_empty(value) — the inverse of is_empty
map_value(key, mapping, default) — lowercases and strips string keys before lookup

Type Helpers

is_string(value)   is_number(value)
is_list(value)     is_dict(value)

is_number returns true for int or float, but false for bool.

Object and Path Helpers

get_variable(ref, default)          set_variable(ref, value)
get_object(type_id, path, default)  set_object(type_id, path, value)
get_path(obj, path, default)        set_path(obj, path, value)
commit_contact_timezone(iana, state, city)
commit_composite_outputs()

Prefer {{...}} placeholder syntax for normal variable access. Use these helpers when working with dynamic dictionaries inside the code.

commit_contact_timezone(iana, state, city) — validates an Australian IANA timezone, updates the current contact’s timezone and location, refreshes runtime calendar timezone state, and writes the canonical {{contact.*}} and {{timezone.*}} result variables. With no arguments it reads {{timezone.resolved_iana}}, {{timezone.resolved_state}}, and {{timezone.resolved_city}}.
commit_composite_outputs() — inside a sub-flow, commits declared parent composite output variables before the sub-flow returns, and returns the sorted output ids it mapped. Outside a composite context it returns an empty list.

Date Helpers

now()       today()
parse_datetime(value)
format_datetime(value, fmt)
timezone_offset(iana, at)

parse_datetime uses Python ISO parsing:

parse_datetime("2026-05-29")
parse_datetime("2026-05-29T14:30:00")

timezone_offset(iana, at) returns the UTC offset for an IANA timezone at a specific datetime. If at is omitted it uses the current datetime; if at has no offset it is treated as local wall time in the supplied timezone. Invalid input returns "".

timezone_offset("Australia/Sydney", "2026-06-02T10:00:00")

Random Helpers

random_int(min_value, max_value)
random_choice(values)
random_shuffle(values)

random_int(min_value, max_value) — an integer between the bounds, inclusive
random_choice(values) — one item from a non-empty list, or None when empty
random_shuffle(values) — a shuffled copy of the list; the original is not mutated

Voice Helper

set_voice(voice_id)

Switches the voice the assistant speaks with, part-way through the call. Everything said after the Code Step uses the new voice. There is no pause and no reconnection — the change happens between one line and the next. voice_id is the identifier of a voice in the Voice Library. It is not the voice’s name.

def run():
    if {{custom.language_preference}} == "formal":
        return set_voice({{custom.formal_voice_id}})
    return True

Returns True when the voice was accepted, so you can branch on it.
Returns False when the value is not a valid voice identifier. The call keeps the voice it already had, and a note is recorded on the call so you can see it happened. It never stops the Code Step.
The switch is applied as soon as run() finishes, before the flow moves to the next step.

To get the identifier for a voice, speak to the Voxworks team for further custom configuration.

Language Helper

set_language(code)
set_language(code, voice_id)

Switches the language the call is held in, part-way through the call. From the next step on, the assistant listens and speaks in the new language. Your script, conditions, knowledge base and tools keep working in English: what the caller says is translated into English before the assistant reads it, and every line is translated out of English just before it is spoken.

code is a language code such as "es" (Spanish), "vi" (Vietnamese) or "ar" (Arabic). set_language("en") switches back to English. Regional English codes such as "en-AU" are accepted and mean English.
voice_id is optional. Pass a voice identifier to switch to a voice that speaks the language natively at the same moment. It takes priority over a separate set_voice(...) in the same Code Step.
Returns True when the request was accepted and False for an unknown language code or voice identifier, so you can branch on it. On False the call keeps its current language and a note is recorded on the call. It never stops the Code Step.
The switch is applied as soon as run() finishes, before the flow moves to the next step.

def run():
    if {{custom.preferred_language}} == "Spanish":
        return set_language("es")
    return True

The call’s transcript shows each translated turn as it was heard or spoken, with the English underneath. For the list of supported language codes and the matching native voices, speak to the Voxworks team for further custom configuration.

Schedule Helper

on_schedule(endpoint_id)

Returns True when a routing endpoint’s schedule is open right now, and False when it is closed. endpoint_id is the identifier of a routing endpoint (see Routing Endpoints). The check uses the same schedule the Handoff tool would use: the endpoint’s own schedule, or the default from its department, location or team. It is evaluated at the moment the Code Step runs, so a call that crosses closing time gets the right answer.

def run():
    return on_schedule({{custom.sales_endpoint_id}})

Route the true result to the transfer and the otherwise result to your out-of-hours wording. An identifier that doesn’t match an endpoint is checked against the team’s default schedule, and the helper returns True when no schedule applies, so make sure the identifier is correct.

Turn-Timing Helpers

idle_offset(seconds)
endpoint_offset(seconds)

These adjust the assistant’s timing for the rest of the call, on top of each step’s own settings.

idle_offset(seconds) adds seconds to how long the assistant waits in silence: both the wait before it re-prompts a quiet caller and the wait before it ends a silent call. See Silence Tolerance. The quick move-on after a statement (Fast Response) is not affected.
endpoint_offset(seconds) adds seconds to how long the assistant waits after the caller stops speaking before it replies. See Response Eagerness. The wait never drops below the built-in minimum.

For both:

The last call wins; the offsets don’t add up. idle_offset(0) or endpoint_offset(0) clears the offset.
Negative values shorten the waits.
They return True when accepted and False (with a note on the call) for a value that isn’t a number. They never stop the Code Step.

def run():
    # The caller is fetching a document: give them more time for the rest of the call.
    return idle_offset(20)

Routing Helpers

service_location_propose(phrase)
service_location_resolve(postcode)

These are the location lookups behind the Routing | Service Location - v0.2 tool. service_location_propose takes the caller’s own words for a state and suburb and returns the best-matching locality. service_location_resolve takes a four-digit postcode. Both return a dictionary with a status and the routing endpoints that cover the area, and never raise an error: a failed or slow lookup returns {"status": "error", ...}. Most scripts should use the tool rather than calling these directly.

Reading the Transcript

Read what has been said so far through variables rather than a function:

{{call.transcript.last_user}} — the caller’s latest turn, as a string
{{call.transcript.last_ai}} — the assistant’s latest line, as a string
{{call.transcript.items}} — the whole conversation as a list of turns, each a dictionary with role, content, step_name and more

def run():
    last = str({{call.transcript.last_user}} or "").lower()
    return "cancel" in last

See the call variables for the full shape.

Regex Helper

regex_match(pattern, value)

def run():
    email = {{contact.email}}
    return regex_match(r"^[^@\s]+@[^@\s]+\.[^@\s]+$", email)

JSON Helpers

json_loads(value)   json_dumps(value)

Parse a JSON string into Python data:

def run():
    raw = {{webhook.response}}
    data = json_loads(raw)
    return bool(data.get("email"))

Serialize Python data into a JSON string:

def run():
    payload = {"email": {{contact.email}}, "active": True}
    {{webhook.response}} = json_dumps(payload)
    return True

Not Allowed

import or from ... import ...
Filesystem, network, shell, or subprocess access
Reflection and dynamic execution — eval, exec, compile, open, __import__
Dunder names or dunder attributes
Lambdas, nested functions, classes
Any unlisted function or method

Next Steps

Code Step overview — The run() contract and variables
Examples — Common patterns and troubleshooting

Get Started & Build

Calls, Contacts & Batches

Numbers & Routing

Tools, Automations & Integrations

Account, Billing & Security

Allowed Functions

Deny by default

Built-in Functions

Allowed Methods

Flow Helpers

Type Helpers

Object and Path Helpers

Date Helpers

Random Helpers

Voice Helper

Language Helper

Schedule Helper

Turn-Timing Helpers

Routing Helpers

Reading the Transcript

Regex Helper

JSON Helpers

Not Allowed

Next Steps

​Deny by default

​Built-in Functions

​Allowed Methods

​Flow Helpers

​Type Helpers

​Object and Path Helpers

​Date Helpers

​Random Helpers

​Voice Helper

​Language Helper

​Schedule Helper

​Turn-Timing Helpers

​Routing Helpers

​Reading the Transcript

​Regex Helper

​JSON Helpers

​Not Allowed

​Next Steps

Deny by default

Built-in Functions

Allowed Methods

Flow Helpers

Type Helpers

Object and Path Helpers

Date Helpers

Random Helpers

Voice Helper

Language Helper

Schedule Helper

Turn-Timing Helpers

Routing Helpers

Reading the Transcript

Regex Helper

JSON Helpers

Not Allowed

Next Steps