Skip to content

Glossary

A consolidated glossary of Zorio terms used across the API modules.

Account & access

TermDefinition
AccountEach Zorio customer has an independent system with its own data, access domain, and API tokens
API TokenA Bearer (user session) token issued to a user, used in the Authorization: Bearer <token> header
PermissionA specific right on a single action (e.g. pbx_api_access, manage_caller_ids)
RoleA bundle of permissions attached to a user (admin, supervisor, agent, read_only)
Permission tierModule-level access (viewer, operator, admin)

PBX

TermDefinition
ExtensionInternal SIP extension, registered to Zorio PBX with extension_number + sip_password
TrunkOutbound route via a carrier / SBC / SIP trunking provider
Caller IDThe number shown to the callee when dialing out
CDR (Call Detail Record)A record of one call with full metadata
Hangup causeQ.850 standard code indicating why the call ended — see Hangup codes
QueueCall queue with agents answering according to a strategy (round-robin, longest-idle, ...)
TierAgent priority level within a queue (tier_level 1-9 + tier_position)
A-leg / B-legClick-to-call pattern: A-leg dials the agent, B-leg dials the customer, bridged when both answer
SIP registrationStatus of a softphone registered against the PBX (registered, unregistered, unknown)
TLS / SIPSSIP over TLS encryption (port 5061) instead of plain UDP (5060)
WebRTCBrowser-based call protocol used by the Webphone SDK

Telesales / Contact Center

TermDefinition
CampaignOutbound calling campaign with a lead list, script, agents, and a caller-ID group
LeadA prospect — phone number plus industry-specific custom fields
Disposition / OutcomeCall result tagged by the agent (e.g. "Callback scheduled", "Not interested", "Purchased")
Dialer modeHow the dialer makes calls: manual (agent clicks), preview (agent reviews the lead first), progressive (auto-dials when agent is free), predictive (overdials by prediction)
Caller-ID rotationRotating across multiple caller IDs to avoid carrier spam flags — 6 strategies (round_robin, least_used, cap_based, weighted, sticky_lead, random)
DNC (Do Not Call)List of numbers blocked from being called (PDPL compliance)
Recording.wav recording of a call, downloaded via a signed URL with 30-minute TTL
Wrap-up timeTime after hangup for the agent to fill in disposition (e.g. 5 seconds)
ASR (Answer-Seizure Ratio)Percentage of answered calls over total dialed calls (number-quality metric)
ACD (Average Call Duration)Average length of answered calls
Abandon ratePercentage of customers who answered but couldn't be connected to an agent (dropped in queue)

AutoCall TTS

TermDefinition
TTS (Text-to-Speech)Synthesizing voice from text
VoiceA specific voice (e.g. "vi-VN-female-01", "Linh Dan")
Tier APremium real-time TTS through a provider (premium TTS vendor) — charged per character
Tier BLocal TTS using a pre-rendered audio library — no charge, high throughput
ScriptTTS script with variables substituted at runtime
DTMFPhone keypad tones (0-9, *, #)
DTMF actionWhat happens when a caller presses a key: playback, playback_then_hangup, switch_script, queue, repeat_script, hangup
VariableCustomer-defined variable bound into a script (e.g. customer_name, appointment_date)
Media filePre-uploaded audio file for playback (no TTS)

Webphone SDK

TermDefinition
SDK (Software Development Kit)Library bundle installed into an app to use webphone features
UMDUniversal Module Definition — bundle format that runs in both browsers and Node.js via <script> tags
npm tarballA .tgz package installed with npm install ./file.tgz for air-gapped environments
iframe SSOEmbedding the webphone in an iframe + exchanging an SSO token so the user doesn't have to log in again
postMessageBrowser API to pass messages between a parent page and an iframe
SIP.jsSIP-over-WebSocket library used as the SDK core (sip.js@0.21.x)
Early mediaAudio (ringback / IVR announcement) played BEFORE the callee accepts
Auto-reconnectThe SDK reconnects automatically when the network drops, using exponential backoff
Pagehide cleanupThe SDK unregisters automatically when the user closes the tab → avoids stale registrations at the PBX

Webhook

TermDefinition
WebhookHTTPS URL where Zorio POSTs events to a CRM / customer app in real time
HMACHash-based Message Authentication Code — verifies the payload signature with a shared secret
IdempotencyProperty: calling once or many times yields the same result
Replay attackAttacker captures one valid request and replays it many times — defeated by a timestamp window
DeadletterEvent that could not be delivered after N retries — kept in the audit log for manual replay

HTTP / API

TermDefinition
RESTREpresentational State Transfer — standard for APIs over HTTP
Bearer TokenToken carried in the Authorization: Bearer <token> header
Bearer (user session)Zorio's authentication scheme — tokens are tied to a user's login session
PaginationSplitting results across pages via ?page=N&per_page=M
Soft deleteMarking deleted_at instead of dropping the row — can be restored
Rate limitCap on requests per time window; exceeding → HTTP 429
ISO 8601Datetime standard 2026-06-30T03:30:45+00:00
E.164International phone-number standard +84xxxxxxxxx
UUIDUniversally Unique Identifier, 36 chars (e.g. 65569ce0-0183-4f61-a3b2-0e433cfa4031)

Vietnam telco

TermDefinition
CarrierMobile/landline operator: Viettel, Mobifone, Vinaphone, Vietnamobile
CLI typeNumber type: mobile (mobile), fixed_02x (fixed line), hotline_1900 / hotline_1800 (service hotline), brandname (branded sender ID)
PDPLPersonal Data Protection Law — Vietnam's personal data protection regulation
DNC listList of numbers not to be called (PDPL compliance)

Cấp phép theo điều khoản sử dụng của Zorio.