Egress endpoints are used to pull data via Querying TLDCRM or TLDialer for information using TQL ( Total Query Language ). TQL Parameters and uses can be seen mimicked in Explore Sections in TLDCRM Itself, where you can prepare a query and columns manually for day to day use outside of the API.
The Following is a List of Egress Endpoints Available
/api/egress/agentcpa
/api/egress/carriers
/api/egress/change_logs
/api/egress/commission_alignments
/api/egress/commission_paid
/api/egress/commission_received
/api/egress/csr
/api/egress/dependent_field
/api/egress/dependent_fields
/api/egress/dependents
/api/egress/dialer_leads
/api/egress/dnc
/api/egress/document_downloads
/api/egress/documents
/api/egress/documents/{document_id}
/api/egress/documents/{document_id}/download
/api/egress/esign
/api/egress/esign_events
/api/egress/fema
/api/egress/filters
/api/egress/fpg
/api/egress/lead_dependents
/api/egress/lead_dialer_leads
/api/egress/lead_field
/api/egress/lead_fields
/api/egress/lead_logs
/api/egress/lead_notes
/api/egress/lead_policies
/api/egress/lead_protected_view_logs
/api/egress/lead_view_logs
/api/egress/leads
/api/egress/note_field
/api/egress/note_fields
/api/egress/notes
/api/egress/notifications
/api/egress/policies
/api/egress/policy_field
/api/egress/policy_fields
/api/egress/products
/api/egress/protected_view_logs
/api/egress/tag_logs
/api/egress/tag_members
/api/egress/tags
/api/egress/user_contracts
/api/egress/user_group_members
/api/egress/user_groups
/api/egress/user_licenses
/api/egress/users
/api/egress/vendor_logs
/api/egress/vendorperformance
/api/egress/vendors
/api/egress/view_logs
TLDialer Egress API Endpoints
/api/egress/tldialer/agency_call_log
/api/egress/tldialer/audio_store_details
/api/egress/tldialer/call_log
/api/egress/tldialer/call_log_archive
/api/egress/tldialer/conferences
/api/egress/tldialer/join_campaigns
/api/egress/tldialer/join_dids
/api/egress/tldialer/join_ingroups
/api/egress/tldialer/join_list
/api/egress/tldialer/join_lists
/api/egress/tldialer/join_statuses
/api/egress/tldialer/join_user_groups
/api/egress/tldialer/join_users
/api/egress/tldialer/join_users_no
group/api/egress/tldialer/leave_vm_message_gro
ups/api/egress/tldialer/leave_vm_message_groups_e
ntries/api/egress/tldialer/live_channels
/api/egress/tldialer/live_inbound_log
/api/egress/tldialer/live_sip_channels
/api/egress/tldialer/park_log
/api/egress/tldialer/parked_channels
/api/egress/tldialer/parked_channels_recent
/api/egress/tldialer/phones
/api/egress/tldialer/phones_alias
/api/egress/tldialer/recording_log
/api/egress/tldialer/report_agentcpa
/api/egress/tldialer/servers
/api/egress/tldialer/servers_join
/api/egress/tldialer/system_settings
/api/egress/tldialer/tldialer_backup_logs
/api/egress/tldialer/tldialer_call_log
/api/egress/tldialer/tldialer_call_log_costs
/api/egress/tldialer/tldialer_call_log_dupes
/api/egress/tldialer/tldialer_campaigns_meta
/api/egress/tldialer/tldialer_cid_history
/api/egress/tldialer/tldialer_closer_log
/api/egress/tldialer/tldialer_external_xfer_log
/api/egress/tldialer/tldialer_first_contacts
/api/egress/tldialer/tldialer_fpg_log
/api/egress/tldialer/tldialer_inbound_block_log
/api/egress/tldialer/tldialer_inbound_dids_pricing
/api/egress/tldialer/tldialer_lists_meta
/api/egress/tldialer/tldialer_live_agents
/api/egress/tldialer/tldialer_meta
/api/egress/tldialer/tldialer_meta_definitions
/api/egress/tldialer/tldialer_queue_logs
/api/egress/tldialer/tldialer_reset_log_details
/api/egress/tldialer/tldialer_reset_logs
/api/egress/tldialer/tldialer_users_meta
/api/egress/tldialer/tldialer_whitelist
/api/egress/tldialer/tldialer_xfer_presets
/api/egress/tldialer/twoday_vicidial_log
/api/egress/tldialer/user_call_log
/api/egress/tldialer/user_call_log_archive
/api/egress/tldialer/vicidial_admin_log
/api/egress/tldialer/vicidial_agent_function_log
/api/egress/tldialer/vicidial_agent_function_log_archive
/api/egress/tldialer/vicidial_agent_log
/api/egress/tldialer/vicidial_agent_vmm_overrides
/api/egress/tldialer/vicidial_amd_log
/api/egress/tldialer/vicidial_amd_log_archive
/api/egress/tldialer/vicidial_api_log
/api/egress/tldialer/vicidial_api_urls
/api/egress/tldialer/vicidial_auto_calls
/api/egress/tldialer/vicidial_automated_reports
/api/egress/tldialer/vicidial_avatar_audio
/api/egress/tldialer/vicidial_avatars
/api/egress/tldialer/vicidial_bench_agent_log
/api/egress/tldialer/vicidial_call_menu
/api/egress/tldialer/vicidial_call_menu_options
/api/egress/tldialer/vicidial_call_time_holidays
/api/egress/tldialer/vicidial_call_times
/api/egress/tldialer/vicidial_campaign_agents
/api/egress/tldialer/vicidial_campaign_cid_areacodes
/api/egress/tldialer/vicidial_campaign_dnc
/api/egress/tldialer/vicidial_campaign_server_stats
/api/egress/tldialer/vicidial_campaign_stats
/api/egress/tldialer/vicidial_campaign_stats_debug
/api/egress/tldialer/vicidial_campaigns
/api/egress/tldialer/vicidial_carrier_log
/api/egress/tldialer/vicidial_carrier_log_archive
/api/egress/tldialer/vicidial_cid_groups
/api/egress/tldialer/vicidial_closer_log
/api/egress/tldialer/vicidial_closer_log_archive
/api/egress/tldialer/vicidial_conf_templates
/api/egress/tldialer/vicidial_conferences
/api/egress/tldialer/vicidial_custom_reports
/api/egress/tldialer/vicidial_daily_max_stats
/api/egress/tldialer/vicidial_dial_log
/api/egress/tldialer/vicidial_dial_log_archive
/api/egress/tldialer/vicidial_did_log
/api/egress/tldialer/vicidial_dnc
/api/egress/tldialer/vicidial_dnc_log
/api/egress/tldialer/vicidial_filter_phone_groups
/api/egress/tldialer/vicidial_filter_phone_numbers
/api/egress/tldialer/vicidial_grab_call_log
/api/egress/tldialer/vicidial_hopper
/api/egress/tldialer/vicidial_inbound_callback_queue
/api/egress/tldialer/vicidial_inbound_callback_queue_archive
/api/egress/tldialer/vicidial_inbound_dids
/api/egress/tldialer/vicidial_inbound_group_agents
/api/egress/tldialer/vicidial_inbound_groups
/api/egress/tldialer/vicidial_ip_list_entries
/api/egress/tldialer/vicidial_ip_lists
/api/egress/tldialer/vicidial_lead_call_quota_counts
/api/egress/tldialer/vicidial_lead_call_quota_counts_archive
/api/egress/tldialer/vicidial_lead_filters
/api/egress/tldialer/vicidial_lead_recycle
/api/egress/tldialer/vicidial_list
/api/egress/tldialer/vicidial_list_archive
/api/egress/tldialer/vicidial_lists
/api/egress/tldialer/vicidial_lists_custom
/api/egress/tldialer/vicidial_live_agents
/api/egress/tldialer/vicidial_live_inbound_agents
/api/egress/tldialer/vicidial_log
/api/egress/tldialer/vicidial_log_archive
/api/egress/tldialer/vicidial_log_extended_sip
/api/egress/tldialer/vicidial_log_extended_sip_archive
/api/egress/tldialer/vicidial_log_noanswer
/api/egress/tldialer/vicidial_log_noanswer_archive
/api/egress/tldialer/vicidial_manager
/api/egress/tldialer/vicidial_manual_dial_queue
/api/egress/tldialer/vicidial_outbound_ivr_log
/api/egress/tldialer/vicidial_outbound_ivr_log_archive
/api/egress/tldialer/vicidial_pause_codes
/api/egress/tldialer/vicidial_phone_codes
/api/egress/tldialer/vicidial_postal_codes
/api/egress/tldialer/vicidial_process_trigger_log
/api/egress/tldialer/vicidial_queue_groups
/api/egress/tldialer/vicidial_remote_agents
/api/egress/tldialer/vicidial_report_log
/api/egress/tldialer/vicidial_rt_monitor_log
/api/egress/tldialer/vicidial_scripts
/api/egress/tldialer/vicidial_session_data
/api/egress/tldialer/vicidial_sessions_recent
/api/egress/tldialer/vicidial_sessions_recent_archive
/api/egress/tldialer/vicidial_settings_containers
/api/egress/tldialer/vicidial_shifts
/api/egress/tldialer/vicidial_sip_action_log
/api/egress/tldialer/vicidial_sip_action_log_archive
/api/egress/tldialer/vicidial_sip_event_archive_details
/api/egress/tldialer/vicidial_sip_event_log
/api/egress/tldialer/vicidial_sip_event_recent
/api/egress/tldialer/vicidial_state_call_times
/api/egress/tldialer/vicidial_status_categories
/api/egress/tldialer/vicidial_status_groups
/api/egress/tldialer/vicidial_statuses
/api/egress/tldialer/vicidial_territories
/api/egress/tldialer/vicidial_url_log
/api/egress/tldialer/vicidial_url_multi
/api/egress/tldialer/vicidial_urls
/api/egress/tldialer/vicidial_user_closer_log
/api/egress/tldialer/vicidial_user_groups
/api/egress/tldialer/vicidial_user_log
/api/egress/tldialer/vicidial_user_territories
/api/egress/tldialer/vicidial_users
/api/egress/tldialer/vicidial_vmm_counts
/api/egress/tldialer/vicidial_vmm_counts_archive
/api/egress/tldialer/vicidial_voicemail
/api/egress/tldialer/vicidial_webservers
/api/egress/tldialer/vicidial_xfer_log
/api/egress/tldialer/vicidial_xfer_log_archive
/api/egress/tldialer/vicidial_xfer_presets
/api/egress/tldialer/vicidial_xfer_stats
/api/egress/tldialer/web_client_sessions
Programmatic List of Egress Endpoints
You can also get all endpoints available via API. For Example if we want to get all TLDCRM endpoints available we would query /api/egress/endpoints
. This would give us the list to the right. but with shortened keys and values of the endpoint. For a list of TLDialer Egress Endpoints you would use /api/egress/tldialer/endpoints
with similar results.
Egress Endpoint Documentation
To find more Detailed information about Egress API Endpoints such as their structure and columns available you can query any endpoint and append /docs
to the end. This works with TLDialer Egress endpoints as well! Lets look at an example with the Tags Endpoint. Remember this still requires an API ID and Key.
These Egress Endpoints are meant to be used with the TQL Query Language please see the documentation regarding this to understand it a bit more.
Lets use the Tags Schema as an Example
/api/egress/tags/docs
As you can see in the output on the right this will give us the basic structure of the table with it’s base table columns. These can be used in column selectors as well as queries. It also will include relationships to other tables. If you see a tags
array any value in that tag array and import more tables which will make more columns available when using the import
special TQL Parameter.
If you want to Test what columns will be available after the import use the following Docs endpoint with your import
and columns
selector to see what will show up.
/api/egress/tags/docs/build