7 — Reference #

Permission Reference #

The table below lists every permission key, the menu/feature it unlocks, and which edition supports it.

Permission Key	Display Name	Menu / Feature	EE	CE
`send_fax`	Send Fax	Fax → Send Fax	✅	✅
`receive_fax`	Receive Fax	Fax → Inbox	✅	✅
`faxtoemail`	Fax to Email	Automatic email on receive	✅	✅
`emailtofax`	Email to Fax	Inbound email → fax pipeline	✅	✅
`personalize_fax`	Personalize Fax	Custom sender ID	✅	✅
`campaigns`	Bulk Fax	Fax → Campaigns	✅	✅
`cover_page`	Cover Page	Fax → Cover Page	✅	✅
`resources.fax_documents`	Fax Documents	Fax → Fax Documents	✅	✅
`fax_accounts`	Fax Accounts	Fax → Fax Accounts	✅	✅
`fax_setting`	Fax Settings	Fax → Fax Settings	✅	✅

Permission Key	Display Name	Menu / Feature	EE	CE
`contacts`	Contacts	Contacts → Contacts	✅	✅
`groups`	Contact Groups	Contacts → Groups	✅	✅
`contact_dnc`	Contact DNC	Contacts → Do Not Call	✅	✅

Permission Key	Display Name	Menu / Feature	EE	CE
`fpbx_extension`	Extensions	PBX → Extensions	✅	✅
`devices`	Devices	PBX → Devices	✅	✅
`ring_groups`	Ring Groups	PBX → Ring Groups	✅	✅
`call_queues`	Call Queues	PBX → Call Queues	✅	✅
`ivr_menus`	IVR Menus	PBX → IVR Menus	✅	✅
`voicemails`	Voicemail	PBX → Voicemail	✅	✅
`conferences`	Conferences	PBX → Conferences	✅	✅
`time_conditions`	Time Conditions	PBX → Time Conditions	✅	✅
`call_flows`	Call Flows	PBX → Call Flows	✅	✅
`call_block`	Call Block	PBX → Call Block	✅	✅
`follow_me`	Follow Me	PBX → Follow Me	✅	✅
`musiconhold`	Music on Hold	PBX → Music on Hold	✅	✅
`inbound_routes`	Inbound Routes	PBX → Inbound Routes	✅	✅
`realtime`	Realtime	PBX → Realtime	✅	✅

Permission Key	Feature
`user_admin`	Manage users (Administration → Users)
`gateways`	Manage SIP gateways/trunks
`super_admin`	Full system administration

Resource ID	Resource	Permission Key	User form field
15	Extensions	`fpbx_extension`	`quota_extensions`
16	Devices	`devices`	`quota_devices`
7	Ring Groups	`ring_groups`	`quotaringgroups`
8	Call Queues	`call_queues`	`quotacallqueues`
17	IVR Menus	`ivr_menus`	`quotaivrmenus`
9	Voicemail Boxes	`voicemails`	`quota_voicemail`
10	Conferences	`conferences`	`quota_conference`
11	Music on Hold	`musiconhold`	`quotamusicon_hold`

Role Name	Role ID (EE prod)	Capabilities
User	1	End-user; access only to explicitly granted features
Admin	2	Full system access; no permission filtering
Tenant	3	Manages users within their tenant; permission-filtered

Note: Role IDs differ per installation. Never hardcode them — ICTPBX always maps by name internally.

All ICTPBX functionality is exposed via a JSON REST API at /api.

Authentication: Authorization: Bearer <JWT> (RS256, 1-year expiry)

Base URL: https://<your-server>/api

All list endpoints support ?page=N&per_page=N&search=<term> for pagination and filtering.

These keys are written at login and read throughout the UI:

Key	Value	Used for
`aid`	User ID	API calls
`tid`	Tenant ID	Scoping requests
`is_admin`	`1` or `0`	Admin vs non-admin UI branching
`is_tenant`	`1` or `0`	Tenant admin detection
`permission`	Comma-delimited string	User’s own permissions
`tenant_permissions`	Comma-delimited string	Tenant’s permissions (used for what can be granted to sub-users)
`tenantdailylimit`	Number	Tenant fax daily cap
`tenantmonthlylimit`	Number	Tenant fax monthly cap
`tenantassigneddaily`	Number	Already-assigned daily quota
`tenantassignedmonthly`	Number	Already-assigned monthly quota
`theme_pref`	Theme name	UI theme preference

Codec	Voice	Fax
G.722	✅ HD	❌
G.711 PCMU	✅	✅ (pass-through)
G.711 PCMA	✅	✅ (pass-through)
T.38	❌	✅ (preferred, requires re-INVITE)

Fax calls negotiate T.38 first; fall back to G.711 PCMA pass-through if the far end rejects T.38.