System Token Categories
TokensHow System Tokens Are Organized
System tokens are organized into categories, each
contributing a set of tokens describing one facet of a
call or lead. The categories are loaded at application
start, and every token in them becomes a valid system
token name.
The Token Categories
- Call tokens - call-level attributes: status, hangup cause, routing path, UUID.
- Duration tokens - timing fields: total duration, hold duration, agent duration, IVR duration, billable minutes.
- Buyer tokens - winning buyer attributes: name, ID, bid price, external record ID.
- Offer tokens - offer attributes: name, ID, external record ID.
- Number tokens - inbound number attributes.
- Schedule tokens - originating schedule attributes.
- Lead tokens - lead attributes (for lead-driven flows).
- Traffic Source tokens - traffic source attributes.
- Geographical tokens - caller geography: country, state, city, zip code, area code, country code, prefix, suffix, state name, country name, province.
- Caller Count tokens - repeat-caller counts: how many times the caller has called in the last 1 day, 7 days, 30 days and 90 days.
- Time tokens - current time tokens: current hour and minute, current weekday, call start time in UTC.
- DNC tokens - DNC and suppression state for the caller.
- Identification tokens - caller identification data.
- Instant Agent tokens - off-hook / instant-agent routing state.
- Recording tokens - recording URL tokens for the full call recording, the agent recording, and the buyer recording.
- Transcription tokens - transcription text and JSON tokens for the full call, the consumer-and-agent segment, and the consumer-and-buyer segment.
Token Types
Most tokens are strings. A subset is explicitly numeric
and gets coerced to a number when posted to downstream
systems. Examples: call ID, total duration, payout,
revenue, provider cost, quality percentage, billable
minutes.
When rendering a numeric token into a URL or JSON
payload, the value is emitted as a number rather than a
quoted string.